住所クレンジングAPI 技術仕様

※住所ジオコーディングサービスの技術仕様と共通となっております。

Addr Verification API

Addr Verification API (v1.1)

Download OpenAPI specification:Download

このドキュメントでは、IncrementPが提供するAddr Verification APIについて説明しています。
Addr Verification APIサービスでは、IncrementP製日本住所データを利用し、住所の正確性チェック(正規化他)を行うことが可能です。

Authentication

apiKey

Security Scheme Type API Key
Header parameter name: x-api-key

Single request API

住所正規化個別処理

住所文字列一件を正規化します。

Authorizations:
path Parameters
addr
required
string
Example: 盛岡市盛岡駅西通町2丁目9番地1号 マリオス10F;東京都文京区本駒込2-28-8 文京グリーンコートセンターオフィス22F

住所文字列。

住所文字列はセミコロン(;)で区切って複数件(50件まで)指定できます。
セミコロンはパーセントエンコーディングしても( %3B )しなくても( ; )区切り文字として扱います。
空の住所文字列を含めることはできません(無視されます)

query Parameters
geocode
boolean
Default: false

経緯度(geometry)の出力有無。指定しなかった場合、 "geometry":null となります。

Responses

200

住所正規化結果(GeoJSON)

400

パラメータエラー

403

APIキーが指定されていないか無効

get/{addr}.json
https://api-anorm.mapfan.com/v1/{addr}.json

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "type": "FeatureCollection",
  • "query":
    [
    ],
  • "features":
    [
    ],
  • "attribution": "(c) INCREMENT P CORPORATION"
}

住所正規化個別処理(ジオコーディング付き)

住所文字列一件を正規化し、住所の経緯度を付与した結果を返します。
/{addr}.json?geocode=true と同じ結果が返ります。

Authorizations:
path Parameters
addr
required
string
Example: 盛岡市盛岡駅西通町2丁目9番地1号 マリオス10F;東京都文京区本駒込2-28-8 文京グリーンコートセンターオフィス22F

住所文字列。

住所文字列はセミコロン(;)で区切って複数件(50件まで)指定できます。
セミコロンはパーセントエンコーディングしても( %3B )しなくても( ; )区切り文字として扱います。
空の住所文字列を含めることはできません(無視されます)

Responses

200

住所正規化結果(GeoJSON)

403

APIキーが指定されていないか無効

get/{addr}.geojson
https://api-anorm.mapfan.com/v1/{addr}.geojson

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "type": "FeatureCollection",
  • "query":
    [
    ],
  • "features":
    [
    ],
  • "attribution": "(c) INCREMENT P CORPORATION"
}

Multiple request API

住所正規化一括処理

POSTされたCSVファイルの住所文字列を一行ずつ読み取り、行の末尾に住所文字列を正規化した結果を追加したCSVファイルを作成する処理を開始します。
追加される内容は「住所正規化一括処理で追加される列」の項を参照ください。

正規化結果が追加されたCSVファイルの取得は /batch/status/{proc_id} で行います。
proc_id にはこのAPIのレスポンスに含まれているものを指定してください。 proc_id の有効期間は12時間です。

Authorizations:
query Parameters
addr_cols
required
Array of integers
Example: addr_cols=2

正規化したい住所文字列が記載された列の番号。先頭の列の番号は「1」。コンマ区切りで複数列指定すると、指定した列の文字列をすべて連結して正規化します。

headers
integer [ 0 .. 10 ]
Default: 0

ヘッダ行(正規化しない先頭行)の行数。

geocode
boolean
Default: false

経緯度の出力有無。指定しなかった場合は出力しません。

Request Body schema: text/plain

正規化したい住所文字列を含むCSVファイル。

受け付けるCSVファイルの仕様

  • 文字コード: UTF-8(BOMなし)
  • 改行コード: LF
  • 区切り文字: ,(コンマ)
  • ダブルクォートの扱い: ただの文字として扱う(フィールドを囲うための文字としては扱わない)
  • 最大受け付け可能行数: 4000行(ヘッダ行除く)
