住所確認・ジオコーディングAPI 技術仕様

Addr Verification API

Addr Verification API (v1.2)

Download OpenAPI specification:Download

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

Authentication

apiKey

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

Single request API

住所正規化個別処理

住所文字列一件を正規化します。
クライアントIP単位で5分あたり15,000リクエストの制限を設定しており、個別のセッションがサービス全体に影響を及ぼさない設計となっております。

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

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "query": [
    ],
  • "features": [
    ],
  • "attribution": "(c) GeoTechnologies Inc."
}

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

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

Authorizations:
path Parameters
addr
required