address_matching

住所マッチング

住所の正規化処理を行い、座標情報結果を返します。
誤マッチを避けるため、確実に正しい部分までを検索結果として1件返却します。
(住所クレンジングのロジックについて)

指定される住所やパラメータの内容により、処理時間が異なります。
処理に時間のかかる住所を多く指定した場合は、指定可能な上限内であってもタイムアウトが発生する可能性がございます。

https://web.zmaps-api.com/search/address_matching

HTTP request method

POST/GET

ContentType

application/x-www-form-urlencoded

Parameters

*requiredは必須

名前	説明
認証情報パラメータ	契約状況に応じた認証用パラメータを付与してください。利用手順参照。
word*required array[integer] ※カンマ区切り	住所名称を指定建物名や郵便番号などを含めると検索の精度が落ちてしまいます。最大件数 100件。 1件当たりの最大文字数 255文字。 1文字以下の場合、マッチングレベルはNOMを返却します。先頭から100文字までの文字列で検索します。
enc integer default 0	入力住所の文字コードを指定 0 UTF-8 1 EUC-JP 2 Shift-JIS
use_kana boolean default false	カナ住所マッチング機能の使用 trueの場合、通常の住所に加えてwordで指定した文字列がカナ住所と一致するかを検索します。 true 使用する false 使用しない
use_multi_addr boolean default false	重複住所出力機能の使用 true を指定した場合、同一住所に複数の建物がある場合、すべての建物情報を返却する falseの場合は、building_infoの各情報は返却されません。 true 使用する false 使用しない（デフォルト）
match_level string default TBN	マッチングする下限階層を指定指定値より粗いmatch_levelのみが返却されます。 (例:match_levelがOAZ指定されている場合、返却されるmatch_levelはTOD,SHK,OAZのいずれかとなります。) TOD 都道府県 SHK 市区町村
datum string default JGD	入出力座標の測地系を指定します。 JGD 世界測地系 TOKYO 日本測地系 TOKYO_NAVI 日本測地系(ゼンリンナビ地図)

Responses

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

Status Code:200

Media type:application/json

キー名				説明
status string				ステータス
result object				検索結果のオブジェクト
	info object			検索結果の概要
	info object	hit integer		検索結果総数
	item array[object]			検索結果の配列
		input_word string		入力文字列
		address_code string		住所コード
		address string		住所
		address_read_through string		住所読み下し
		address2 string		都道府県名称
		address_read_through2 string		都道府県名称読み下し
		address3 string		市区町村名称
		address_read_through3 string		市区町村名称読み下し
		address4 string		大字名称
		address_read_through4 string		大字名称読み下し
		address5 string		字丁目名称
		address_read_through5 string		字丁目名称読み下し
		address_detail1 string		街区名称
		address_detail_read_through1 string		街区名称読み下し
		address_detail2 string		地番戸番名称
		address_detail_read_through2 string		地番戸番名称読み下し
		post_code string		郵便番号返却住所が市区町村までの場合、基本的にnullで返却されます。
		address_name_type integer		住所階層が国～字丁目の住所に対し、住所名称の種類を表す 1 正式名称（公称） 2 略式名称
		child_level_flag number		子階層フラグ 0 子階層なし 1 子階層あり
		match_level string		マッチングレベル NOM マッチなし TOD 都道府県 SHK 市区町村 OAZ 大字 AZC 字丁目 GIK 街区 TBN2 地番・戸番(部分一致) TBN1 地番・戸番(地番戸番レベルのみで見て完全一致している)
		match_flag integer		入力住所(word)の全ての文字が出力住所(address)の中に含まれているかどうかを表すフラグ(正規化して判定) 0 入力住所が出力住所の中に全て含まれておらず部分的にしか一致しなかった場合 1 入力住所が出力住所の中に全て含まれていた場合
		match_position array[number]		マッチング座標建物座標があれば建物座標、なければ住所座標が返却されます。 ["経度","緯度"]
		match_kana string		マッチングしたカナ住所文字列。カナ住所でマッチングした場合のみ返却します。
		multi_addr_count integer		重複住所件数
		building_info object		建物情報のオブジェクト
			building_type integer	建物・テナント等を判別する区分 3:建物
			zid string	建物ZID 建物等の地物毎にふられるパーマネントのID
			zid_attr string	属性ZID 建物や地物内のテナント施設等といった属性情報毎にふられるパーマネントのID
			position array[number]	座標["経度","緯度"]

Example

リクエストURL

https://[domain]/search/address_matching?word=港区芝浦○-○-○&match_level=TBN&use_multi_addr=true&datum=JGD

レスポンス

{
  "status": "OK",
  "result": {
     "info": {
        "hit": 1
     },
     "item": [
      {
        "input_word": "港区芝浦○-○-○",
        "address_code": "131030110030000100001",
        "address": "東京都港区芝浦○丁目○－○",
        "address_read_through": "トウキョウトミナトクシバウラサンチョウメイチイチ",
        "address2": "東京都",
        "address_read_through2": "トウキョウト",
        "address3": "港区",
        "address_read_through3": "ミナトク",
        "address4": "芝浦",
        "address_read_through4": "シバウラ",
        "address5": "○丁目",
        "address_read_through5": "○チョウメ",
        "address_detail1": "○",
        "address_detail_read_through1": "○",
        "address_detail2": "○",
        "address_detail_read_through2": "○",
        "post_code": "○○○-○○○○",
        "address_name_type": 1,
        "child_level_flag": 0,
        "match_level": "TBN1",
        "match_flag": 0,
        "match_position": [
          XXX.XXXXXXXX,
          XX.XXXXXXXXX
        ],
        "match_kana": null,
        "multi_addr_count": 1,
        "building_info": [
          {
            "building_type": 3,
            "zid": "XXXXXXXXXXXXXXXXXX",
            "zid_attr": "XXXXXXXXXXXXXXXXXX",
            "position": [
              XXX.XXXXXXXX,
              XX.XXXXXXXXX
            ]
          }
        ]
      }
    ]
  }   
}