string <csv>

Responses

202

住所正規化一括処理の開始に成功

400

パラメータエラー

403

APIキーが指定されていないか無効

post/batch/csv
https://api-anorm.mapfan.com/v1/batch/csv

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "proc_id": "string"
}

住所正規化一括処理進捗取得

一括処理の進捗の取得、および作成された出力CSVファイルのダウンロードURLの取得に使用します。
ダウンロードURLには1時間の有効期限が設けられており、期限が切れるとそのURLではファイルをダウンロードできなくなります。

このAPIを繰り返し呼ぶ場合、呼び出しの間隔を最低でも1秒空けてください。

Authorizations:
path Parameters
proc_id
required
string

処理ID

Responses

200

進捗取得成功

403

APIキーが指定されていないか無効

404

処理IDが無効

get/batch/status/{proc_id}
https://api-anorm.mapfan.com/v1/batch/status/{proc_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
[]

解析レベル・解析ログ仕様

string (解析レベル・解析ログ仕様)

解析レベル

解析レベル レベルの数字 説明
都道府県 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 「小字」または「字」の文字を除去した(小字部分)
NT001 正規化処理状況が建物正規化の条件を満たさないため,建物正規化処理は行わなかった
ZJ001 入力文字列が事業所郵便番号情報と一致した
ZJ005 郵便番号が存在しない住所マスタ情報である
DE003 町域(大字)止まりの住所(配下の小字・丁目やそれ以降を持たない住所)である
DE004 小字・丁目止まりの住所(配下の番地やそれ以降を持たない住所)である

FC001:住所情報を特定しきれない候補が存在する

住所文字列からの正規化処理の結果として、ログに「FC001:候補が存在します」と出力された場合、正規化処理中に住所情報を特定しきれず、結果が複数個存在することを意味します。
このログが出力されている場合で正しく正規化処理が行われていない場合、入力文字列をより厳密に指定するようにしてください。

候補の例

住所文字列 候補
府中市 "place_name": "東京都府中市"
"place_name": "広島県府中市"
川西市萩原台西3-191 "zipcode": "6660006"
"zipcode": "6660134"

※複数の郵便番号を持つ住所は郵便番号ごとに別の住所扱いとなります。

候補が存在する場合の各APIの挙動

Single request API では候補となる住所をすべて返します。候補の中でFC001のログが残るのは最初の1件だけとなります。
Multiple request API では複数候補が存在したとしてもいずれか1件だけを返します。

Copy
Expand all Collapse all
"string"

出力CSVファイル仕様

string (出力CSVファイル仕様)

住所正規化一括処理で追加される列

住所正規化を行った行の末尾には以下の18列が追加されます。
住所正規化を行わなかった行(ヘッダ行、住所文字列が空の行)には列は追加されません。

内容 例(盛岡市盛岡駅西通町2丁目9番地1号マリオス10F)
1 都道府県名 岩手県
2 都道府県読み イワテケン
3 市区町村名 盛岡市
4 市区町村読み モリオカシ
5 町域名 盛岡駅西通
6 町域名読み モリオカエキニシドオリ
7 小字・丁目 2丁目
8 小字・丁目読み 2
9 番地・号 9-1
10 建物名称部 マリオス
11 建物数字部 10F
12 郵便番号 0200045
13 経度 141.133660
※geocode=falseの場合は空
14 緯度 39.701281
※geocode=falseの場合は空
15 解析レベル 8
16 解析レベル説明 号レベルでマッチしました(8)
17 解析ログコード FL001|RM001
※Multiple request APIでのみ取得できる属性になります。
18 解析ログメッセージ FL001:都道府県名を補完しました(岩手県) | RM001:文字を除去しました(町) |
Copy
Expand all Collapse all
"string"