Addressianの使い方
ユーザー登録／ログイン
右上の「新規登録」ボタンからユーザー登録してください。登録済みの場合は「ログイン」ボタンからログインしてください。ユーザー登録とログインにはGoogleアカウントが必要です。事前にご用意ください。
APIキーの確認
上部メニューの「APIキーの確認」をクリックしてください。APIキーが表示されたらコピーしてください。
APIキーは秘密にしてください。
APIの呼び出し方法
curlコマンドを用いた実行例を以下に示します。{APIキー}の部分はご自身のAPIキーで置き換えてください。
POST
curl -X POST \
-H 'Content-Type:application/json' \
-H 'x-api-key:{APIキー}' \
-d '[{"address":"港区芝大門1-10-18 PMO芝大門3F"}]' \
https://s32y6jl1f8.execute-api.ap-northeast-1.amazonaws.com/api/address_normalizer
GET
curl -X GET \
'https://s32y6jl1f8.execute-api.ap-northeast-1.amazonaws.com/api/address_normalizer/?key={APIキー}&address={URLエンコードされた住所}&target={取得したい項目}'
Googleスプレッドシートを用いたAPI呼び出し
住所正規化APIを呼び出すGoogleスプレッドシートのサンプルをご用意しました。コピーしてお試しください。
サンプルコード
複数の言語によるサンプルコードをご用意しました。実装の参考にしてください。
'https://github.com/interman-corp/addressian_example'
API仕様
共通項目
| 項目 | 内容 |
|---|---|
| URL | https://s32y6jl1f8.execute-api.ap-northeast-1.amazonaws.com/api/ |
住所正規化API（address_normalizer）
パス
/address_normalizer
リクエスト方式
POST, GET
POST リクエストパラメータ
住所正規化のPOSTリクエストでは、配列を用いて複数の住所を設定できます。1回のリクエストで設定できる住所の上限は100件です。100件を超える住所は無視されます。住所を複数設定しても、APIの呼び出し回数は1回とカウントされます。
| キー | 説明 |
|---|---|
| [n].address | 正規化前住所。正規化したい住所の値を設定する。 |
| [n].id | 省略可。リクエストした住所をレスポンスに紐付けるためのID。省略時は連番が自動設定される。 |
POST レスポンス
| キー | 説明 |
|---|---|
| status | HTTPステータス。 |
| items | 正規化の結果が配列で格納される。 |
| items[n].zip_code | 郵便番号（ハイフンなし）。例）1050012 |
| items[n].zip_code_first | 郵便番号の前半3桁。 |
| items[n].zip_code_second | 郵便番号の後半4桁。 |
| items[n].normalized_address_type1 | 正規化タイプ1で正規化された住所。国土交通省の位置参照情報に準拠し、丁目は漢数字で、地番はアラビア数字とハイフンで表示される。例）東京都港区芝大門一丁目10-18 |
| items[n].normalized_address_type2 | 正規化タイプ2で正規化された住所。国土交通省の位置参照情報に準拠し、丁目と地番はアラビア数字とハイフンで表示される。例）東京都港区芝大門1-10-18 |
| items[n].normalized_address_type3 | 正規化タイプ3で正規化された住所。国土交通省の位置参照情報に準拠し、丁目と地番は漢数字で表示される。例）東京都港区芝大門一丁目十番十八号 |
| items[n].normalized_address_type4 | 正規化タイプ4で正規化された住所。国土交通省の位置参照情報に準拠し、丁目と地番は漢数字（数列）で表示される。例）東京都港区芝大門一丁目一〇番一八号 |
| items[n].normalized_address_type5 | 正規化タイプ5で正規化された住所。郵便番号データ（KEN_ALL.csv）に準拠し、丁目は漢数字で、地番はアラビア数字とハイフンで表示される。例）東京都港区芝大門一丁目10-18 |
| items[n].pref | 都道府県。例）東京都 |
| items[n].city | 市区町村。国土交通省の位置参照情報に準拠。例）港区 |
| items[n].city_post | 市区町村。郵便番号データ（KEN_ALL.csv）に準拠。例）港区 |
| items[n].town_type1 | 丁目と小字・通称名を含む町域。国土交通省の位置参照情報に準拠。例）芝大門一丁目 |
| items[n].town_type2 | 丁目と小字・通称名を含まない町域。郵便番号データ（KEN_ALL.csv）に準拠。例外的に丁目、小字・通称名が含まれる場合あり。例）芝大門 |
| items[n].chome | 丁目。town_type2に丁目が含まれる場合は空になる。例）一丁目 |
| items[n].koaza | 小字・通称名。 |
| items[n].building | 建物名。例）PMO芝大門3F |
| items[n].building_kanji | 数値部分を漢数字（数列）にした建物名。階数の「F」は「階」に変換される。例）PMO芝大門三階 |
| items[n].custom_type1 | 都道府県から丁目を含まない町域までを結合した値。例）東京都港区芝大門 |
| items[n].custom_type2 | 丁目以降をアラビア数字とハイフンで表記。建物名は含まない。例）1-10-18 |
| items[n].custom_type3 | 丁目以降をアラビア数字とハイフンで表記。建物名が部屋番号や階数のみの場合はハイフンで結合する。部屋番号の「号」「号室」は除去される。階数の「階」「Ｆ（全角）」は「F（半角）」に変換される。例）1-10-18-301, 1-10-18-3F |
| items[n].custom_type4 | custom_type3と組み合わせて使うことを想定した建物名。建物名がcustom_type3に含まれている場合は空になる。例）PMO芝大門3F |
| items[n].ban | 番(アラビア数字)。例）10 |
| items[n].ban_kanji_type1 | 番(漢数字)。例）十 |
| items[n].ban_kanji_type2 | 番(漢数字列)。例）一〇 |
| items[n].go | 号(アラビア数字)。例）18 |
| items[n].go_kanji_type1 | 号(漢数字)。例）十八 |
| items[n].go_kanji_type2 | 号(漢数字列)。例）一八 |
| items[n].ban_go_kanji_type1 | 番、号(漢数字)。例）十番十八号 |
| items[n].ban_go_kanji_type2 | 番、号(漢数字列)。例）一〇番一八号 |
| items[n].is_complete | 住所完全フラグ。住所の正規化に成功し、地番が存在したらtrueとなる。 |
| items[n].pref_kana | 都道府県カナ。 |
| items[n].city_kana | 市区町村カナ。 |
| items[n].town_kana | 町域カナ。 |
| items[n].id | リクエストパラメータに設定されたid。省略時は連番が自動設定される。 |
| items[n].original | リクエストパラメータに設定された正規化前住所の値。 |
| items[n].success | 住所正規化に成功したらtrueとなる。住所が町域までマッチしたら成功とみなす。 |
| items[n].version | 住所正規化ロジックのバージョン。 |
| items[n].kokudo_version | 国土交通省ダウンロードデータのバージョン。 |
| items[n].kenall_version | 日本郵便ダウンロードデータのバージョン。 |
GET リクエストパラメータ
住所正規化のGETリクエストでは、取得したい項目を指定してCSV形式でレスポンスを受け取ることができます。1回のリクエストで設定できる住所の上限は100件です。100件を超える住所は無視されます。複数の住所を設定しても、API呼び出し回数は1回とカウントされます。GETリクエストでは、URLが長くなるため文字数制限によりエラーになる場合があります。利用するシステムの仕様をご確認ください。
| キー | 説明 |
|---|---|
| key | APIキー。 |
| address | 正規化したい住所をURLエンコードした値。カンマ区切りで最大100件まで設定可能。住所にカンマが含まれる場合は、該当住所をダブルコーテーションで囲む。 |
| format | jsonまたはtextを設定。省略可能。省略した場合はtext。 |
| target | 取得したい項目の項目名をカンマ区切りで設定。項目名はPOSTのレスポンスを参照。format=textの場合のみ設定可能。例）target=zip_code,normalized_address_type1 |
GET レスポンス（format=json 設定時）
| キー | 説明 |
|---|---|
| status | HTTPステータス。 |
| items | 正規化の結果が配列で格納される。 |
| items[n].id | 連番が自動設定される。 |
| その他 | POSTのレスポンスと同じ。 |
GET レスポンス（format=text 設定時、またはformat省略時）
targetで指定した項目がCSV形式で返却されます。
例） 「target=zip_code,normalized_address_type2,building」を指定し、2件の住所をまとめて正規化した場合のレスポンス
1050012,東京都港区芝大門1-10-18,PMO芝大門3F
8900045,鹿児島県鹿児島市武1-2-10,5F
制限事項
Addressianの提供するAPIには以下の制限があります。あらかじめご了承ください。
ペイロードについて
APIのペイロード（リクエストとレスポンスの合計）は6MBに制限されています。大量のリクエストを一度に送信するとペイロードの制限を超える可能性があります。ペイロードの制限を超えるとAPIはエラーを返します。
APIの予期せぬエラーについて
一時的に予期せぬエラーが発生する場合があります。その場合はしばらく時間をおいてから再実行してください。
APIの回数制限
1か月あたりのAPIの実行回数には上限があります。実行回数が上限に達するとAPIはエラーとなります。FREE版の上限は1,000回です。大量のAPIを実行したい場合はPRO版の利用をご検討ください。