postcode

郵便番号検索

郵便番号検索を行います。

・郵便番号検索
　入力された文字列から該当する郵便番号を検索します。
・郵便番号リスト取得
　住所コードに該当する郵便番号情報を検索します。
・緯度経度検索
　指定された中心座標や半径で範囲から郵便番号情報を検索します。

検索条件を複数指定した場合はAND結合となります。
※一部パラメータを利用するには別途契約が必要です。

https://[domain]/search/postcode

HTTP request method

POST/GET

ContentType

application/x-www-form-urlencoded

Parameters

名前	説明
post_code string	郵便番号を指定(前方一致) "100-0001","1000001"どちらの形式でも可能です。
proximity array[number] ※カンマ区切り	中心座標、半径で範囲を指定代表点の近傍検索。 "経度,緯度,半径(m)"で指定してください。半径の上限は5000です。
address_code_list array[string] ※カンマ区切り	住所コードを指定(前方一致) 複数指定の場合はOR検索となります。各住所コードの最大文字数 255 指定できる値は最大50件
pastmap_year array[integer] ※カンマ区切り	premium 過去地図年度を指定(複数指定可) ※本パラメータを利用するには別途契約が必要です。 ※地域と提供年の組み合わせについては「過去地図データ提供地区一覧表」をご参照ください。
sort array[string] default post_code ※カンマ区切り	出力順を指定(複数指定可) デフォルトは昇順です。降順指定の場合、ソートキーの前方にマイナス(-)を付加してください。 post_code 郵便番号 address_code 住所コード address_read 住所読み pastmap_year premium 過去地図年度 ※本パラメータを利用するには別途契約が必要です。 distance 検索座標と代表点の直線距離
limit array[integer] default List[0,100] ※カンマ区切り	検索結果取得件数を指定 "オフセット,件数"で指定してください。最大値 2000,1000
datum string default JGD	入出力座標の測地系を指定 JGD 世界測地系 TOKYO 日本測地系 TOKYO_NAVI 日本測地系(ゼンリンナビ地図)

Responses

エラーについては「エラーメッセージ一覧」を参照してください。

Status Code:200

Media type:application/json

キー名			説明
status string			ステータス
result	info	hit integer	検索結果総数
	item	post_code string	郵便番号
		post_code_name string	郵便番号名称郵便番号に割り当てられた名称(建物名称)
		post_level integer	郵便番号情報レベル null post_typeが3または4のとき 0 市区町村に紐ついている 1 大字に紐ついている 2 字丁目に紐ついている 3 街区に紐ついている 4 地番または戸番に紐ついている 5 階数に紐ついている
		post_type integer	郵便番号種別 1 住所 2 特定ビル 3 大口事業所 4 私書箱 9999 指定なし
		floor string	階数
		address_code string	住所コード
		address string	住所
		address_read string	住所読み
		address_code1 string	国コード
		address1 string	国名称
		address_read1 string	国名称読み
		address_code2 string	都道府県コード
		address2 string	都道府県名称
		address_read2 string	都道府県名称読み
		address_code3 string	市区町村コード
		address3 string	市区町村名称
		address_read3 string	市区町村名称読み
		address_code4 string	大字コード
		address4 string	大字名称
		address_read4 string	大字名称読み
		address_code5 string	字丁目コード
		address5 string	字丁目名称
		address_read5 string	字丁目名称読み
		address_detail_code1 string	街区コード
		address_detail1 string	街区名称
		address_detail_read1 string	街区名称読み
		address_detail_code2 string	地番戸番コード
		address_detail2 string	地番戸番名称
		address_detail_read2 string	地番戸番名称読み
		position array[number]	["経度","緯度"]
		pastmap_id integer	premium 過去地図管理ID(過去地図データの場合のみ) ※本パラメータを利用するには別途契約が必要です。
		pastmap_year integer	premium 過去地図年度(過去地図データの場合のみ) ※本パラメータを利用するには別途契約が必要です。
		distance number	検索座標と代表点の直線距離(proximityを指定した場合のみ返却)

Example

リクエストURL

https://[domain]/search/postcode?post_code=1&limit=0,100&datum=JGD

レスポンス

{
  "status": "OK",
  "result": {
      "info": {
          "hit": 10804
      },
      "item": [
          {
              "post_code": "100-0001",
              "post_code_name": null,
              "post_level": 1,
              "post_type": 1,
              "floor": null,
              "address_code": "13101045",
              "address": "東京都千代田区千代田",
              "address_read": "トウキョウトチヨダクチヨダ",
              "address_code1": "JPN",
              "address1": "日本",
              "address_read1": "ニホン",
              "address_code2": "13",
              "address2": "東京都",
              "address_read2": "トウキョウト",
              "address_code3": "101",
              "address3": "千代田区",
              "address_read3": "チヨダク",
              "address_code4": "045",
              "address4": "千代田",
              "address_read4": "チヨダ",
              "address_code5": null,
              "address5": null,
              "address_read5": null,
              "address_detail_code1": null,
              "address_detail1": null,
              "address_detail_read1": null,
              "address_detail_code2": null,
              "address_detail2": null,
              "address_detail_read2": null,
              "position": [
                  139.753946126302,
                  35.6837999131944
              ],
              "pastmap_id": null,
              "pastmap_year": null,
              "distance": null
          },
          ...
      ]
  }
}