住所オートコンプリートAPI

入力中に、住所、通り、市区町村、場所の候補を表示します。各候補にはそれぞれ座標と精度が付いているため、ユーザーが候補を選んだ時点で必要な情報はすべて揃っています。セッショントークンも、詳細情報を取得する別の呼び出しも、セッション単位の料金もありません。

GEThttps://api.mygeocode.com/v1/autocomplete?q=...

デモで試す 完全なリファレンス

リクエスト
$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/autocomplete?q=10+Downing&country=gb&limit=3"

レスポンスは入力中の利用に合わせて調整されています。数十ミリ秒で返され、文字の抜けや単語の入れ替わりも許容します。proximity=lat,lonを送ると近くの場所が上位に表示されます。これは多くの町に存在する通りの名前では非常に重要です。

キー入力は約150ミリ秒でデバウンスしてください。一般的な住所は、選択までに4から6件のリクエストがかかります。

レスポンス
{
  "status": "ok",
  "query": "10 Downing",
  "suggestions": [
    {
      "text": "10 Downing Street, London SW1A 2AA, United Kingdom",
      "lat": 51.503396,
      "lon": -0.12764,
      "type": "address",
      "precision": "house",
      "place_id": "gb.addr.7f3c2a19"
    },
    {
      "text": "10 Downing Place, Cambridge CB2 3EN, United Kingdom",
      "lat": 52.203042,
      "lon": 0.121811,
      "type": "address",
      "precision": "house",
      "place_id": "gb.addr.a01d9e44"
    },
    {
      "text": "10 Downing Road, Dagenham RM9 6NP, United Kingdom",
      "lat": 51.536118,
      "lon": 0.137204,
      "type": "address",
      "precision": "house",
      "place_id": "gb.addr.c58b7e02"
    }
  ]
}

返される内容

フィールド意味
text表示用の候補テキスト(1行)。
lat, lon候補の座標。すべての候補に含まれます。
typeaddressstreetpostcodecityregioncountrypoiのいずれか。
precisionジオコーディングと同じ4つの値。
place_id安定した識別子。選択した候補の完全な構成要素と範囲が必要な場合は、/v1/forward?place_id=...に渡してください。

利用シーン

チェックアウトの住所フォーム

6つの入力欄の代わりに1つで済みます。選択した候補のplace_idで構成要素を取得し、フォームの残りを埋められます。

地図上の検索ボックス

地図の中心をproximityとして渡せば、「High Street」が画面上にある通りを指すようになります。

Places Autocompleteの置き換え

Google Maps JavaScriptの互換ライブラリは、このエンドポイントを使ったgoogle.maps.places.Autocompleteを、セッション単位の料金なしで提供します。

料金と制限

1回の呼び出しは1リクエストです。セッション単位の料金も、候補の選択に対する別料金もありません。すべてのキーに1日あたり2,500件の無料リクエストがあり、それを超えるとプリペイドクレジットから1件あたり€0.0001、Unlimitedキー(月額€50)なら無料です。料金