ジオコーディングAPI

住所、地名、郵便番号、または「キングス・クロス近くのコーヒーショップ」のような大まかな説明を送ると、座標、整形された住所、その構成要素、バウンディングボックス、そしてその地点をどこまで信頼できるかを示す精度レベルが返ります。

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

例

リクエスト

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/forward?q=221B+Baker+Street,+London&limit=1"

自由形式のテキストが使えます。要素がすでに分かれている場合は、構造化クエリも使えます：street=221B Baker Street&city=London&country=gb。country=gb,ieで結果を1つ以上の国に限定したり、proximity=lat,lonで特定の地点を、boundsで特定の範囲を優先したりできます。

レスポンス

{
  "status": "ok",
  "query": "221B Baker Street, London",
  "results": [
    {
      "formatted": "221B Baker Street, London NW1 6XE, United Kingdom",
      "lat": 51.523767,
      "lon": -0.158555,
      "type": "address",
      "precision": "house",
      "confidence": 0.97,
      "components": {
        "house_number": "221B",
        "road": "Baker Street",
        "neighbourhood": "Marylebone",
        "city": "London",
        "state": "England",
        "postcode": "NW1 6XE",
        "country": "United Kingdom",
        "country_code": "gb"
      },
      "bounds": { "north": 51.523917, "south": 51.523617, "east": -0.158305, "west": -0.158805 }
    }
  ]
}

返される内容

フィールド	意味
`formatted`	その国の住所表記に従って書かれた完全な住所です。
`lat`, `lon`	10進数の度（WGS 84）。小数点以下最大6桁です。
`type`	一致した対象の種類：`address`、`street`、`postcode`、`city`、`region`、`country`、`poi`のいずれかです。
`precision`	`house`、`street`、`postcode`、`admin`のいずれかです。カバレッジをご覧ください。
`confidence`	0から1の値です。クエリから判断して、意図した場所である確からしさを示します。精度とは独立しており、都市名のクエリは精度`admin`で確信度1の一致となることがあります。
`components`	構成要素に分解された住所で、どの国でも同じキー名を使います。存在する要素だけが含まれます。
`bounds`	一致した対象（建物、通り、郵便番号区域、都市）のバウンディングボックスです。

利用シーン

顧客住所のクレンジング

新規登録時にジオコーディングし、顧客が入力した内容と一緒にformattedとcomponentsを保存します。precision: street未満のものは受け付けず、確認を求めます。

レコードを地図に表示する

店舗や物件の住所を記載したCSVを毎秒50件のペースで一括処理し、地図にプロットします。boundsフィールドから、それぞれに適したズームレベルが得られます。

場所で検索する

「ハックニーのアパート」をバウンディングボックスに変換し、それを使って自社のデータベースを検索します。typeを見れば、ユーザーが入力したのが都市か、通りか、建物かが分かります。

精度

番地レベルの結果は、その国の住所データが存在するかどうかに左右され、住所データはどこにでもあるわけではありません。カバレッジページには、249の国と地域それぞれで到達できる最高レベルを掲載しています。番地で一致しない場合は、通り、郵便番号、地域の順にフォールバックし、どのレベルかをprecisionフィールドが示します。国の中心点を住所として返すことは決してありません。

料金と制限

1回の呼び出しは、返す結果の件数（limitで最大10件）にかかわらず1リクエストです。どのキーにも1日あたり2,500件の無料リクエストがあり、それを超えるとプリペイドクレジットから1件あたり€0.0001、Unlimitedキー（月額€50）なら追加料金はかかりません。料金の詳細。

他のプロバイダーから移行しますか？Google、Bing、HERE、Mapbox、その他の互換ホストが、各プロバイダーの形式でジオコーディングのリクエストに応答します。