Watch-IP

訪問者ジオロケーションAPIリファレンス

GET/v1/geo

接続元クライアントが利用可能な位置情報とエンリッチメントデータを返します。訪問者のブラウザから呼び出すとその訪問者の接続を表しますが、アプリケーションサーバーからのリクエストは代わりにサーバー自身の接続を表します。

認証

X-Api-Keyヘッダーでオリジンロックされた公開可能キーを指定するか、代わりにkeyクエリパラメータを使用してください。アクセス制御は、キーの秘匿性ではなく、キーに設定された許可オリジンのリストによって行われ、リクエストのOrigin/Refererヘッダーと照合されます。このキーはブラウザのソースに現れることを前提に設計されているためです。

レスポンスフィールド

ip
接続元クライアントのIPアドレス。
country, region, regionCode, city, postalCode, continent
おおよその位置情報。基盤となるエッジデータで解決できない場合はnullになります。
latitude, longitude
解決された位置のおおよその座標であり、デバイスやGPSの位置情報ではありません。
timezone
IANAタイムゾーン名、または利用できない場合はnull。
isEUCountry
真偽値。位置に基づくフラグであり、法的な判定ではありません。
asn, asOrganization
接続元ネットワークとその運営者。基盤となるデータで提供されている場合のみ値が入り、それ以外はnull。
currency, callingCode
解決された国に基づく地域的な文脈情報、またはnull。
locale, holidays, compliance, tax, ageVerification
オプションの派生エンリッチメントグループで、それぞれ個別にnullになりえます。いずれも法的・税務的・本人確認上の判定ではありません。
hostname
?include=hostnameでリクエストした場合のみ含まれる逆引きDNSルックアップの結果で、失敗した場合はnull。
security
含まれないプランでは完全に省略されます。含まれる場合:isTor、isVpn、isDatacenter、isThreat、isSanctionedNetwork—いずれもリストベースの指標です。IPv6のTor検出は現時点で実装されていません。falseは利用可能なデータの範囲内で一致がなかったことを意味し、リスクが存在しないことを意味するものではありません。

エラー

401
APIキーが欠落しているか無効です。
403
リクエストのOrigin/Refererがキーの許可オリジンリストにありません。このレスポンスにはCORSヘッダーも設定されないため、このJSON本文の内容にかかわらずブラウザがブロックします。
429
現在の固定1分間ウィンドウでレート制限を超えました。

例

リクエスト

curl https://api.watch-ip.com/v1/geo \
  -H "X-Api-Key: YOUR_PUBLISHABLE_KEY"

レスポンス—例示であり、フィールドはプランと利用可能なデータによって異なります

{
  "ip": "203.0.113.1",
  "country": "US",
  "region": "Texas",
  "regionCode": "TX",
  "city": "Austin",
  "postalCode": "78701",
  "latitude": 30.2672,
  "longitude": -97.7431,
  "continent": "NA",
  "timezone": "America/Chicago",
  "isEUCountry": false,
  "asn": 12345,
  "asOrganization": "Example ISP",
  "currency": { "code": "USD", "name": "US Dollar", "symbol": "$" },
  "callingCode": "+1"
}

制限

プランの月間リクエスト上限と1分あたりのレート制限が適用されます—料金をご覧ください。成功した呼び出しは1件ごとに1つのgeo利用イベントとして記録されます。

関連ページ