Watch-IP

IPルックアップAPIリファレンス

GET/v1/lookup/{ip}

指定した単一のIPv4またはIPv6アドレスを、サードパーティのIPジオロケーションデータベースを使って解決します—GET /v1/geoとはデータソースもレスポンス形式も異なります。サーバー間通信専用です。自分のバックエンドから呼び出してください。ブラウザから呼び出すことはできません。

認証

Authorization: Bearer YOUR_SECRET_KEYでシークレットキーを指定してください。GET /v1/geoが使用する公開可能キーとは異なり、このキーはサーバー上に留めておく必要があります—ここで公開可能キーを使用すると403が返されます。

レスポンスフィールド

ip
指定したIPアドレスがそのまま返されます。
country, city, continent
情報源データベースから得られるおおよその位置情報。利用できない場合はnull。
region
地域名ではなく細分区分コード(例:"TX")—GET /v1/geoのregionフィールドとは形式が異なります。
postalCode, timezone
現行の情報源データベースでは値が入らず、常にnullです。
latitude, longitude
おおよその座標。利用できない場合はnull。
found
IPに一致するレコードがない場合、または基盤となるデータベースが一時的に利用できない場合にfalseになります—このフィールドでは両者は区別されません。

エラー

400
指定されたIPが有効なIPv4またはIPv6アドレスではありません。
401
APIキーが欠落しているか無効です。
403
シークレットキーの代わりに公開可能キーが使われました。
429
現在の1分間ウィンドウでレート制限を超えました。

例

リクエスト

curl https://api.watch-ip.com/v1/lookup/203.0.113.1 \
  -H "Authorization: Bearer YOUR_SECRET_KEY"

レスポンス

{
  "ip": "203.0.113.1",
  "country": "US",
  "region": "TX",
  "city": "Austin",
  "postalCode": null,
  "latitude": 30.2672,
  "longitude": -97.7431,
  "continent": "NA",
  "timezone": null,
  "found": true
}

制限

訪問者ジオロケーションのプランのリクエスト量とは別に、ルックアップしたIPごとに課金されます—料金と利用可否についてはIPルックアップの製品ページをご覧ください。1回の呼び出しで複数のIPが必要な場合は、代わりにバッチエンドポイントを使用してください。このエンドポイントの位置情報データはDB-IPによって提供されています(IP Geolocation by DB-IP、db-ip.com—CC BY 4.0)。

関連ページ