現在地

データストアAPI

 リクエストはHTTP経由で送信できます。 データは,JSON,XML,またはJSONPで取得することができます。

データストアAPIのURL

 データストアは https://data.city.kyoto.lg.jp/api/action/datastore/search で照会することができます。

 デフォルトの戻り形式はXMLです。JSONはURLの最後に「.json」,JSONPはURLの最後に「.jsonp」を付ける事で取得することができます。
https://data.city.kyoto.lg.jp/api/action/datastore/search.json

リクエストパラメータ

パラメーター
  • resource_id (mixed ) - 検索されるリソースのID(文字列)またはIDS(配列)
  • filters (mixed ) -選択することが条件に合致するの配列や文字列
  • q(string ) -フルテキストクエリ*
  • offset(int) -行のこの数をオフセット
  • limit (int ) -最大行数を返すようにします(デフォルト:100)
  • fields (配列またはカンマ区切りの文字列 ) -フィールドは返すようにします(デフォルト:元の順序のすべてのフィールド)
  • sort (文字列 ) -順序でカンマで区切られたフィールド名
  • join (配列) -複数のテーブルから参加するフィールドの配列

戻り値

 戻り値はXML,JSONまたはJSONPです。

戻り値の型:

次のキーを持つディクショナリ

パラメーター:
  • fields (フィールドのリスト ) -フィールド/列とメタデータ
  • offset (int) -クエリのオフセット値
  • limit (int) -クエリの限界値
  • count (int) -一致するレコードの総数
  • records (ディクショナリのリスト) -検索結果のリスト

 以下の2つは,それぞれ4つのレコードを持つシンプルなリソースの例です。 実際のresource_idは,1桁ではないUUIDとなります。

 リソース:1
 + --------- + ------------- + ---- + ------------ +
 | 国| 人口|  id | タイムスタンプ|
 + --------- + ------------- + ---- + ------------ +
 |  US |  315,209,000人|  1 |  1359062329 |
 |  CA |  | 35,002,447 |  2 |  1359062329 |
 |  AR |  40,117,096 |  3 |  1359062329 |
 |  JP |  127,520,000 |  4 |  1359062329 |
 + --------- + ------------- + ---- + ------------ +

リソース2
 + --------- + ----------- + ---- + ------------ +
 | 国|  | squarekm |  id | タイムスタンプ|
 + --------- + ----------- + ---- + ------------ +
 |  US |  | 9,629,091 |  1 |  1359062713 |
 |  CA |  | 9,984,670 |  2 |  1359062713 |
 |  AR |  | 2,780,400 |  3 |  1359062713 |
 |  JP |  | 377,930 |  4 |  1359062713 |
 + --------- + ----------- + ---- + ------------ +

基本的なクエリの例

https://data.city.kyoto.lg.jp/api/dataset/search?resource_id=1&filters[country]=AR,US&fields=country,population,timestamp&sort[country]=asc

 リソース1から,国がUSまたはARのものについて,国・人口・タイムスタンプのフィールドを取得し,国の昇順で並び替えた結果を取得することができます。

 query引数を持つパスは,データセット内のリスト化されたフィールドを検索します。

https://data.city.kyoto.lg.jp/api/dataset/search?resource_id=1&&fields=country,population&query=US

 国がUSであるものについて,人口を取得することができます。

接合

 複数のテーブルを照会したい場合は,次のフィールドにテーブルを配列キーとして指定します。

https://data.city.kyoto.lg.jp/api/dataset/search?resource_id[pop]=1&resource_id[size]=2&filters[pop][country]=US,AR&join[pop]=country&join[size]=country

 リソース1と2から,国がUSまたはARのものについて,国・人口・面積とidを取得することができます。