指定された文字列で地番を検索し座標情報を返却します。
https://chibanapi.geospace.jp/api/searchChiban/
UTF-8
GET,POST
パラメータ名 | 内容 | 型 | 必須 | 設定値・備考 |
---|---|---|---|---|
string | 検索するワード | 文字 | 必須 | 検索したい地番 |
callback | コールバック関数名 | 半角文字列 | 任意 | JSONP で利用する際のコールバック用関数名。未指定の場合は「JSON」で返却。 |
appid | アプリケーションID | 半角文字列 | 必須 | ご利用時に発行されたID |
adcd | 絞り込み住所コード | 半角文字列 ※半角数字、半角カンマのみ有効 (カンマ区切り単位に最大11桁) |
任意 | 検索対象を絞り込みたいときに住所コードを指定します。前方一致検索となります。 「,」(カンマ)で区切ることで複数指定出来ます。 例) 「13,14」 |
is_polygon | ポリゴン返却有無 フラグ | true / false | 任意 | 検索結果が地番まで完全一致した場合、地番ポリゴン情報を返却する対象にする。 (true:有効 false:無効) 未設定の場合、false:無効になります。 ※データと一致したときに限る。 |
order | 表示順指定 | 半角数値 | 任意 | 表示順指定項目コード 01:デフォルト 第1優先順位:一致内容(1.完全一致、2.後方一致、3.中間一致の昇順) 第2優先順位:住所コードの昇順 02:名称順(UTF8文字コードの昇順) 03:住所コード(昇順) 未設定の場合、01:デフォルトになります。 |
is_num | 総件数取得 フラグ | true / false | 任意 | レスポンスに総件数を含めるか指定 未設定の場合、falseになります。 |
limit | 取得件数 | 半角数値 | 任意 | 未設定の場合、10になります。 ※最大50まで |
offset | 取得開始位置 | 半角数値 | 任意 | 未設定の場合、0になります。 |
項目名 | 値 | 補足事項 | |
---|---|---|---|
status | ステータス |
レスポンス状態を表します。正常に完了した場合は「success」 結果が無い場合は「zero results」 パラメータ不正やシステムエラーで終了した場合は「error」となります。 |
|
error_message | エラーメッセージ | ステータスが「error」の場合にデバッグ用情報が格納されます。 | |
chiban | pref_name | 都道府県名 | |
city_name | 市区町村名 | ||
ooaza_name | 大字名 | ||
aza_name | 小字名 | ||
chiban | 地番 | ||
address_chiban | 住所地番結合文字列 | 都道府県名、市区町村名、大字名、小字名、地番の順に結合した文字列 | |
jis_code | JIS市町村コード | 住所コード(都道府県+市区町村):5桁 | |
ooaza_code | 大字コード | 住所コード(大字):3桁 | |
aza_code | 字コード | 住所コード(字):3桁 | |
adcd | 住所コード | JIS市町村コード、大字コード、字コードを結合した11桁のコード | |
mitei_f | 筆界未定フラグ | 「1」の場合、筆界未定。それ以外は「0」 | |
chiban_yyyymm | 地番整備年月 | ||
lat | 地番の緯度 | ||
lon | 地番の経度 | ||
polygon | 地番ポリゴン | GeoJSON形式となります。 | |
num | 検索総件数 | リクエストパラメータで入力された条件の総件数 | |
input_limit | 入力取得件数 | リクエストパラメータで入力されたlimit | |
input_offset | 入力取得開始位置 | リクエストパラメータで入力されたoffset |
https://chibanapi.geospace.jp/api/searchChiban/?appid=[appid]&string=東京都台東区雷門1丁目37‐1
{ "chiban":[ { "pref_name":"東京都", "city_name":"台東区", "ooaza_name":"雷門", "aza_name":"1丁目", "chiban":"37‐1", "address_chiban":"東京都台東区雷門1丁目37‐1", "jis_code":"13106", "ooaza_code":"010", "aza_code":"001", "adcd":"13106010001", "mitei_f":"0", "lon":"139.793440896502", "lat":"35.7095174550498" } ], "status":"success", "input_limit":10, "input_offset":0 }