address

住所検索

住所フリーワード検索
　住所文字列から該当する住所情報を検索します。
住所コード検索
　住所コードに該当する住所情報を検索します。
住所逆引き(緯度経度検索)
　指定された緯度経度座標から住所情報を検索します。
範囲指定住所検索
　中心座標、半径で範囲を指定し範囲内の住所情報を検索します。
行政界ポリゴンの取得
　住所情報の行政界ポリゴンを取得します。
過去地図検索
　過去地図年度を指定し過去の住所情報を検索します。
　※本機能は別途契約が必要です。

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

https://[domain]/search/address

HTTP request method

POST/GET

ContentType

application/x-www-form-urlencoded

Parameters

名前	説明
word string	住所名称、読みを指定最大文字数 255文字。スペースは削除されます。 word_match_typeが1（完全一致）または3（部分一致）、かつ1文字の場合、エラーを返却します。先頭から100文字までの文字列で検索します。
word_match_type integer default 3	検索語句のマッチタイプを指定 1 完全一致 2 前方一致 3 部分一致
address_code string	住所コードを指定最大文字数 255
code_match_type integer default 1	住所コードのマッチタイプを指定 1 完全一致 2 前方一致
proximity array[number] ※カンマ区切り	中心座標、半径で範囲を指定代表点の近傍検索。 "経度,緯度,半径(m)"で指定してください。半径の上限は5000です。
position array[number] ※カンマ区切り	座標を指定 "経度,緯度"で指定してください。指定された緯度経度の住所を返却します。ただし、住所階層がTBNである住所の検索を試みる場合、緯度経度を中心とした4m矩形の範囲を検索し、最近傍の建物の値が返却します。
address_level array[string] default TOD,SHK,OAZ,AZC,GIK,TBN	検索する住所の階層を指定(複数指定可) TOD 都道府県 SHK 市区町村 OAZ 大字 AZC 字丁目 GIK 街区 TBN 地番・戸番
pastmap_year array[string] ※カンマ区切り	premium 過去地図年度を指定(複数指定可) ※本パラメータを利用するには別途契約が必要です。 ※地域と提供年の組み合わせについては「過去地図データ提供地区一覧表」をご参照ください。
pastmap_id array[integer]	premium 過去地図管理IDを指定(複数指定可) ※本パラメータを利用するには別途契約が必要です。
sort array[string] default address_sort	出力順を指定(複数指定可) デフォルトは昇順です。降順指定の場合、ソートキーの前方にマイナス(-)を付加してください。 address_sort 住所 address_code 住所コード address_read 住所読み address_level 住所階層レベル postcode 郵便番号 pastmap_year premium 過去地図年度 ※本パラメータを利用するには別途契約が必要です。 distance 検索座標と代表点の直線距離
address_polygon boolean default false	行政界ポリゴンの取得有無を指定行政界ポリゴンが整備されていない地番・戸番はnullが返却されます。 ※行政界ポリゴンを取得する場合は1リクエスト1行政界ポリゴンとなるようにご指定ください。1リクエストで大量の行政界ポリゴンを取得しようとするとエラーとなる場合があります。 ※都道府県単位のポリゴンはレスポンス速度低下を防ぐため行政界の構成点の密度を下げており、街区～市区町村までと比べ現実の行政界との乖離が大きい場合があります。 true 取得する false 取得しない
show_code_zero boolean default false	当該階層の住所コードが0のレコード(大字なし、字丁目なし、街区なし)出力を指定行政界ポリゴンが整備されていない地番・戸番はnullが返却されます。 true 出力する false 出力しない
limit array[integer] ※カンマ区切り default List[0,100]	検索結果取得件数を指定 "オフセット,件数"で指定してください。 1階層で10000レコードを超える住所があり、リスト表示での全件取得を可能とするため住所検索と地番検索のみ、オフセット値の上限を20000としています。最大値 20000,1000
datum string default JGD	入出力座標の測地系を指定 JGD 世界測地系 TOKYO 日本測地系 TOKYO_NAVI 日本測地系(ゼンリンナビ地図)

Responses

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

Status Code:200

Media type:application/json

