現在地

APIの使い方

1 APIのリクエスト方法
    HTTP経由でリクエストURLを送信してください。レスポンスは,XML,JSON又はJSONPで取得することができます。

(1)リクエストURL

XML https://data.city.kyoto.lg.jp/API/action/datastore/search?
JSON https://data.city.kyoto.lg.jp/API/action/datastore/search.json?
JSONP https://data.city.kyoto.lg.jp/API/action/datastore/search.jsonp?


(2)パラメータ

パラメータ 入力値の型                  説明

resource_id
(必須)

文字列型

検索するリソースのID番号
例)resource_id=f14b57c2-48dd-4aa7-b754-a4f4ac340f2d
(上記は「API用京都市の施設情報(平成28年11月9日現在)」リソースのID番号)

limit
(任意)

整数値型

取得するデータの最大行数。(設定しない場合は「100」になります。)
例)limit=10

offset
(任意)

整数値型

データ取得を開始する行。(設定しない場合は「0」となり,最初の行(0行目)からデータを取得します。)
例)offset=35

fields
(任意)

文字列型

fieldsパラメータにフィールド名(ヘッダ文字列)を設定すると,そのフィールドのデータのみを取得します。複数のヘッダに係るデータを取得する場合は,半角カンマで結合してください。
例)fields=id,name,latitude,longitude,zip

filters
(任意)

文字列型

filtersパラメータの後にフィールド名(ヘッダ文字列)を,半角ブラケット(角カッコ)で囲み,設定してください。設定したフィールド内に,パラメータで指定した文字列が存在するデータのみを取得します。複数の文字列をパラメータとして設定する場合は,半角カンマで結合してください。
例)filters[id]=1000001752,1000001019
なお,パラメータに全角文字を設定する場合は,以下のように,URLエンコードした文字列を設定してください。
× filters[name]=北部まち美化事務所
○ filters[name]=%E5%8C%97%E9%83%A8%E3%81%BE%E3%81%A1%E7%BE%8E%E5%8C%96%E4%BA%8B%E5%8B%99%E6%89%80

callback(JSONPのみ必須)

文字列型 JSONPのコールバック関数名を設定してください。XML,JSONの場合は不要です。
例) callback=onCallbackKyoto
(コールバック関数名に「onCallbackKyoto」を指定)
 

 ※ 複数のパラメータを組み合わせてリクエストする場合は,半角「&」で結合してください。


(3)リクエストURLの例

リソースIDのみを設定し,他のパラメータ設定はなし。取得するデータ形式はXML。 https://data.city.kyoto.lg.jp/API/action/datastore/search?resource_id=f14b57c2-48dd-4aa7-b754-a4f4ac340f2d
取得データ数制限20,最初の5行は取得しない。フィールド「name」及び「address」のみ取得。取得するデータ形式はJSON。 https://data.city.kyoto.lg.jp/API/action/datastore/search.json?resource_id=f14b57c2-48dd-4aa7-b754-a4f4ac340f2d&limit=20&offset=5&fields=name,address
「department」(所管局)フィールドが「文化市民局」のデータを取得。取得するデータ形式はJSONP。コールバック関数名は「bunka」。 https://data.city.kyoto.lg.jp/API/action/datastore/search.jsonp?resource_id=f14b57c2-48dd-4aa7-b754-a4f4ac340f2d&filters[department]=%E6%96%87%E5%8C%96%E5%B8%82%E6%B0%91%E5%B1%80&callback=bunka

 (4)API機能が利用できるデータについて
 API機能が利用できるデータを検索するには,ポータルサイトトップページの「データを検索」フォームに,全角で「API」と入力し検索してください。


2 データセット及びリソースのメタ情報等の取得
(1)データセットの一覧の取得
 以下のリクエストURLで,データセットの一覧を取得することができます。
 https://data.city.kyoto.lg.jp/API/3/action/package_list

(2)データセット及びリソースのメタ情報の取得
 
以下のリクエストURLで,指定したデータセットと,それに紐づくリソースのメタ情報を取得することができます。
 https://data.city.kyoto.lg.jp/API/3/action/package_show?id=(データセットの識別子)
 例)https://data.city.kyoto.lg.jp/API/3/action/package_show?id=6a021340-f06b-44ec-972a-b69661ed9d38

(3)リソースのメタ情報の取得
 
以下のリクエストURLで,指定したリソースのメタ情報を取得することができます。
 https://data.city.kyoto.lg.jp/API/3/action/resource_show?id=(リソースID)
 例)https://data.city.kyoto.lg.jp/API/3/action/resource_show?id=f14b57c2-48dd-4aa7-b754-a4f4ac340f2d