住所クレンジングAPI 技術仕様
※住所ジオコーディングサービスの技術仕様と共通となっております。
Addr Verification API (v1.1)
Download OpenAPI specification:Download
このドキュメントでは、IncrementPが提供するAddr Verification APIについて説明しています。
Addr Verification APIサービスでは、IncrementP製日本住所データを利用し、住所の正確性チェック（正規化他）を行うことが可能です。
住所正規化個別処理
住所文字列一件を正規化します。
クライアントIP単位で5分あたり15,000リクエストの制限を設定しており、個別のセッションがサービス全体に影響を及ぼさない設計となっております。
Authorizations:
path Parameters
| addr required | string Example: 盛岡市盛岡駅西通町２丁目９番地１号 マリオス10F;東京都文京区本駒込2-28-8 文京グリーンコートセンターオフィス22F 住所文字列。 住所文字列はセミコロン（;）で区切って複数件（50件まで）指定できます。 |
query Parameters
| geocode | boolean Default: false 経緯度（geometry）の出力有無。指定しなかった場合、 |
Responses
Response samples
- 200
- 400
- 403
{- "type": "FeatureCollection",
- "query": [
- "盛岡市盛岡駅西通町２丁目９番地１号 マリオス10F"
], - "features": [
- {
- "type": "Feature",
- "geometry": {
- "type": "Point",
- "coordinates": [
- 141.13366,
- 39.701281
]
}, - "properties": {
- "query": "盛岡市盛岡駅西通町２丁目９番地１号 マリオス10F",
- "place_name": "岩手県盛岡市盛岡駅西通2丁目 9-1 マリオス10F",
- "pref": "岩手県",
- "pref_kana": "イワテケン",
- "city": "盛岡市",
- "city_kana": "モリオカシ",
- "area": "盛岡駅西通",
- "area_kana": "モリオカエキニシドオリ",
- "koaza_chome": "2丁目",
- "koaza_chome_kana": "2チョウメ",
- "banchi_go": "9-1",
- "building": "マリオス",
- "building_number": "10F",
- "zipcode": "0200045",
- "geocoding_level": "8",
- "geocoding_level_desc": "号レベルでマッチしました(8)",
- "log": "FL001:都道府県名を補完しました(岩手県)",
- "not_normalized": ""
}
}
], - "attribution": "(c) INCREMENT P CORPORATION"
}住所正規化個別処理（ジオコーディング付き）
住所文字列一件を正規化し、住所の経緯度を付与した結果を返します。/{addr}.json?geocode=true と同じ結果が返ります。
Authorizations:
path Parameters
| addr required | string Example: 盛岡市盛岡駅西通町２丁目９番地１号 マリオス10F;東京都文京区本駒込2-28-8 文京グリーンコートセンターオフィス22F 住所文字列。 住所文字列はセミコロン（;）で区切って複数件（50件まで）指定できます。 |
Responses
Response samples
- 200
- 403
{- "type": "FeatureCollection",
- "query": [
- "盛岡市盛岡駅西通町２丁目９番地１号 マリオス10F"
], - "features": [
- {
- "type": "Feature",
- "geometry": {
- "type": "Point",
- "coordinates": [
- 141.13366,
- 39.701281
]
}, - "properties": {
- "query": "盛岡市盛岡駅西通町２丁目９番地１号 マリオス10F",
- "place_name": "岩手県盛岡市盛岡駅西通2丁目 9-1 マリオス10F",
- "pref": "岩手県",
- "pref_kana": "イワテケン",
- "city": "盛岡市",
- "city_kana": "モリオカシ",
- "area": "盛岡駅西通",
- "area_kana": "モリオカエキニシドオリ",
- "koaza_chome": "2丁目",
- "koaza_chome_kana": "2チョウメ",
- "banchi_go": "9-1",
- "building": "マリオス",
- "building_number": "10F",
- "zipcode": "0200045",
- "geocoding_level": "8",
- "geocoding_level_desc": "号レベルでマッチしました(8)",
- "log": "FL001:都道府県名を補完しました(岩手県)",
- "not_normalized": ""
}
}
], - "attribution": "(c) INCREMENT P CORPORATION"
}解析レベル
| 解析レベル | レベルの数字 | 説明 |
|---|---|---|
| 都道府県 | 1 | 県レベルでマッチしました |
| 市区町村 | 2 | 市区町村レベルでマッチしました |
| 町域 (大字) | 3 | 町域レベルでマッチしました |
| 丁目 / 小字 | 4 | 丁目または小字レベルでマッチしました |
| 番地（番） | 5 | 番地（番）レベルでマッチしました |
| 号情報が存在しない番地 | 7 | 番地（番）レベルでマッチしました（号情報が存在しない地域） |
| 号 | 8 | 号レベルでマッチしました |
| 不明 | -1 | 不明 |
解析ログメッセージ
正規化処理時に「補完」や「削除」した文字列などがあった場合にログとして残します（主に住所文字列の処理時）。
「 | 」区切りでログコードを複数格納します。
| コード | メッセージ |
|---|---|
| UN001 | 合併情報を適用した |
| UN002 | 合併情報ファイルの指定により旧名称で出力する |
| NF001 | 都道府県情報を検索できなかった |
| NF002 | 市区町村情報を検索できなかった |
| NF003 | 町域情報を検索できなかった |
| NF004 | 町域代表点が住所マスタにないため市区町村代表点を使用した |
| NF005 | 丁目，小字，番地などの情報を検索できなかった |
| NF009 | 位置情報を取得できなかった |
| NF010 | 丁目，小字レベルでの位置情報を取得できなかった．代表点を採用する． |
| FL001 | 都道府県名を補完した |
| FL002 | 市区町村名を補完した |
| FL007 | 番(地)-号の後にある数字（3桁未満）を「号の枝番」と判断し番(地)-号末尾に追加した |
| FL010 | 町域名検索時，文字列「町」を補完して検索し，町域名を見つけた． |
| FC001 | 住所情報を特定しきれない候補が存在する |
| RM001 | 文字を除去した（除去した文字はログ内に追記されます） |
| RM002 | 「大字」または「字」の文字を除去した（町域名部分） |
| RM003 | 「小字」または「字」の文字を除去した（小字部分） |
| RP001 | 入力文字列に含まれる半角カタカナを全角に置換しました |
| NT001 | 正規化処理状況が建物正規化の条件を満たさないため，建物正規化処理は行わなかった |
| ZJ001 | 入力文字列が事業所郵便番号情報と一致した |
| ZJ005 | 郵便番号が存在しない住所マスタ情報である |
| DE003 | 町域（大字）止まりの住所（配下の小字・丁目やそれ以降を持たない住所）である |
| DE004 | 小字・丁目止まりの住所（配下の番地やそれ以降を持たない住所）である |
FC001:住所情報を特定しきれない候補が存在する
住所文字列からの正規化処理の結果として、ログに「FC001:候補が存在します」と出力された場合、正規化処理中に住所情報を特定しきれず、結果が複数個存在することを意味します。
このログが出力されている場合で正しく正規化処理が行われていない場合、入力文字列をより厳密に指定するようにしてください。
候補の例
| 住所文字列 | 候補 |
|---|---|
| 府中市 | "place_name": "東京都府中市" "place_name": "広島県府中市" |
| 川西市萩原台西3-191 | "zipcode": "6660006" "zipcode": "6660134" |
※複数の郵便番号を持つ住所は郵便番号ごとに別の住所扱いとなります。
候補が存在する場合の各APIの挙動
Single request API では候補となる住所をすべて返します。候補の中でFC001のログが残るのは最初の1件だけとなります。
"string"