キー名			説明
status string			ステータス
result	info	hit integer	検索結果総数
	item	address_code string	住所コード
		address string	住所
		address_read string	住所読み
		address_read_through string	住所読み下し読みと読み下しの違いは以下の通り・読み：英数字は英数字のまま返却・読み下し：英数字の読みを返却（例：１→イチ、A→エー） ※いずれか、もしくはいずれもnullで返却される場合があります
		address_code1 string	国コード
		address1 string	国名称
		address_read1 string	国名称読み
		address_read_through1 string	国名称読み下し
		address_code2 string	都道府県コード
		address2 string	都道府県名称
		address_read2 string	都道府県名称読み
		address_read_through2 string	都道府県名称読み下し
		address_code3 string	市区町村コード
		address3 string	市区町村名称
		address_read3 string	市区町村名称読み
		address_read_through3 string	市区町村名称読み下し
		address_code4 string	大字コード
		address4 string	大字名称
		address_read4 string	大字名称読み
		address_read_through4 string	大字名称読み下し
		address_code5 string	字丁目コード
		address5 string	字丁目名称
		address_read5 string	字丁目名称読み
		address_read_through5 string	字丁目名称読み下し
		address_detail_code1 string	街区コード
		address_detail1 string	街区名称
		address_detail_read1 string	街区名称読み
		address_detail_read_through1 string	街区名称読み下し
		address_detail_code2 string	地番戸番コード
		address_detail2 string	地番戸番名称
		address_detail_read2 string	地番戸番名称読み
		address_detail_read_through2 string	地番戸番名称読み下し
		post_code string	郵便番号
		address_level string	住所階層情報 TOD 都道府県 SHK 市区町村 OAZ 大字 AZC 字丁目 GIK 街区 TBN 地番・戸番
		address_name_type integer	住所階層が国～字丁目の住所に対し、住所名称の種類を表します。 1 正式名称(公称) 2 略式名称
		exclude_level_flag integer	住所階層表示の対象外とするデータを表すフラグ 1 階層表示対象外 0 階層表示対象 ※政令市のみ、郡のみを表現した住所に対し階層表示対象外のフラグが設定されます。
		child_level_flag integer	子階層フラグ 0 子階層なし 1 子階層あり
		entrance_point array[array[number]]	出入口地点座標座標の配列(複数点の場合あり)を返却します。 [[経度,緯度],...]
		position array[number]	["経度","緯度"]
		pastmap_id integer	premium 過去地図管理ID(過去地図データの場合のみ) ※本パラメータを利用するには別途契約が必要です。
		pastmap_year integer	premium 過去地図年度(過去地図データの場合のみ) ※本パラメータを利用するには別途契約が必要です。
		distance number	検索座標と代表点の直線距離(proximityを指定した場合のみ返却)
		address_polygon string	行政界ポリゴン(行政界ポリゴン取得有を指定した場合のみ) GeoJSON形式

Example

リクエストURL

https://[domain]/search/address?word_match_type=3&code_match_type=1&position=139.723646,35.651638&limit=0,100&datum=JGD

レスポンス

{
  "status": "OK",
  "result": {
    "info": {
      "hit": 5
    },
    "item": [
    {
      "address_code": "13103",
      "address": "東京都港区",
      "address_read": "トウキョウトミナトク",
      "address_read_through": "トウキョウトミナトク",
      "address_code1": "JPN",
      "address1": "日本",
      "address_read1": "ニホン",
      "address_read_through1": "ニホン",
      "address_code2": "13",
      "address2": "東京都",
      "address_read2": "トウキョウト",
      "address_read_through2": "トウキョウト",
      "address_code3": "103",
      "address3": "港区",
      "address_read3": "ミナトク",
      "address_read_through3": "ミナトク",
      "address_code4": null,
      "address4": null,
      "address_read4": null,
      "address_read_through4": null,
      "address_code5": null,
      "address5": null,
      "address_read5": null,
      "address_read_through5": null,
      "address_detail_code1": null,
      "address_detail1": null,
      "address_detail_read1": null,
      "address_detail_read_through1": null,
      "address_detail_code2": null,
      "address_detail2": null,
      "address_detail_read2": null,
      "address_detail_read_through2": null,
      "post_code": "105-0000",
      "address_level": "SHK",
      "address_name_type": 1,
      "exclude_level_flag": 0,
      "entrance_point": null,
      "position": [
          139.7514046224,
          35.6580729167
      ],
      "pastmap_id": null,
      "pastmap_year": null,
      "child_level_flag": 1,
      "distance": null
    },
    {
      "address_code": "13103026",
      "address": "東京都港区南麻布",
      "address_read": "トウキョウトミナトクミナミアザブ",
      "address_read_through": "トウキョウトミナトクミナミアザブ",
      "address_code1": "JPN",
      "address1": "日本",
      "address_read1": "ニホン",
      "address_read_through1": "ニホン",
      "address_code2": "13",
      "address2": "東京都",
      "address_read2": "トウキョウト",
      "address_read_through2": "トウキョウト",
      "address_code3": "103",
      "address3": "港区",
      "address_read3": "ミナトク",
      "address_read_through3": "ミナトク",
      "address_code4": "026",
      "address4": "南麻布",
      "address_read4": "ミナミアザブ",
      "address_read_through4": "ミナミアザブ",
      "address_code5": null,
      "address5": null,
      "address_read5": null,
      "address_read_through5": null,
      "address_detail_code1": null,
      "address_detail1": null,
      "address_detail_read1": null,
      "address_detail_read_through1": null,
      "address_detail_code2": null,
      "address_detail2": null,
      "address_detail_read2": null,
      "address_detail_read_through2": null,
      "post_code": "106-0047",
      "address_level": "OAZ",
      "address_name_type": 1,
      "exclude_level_flag": 0,
      "entrance_point": null,
      "position": [
          139.7306369358,
          35.6507858615
      ],
      "pastmap_id": null,
      "pastmap_year": null,
      "child_level_flag": 1,
      "distance": null
    },
    ・・・
    ]
  }
}