OpenCageの互換ホスト

OpenCageはジオコーディングと逆ジオコーディングに1つのエンドポイントを使い、充実したannotationsブロックを返します。opencage.mygeocode.comも同じで、OpenCageのユーザーが読み取るタイムゾーン、通貨、国際電話番号、what3words形式のアノテーションも含まれます。

ホスト名を1つ変えるだけ

元のホスト
  • api.opencagedata.com
代わりに使うホストopencage.mygeocode.com
キーのパラメーターkey(任意:どのアドレスでもキーなしで1日あたり2,500件のリクエストが使えます。クレジット、パッケージ、利用履歴を使うにはここにMy Geocodeのキーを入れてください)
変更前
curl "https://api.opencagedata.com/geocode/v1/json?q=Colosseum+Rome&key=YOUR_OPENCAGE_KEY"
変更後
curl "https://opencage.mygeocode.com/geocode/v1/json?q=Colosseum+Rome&key=YOUR_MYGEOCODE_KEY"

移行する理由

同じリクエスト、同じレスポンス形式で、キーごとに1日あたり2,500件の無料リクエスト、帰属表示の義務も非商用条項もありません。

キーの有無にかかわらず、無料枠は同じです。opencage.mygeocode.comへのリクエストは、お使いのアドレスまたはキーが当社独自のエンドポイントで得ている1日あたり2,500件の無料リクエストと同じ枠から差し引かれます。それを超える分は、プリペイドクレジットで1リクエストあたり€0.0001、またはUnlimitedキーで月額€50です。登録に必要なのはメールアドレスだけです。

料金を見る 無料のキーを取得

エンドポイント

opencage.mygeocode.comのパス機能バックエンド
/geocode/v1/json?q=...ジオコーディングジオコーディング
/geocode/v1/json?q=lat,lng逆ジオコーディング逆ジオコーディング
/geocode/v1/geojson?q=...GeoJSON出力ジオコーディング

レスポンスの例

上記のリクエストはこれを返します。フィールド名、入れ子構造、型はOpenCageに準拠しています。その中身のデータだけが当社のものです。

opencage.mygeocode.comからのレスポンス
{
  "documentation": "https://www.mygeocode.com/compatibility/opencage/",
  "licenses": [ { "name": "My Geocode Terms", "url": "https://www.mygeocode.com/terms/" } ],
  "rate": { "limit": 2500, "remaining": 2483, "reset": 1756339200 },
  "results": [
    {
      "annotations": {
        "DMS": { "lat": "41° 53' 24.72'' N", "lng": "12° 29' 31.92'' E" },
        "callingcode": 39,
        "currency": { "iso_code": "EUR", "name": "Euro", "symbol": "€" },
        "flag": "🇮🇹",
        "timezone": { "name": "Europe/Rome", "now_in_dst": 1, "offset_sec": 7200, "offset_string": "+0200", "short_name": "CEST" }
      },
      "bounds": {
        "northeast": { "lat": 41.8905, "lng": 12.4932 },
        "southwest": { "lat": 41.8897, "lng": 12.4914 }
      },
      "components": {
        "ISO_3166-1_alpha-2": "IT",
        "ISO_3166-1_alpha-3": "ITA",
        "_category": "travel/tourism",
        "_type": "attraction",
        "attraction": "Colosseo",
        "city": "Roma",
        "continent": "Europe",
        "country": "Italia",
        "country_code": "it",
        "postcode": "00184",
        "road": "Piazza del Colosseo",
        "state": "Lazio"
      },
      "confidence": 9,
      "formatted": "Colosseo, Piazza del Colosseo, 00184 Roma RM, Italia",
      "geometry": { "lat": 41.8902, "lng": 12.4922 }
    }
  ],
  "status": { "code": 200, "message": "OK" },
  "total_results": 1
}

詳細と相違点

1日あたり最初の2,500件のリクエストにはキーは不要です。My Geocodeのキーを使う場合は、OpenCageのキーがあった場所、つまりkeyクエリパラメーターに入れてください。X-API-Keyヘッダー、Authorization: Bearer、HTTP Basic認証(キーをユーザー名として使用)もすべてのホストで使えるため、独自の方法で認証するクライアントライブラリも変更なしで動作し続けます。

レスポンス内の著作権表示、ライセンス名、利用規約とプライバシーのリンクは、元のプロバイダーのものではなく当社のものです。それ以外はすべて元の形式を保っています。

  • rateブロックは、実際の無料枠、残りの件数、リセットされる時刻を報告します。
  • jsongeojsonの両方のエンドポイントに対応しています。
  • 元のサービスにないため、一括処理のエンドポイントはありません。大量の処理には、api.mygeocode.comPOST /v1/forwardまたは/v1/reverseをお使いください(1回の呼び出しで最大100件、それぞれ1リクエスト)。

お使いのクライアントがここに記載されていないフィールドや動作に依存している場合は、お知らせください。互換性の差異はたいてい小さいため、すぐに修正されます。

その他の互換ホスト

互換ホストの仕組み概要JavaScriptライブラリの互換対応