API ドキュメント

認証

すべての API リクエストには、 X-API-Key リクエストヘッダーに API キーを含める必要があります。API キーは コンソール.

X-API-Key: oip_your_api_key_here

ベース URL

すべての API リクエストは HTTPS で以下のベース URL に送信されます：

https://api.openipapi.com

機械可読仕様 (OpenAPI 3.1): /openapi.yaml.

レスポンス形式

すべてのレスポンスは JSON 形式です。成功レスポンスは HTTP 200. を返します。エラーレスポンスは適切な 4xx または 5xx ステータスコードと error フィールドを返します。

{
  "error": "invalid_api_key",
  "message": "The provided API key is invalid or has been revoked.",
  "status": 401
}

GET /v1/lookup/{ip}

単一の IP アドレスのジオロケーション、ネットワーク、脅威データを検索します。

パラメータ

レスポンスフィールド

リクエスト例

$ curl https://api.openipapi.com/v1/lookup/185.220.101.45 \
     -H "X-API-Key: oip_your_api_key_here"

レスポンス例

{
  "ip": "185.220.101.45",
  "type": "IPv4",
  "geo": {
    "country_code": "DE",
    "country": "Germany",
    "region": "Hessen",
    "region_code": "HE",
    "city": "Frankfurt am Main",
    "postal_code": "60313",
    "latitude": 50.1109,
    "longitude": 8.6821,
    "timezone": "Europe/Berlin",
    "is_sanctioned": false,
    "sanction_lists": []
  },
  "network": {
    "asn": 205100,
    "as_name": "F3 Netze e.V.",
    "as_domain": "f3netze.de",
    "isp": "F3 Netze",
    "organization": "F3 Netze e.V.",
    "connection_type": "datacenter"
  },
  "threat": {
    "is_vpn": true,
    "is_proxy": false,
    "is_tor": true,
    "is_relay": false,
    "is_hosting": true,
    "threat_score": 85,
    "threat_categories": ["tor_exit_node", "known_abuser"],
    "bot_type": null
  },
  "abuse": {
    "contact_email": "abuse@f3netze.de"
  }
}

POST /v1/lookup/batch

1 回のリクエストで複数の IP アドレスを検索します。バッチサイズの制限はプランによって異なります。

バッチサイズ制限

リクエストボディ

{
  "ips": [
    "185.220.101.45",
    "8.8.8.8",
    "1.1.1.1"
  ]
}

レスポンス

リクエストと同じ順序で、完全なルックアップオブジェクトのラップされた配列を返します。

{
  "results": [
    { "ip": "185.220.101.45", /* full lookup object */ },
    { "ip": "8.8.8.8",          /* full lookup object */ },
    { "ip": "1.1.1.1",          /* full lookup object */ }
  ],
  "count": 3
}

GET /v1/me

リクエストを行っている IP アドレスのジオロケーションと脅威データを返します。「自分の IP は何か」機能に便利です。

レスポンスは GET /v1/lookup/{ip} 呼び出し元の IP が事前入力されたものと同一です。

$ curl https://api.openipapi.com/v1/me \
     -H "X-API-Key: oip_your_api_key_here"

GET /v1/asn/{asn}

自律システム番号の詳細情報を取得します。Starter プラン以上が必要です。

asn パラメータは 13335 と AS13335 形式の両方を受け付けます。

$ curl https://api.openipapi.com/v1/asn/13335 \
     -H "X-API-Key: oip_your_api_key_here"

レスポンス例

{
  "asn": 13335,
  "as_name": "Cloudflare, Inc.",
  "as_domain": "cloudflare.com",
  "organization": "Cloudflare, Inc.",
  "country_code": "US",
  "ip_ranges_count": 1284,
  "total_ips": 2359296
}

GET /v1/validate/{ip}

IP アドレスを検証してタイプを判定します。ルックアップクォータを消費しません。

Example response

{
  "ip": "185.220.101.45",
  "valid": true,
  "type": "IPv4",
  "private": false,
  "bogon": false
}

GET /v1/fraud/{ip}

リスクレベルと実用的な推奨アクションを含む複合不正スコア（0〜100）。VPN・プロキシ・Tor・データセンター・過去の不正利用シグナルを統合します。 Starter プラン以上

Example response

{
  "ip": "185.220.101.45",
  "fraud_score": 92,
  "risk_level": "critical",
  "signals": {
    "is_vpn": true,
    "is_proxy": false,
    "is_tor": true,
    "is_datacenter": true,
    "is_known_attacker": true,
    "high_risk_country": false
  },
  "recommendation": "block"
}

リスクレベルと推奨アクション

GET /v1/probe/{ip}

60 以上のアクティブプローブノードからのリアルタイムネットワークプローブデータ：開放 TCP ポート、サービスバナー、リバース DNS、TLS 証明書の完全な詳細（サブジェクト、発行者、SAN、有効期限）、検出されたサービスカテゴリ。 Pro プラン以上

仕組み

• · 新鮮なデータ（7 日以内）： キャッシュからすぐに返されます。
• · 古いデータ（7 日超）： すぐに返されますが、バックグラウンドで再プローブがキューに追加されます。レスポンスには "stale": true.
• · 未プローブ： 即時スキャンのためにプローブがキューに追加されます。最初の結果は通常 1〜5 分以内に届きます。
• · プローブクォータは月間ルックアップクォータの 10% です。プライベート／予約済み IP はプローブできません。

Example response

{
  "ip": "185.220.101.45",
  "reachable": true,
  "last_probed": "2026-04-18T14:23:11+00:00",
  "age_hours": 2.3,
  "stale": false,
  "refresh_queued": false,
  "probe_count_24h": 14,
  "probed_from_nodes": 8,
  "open_ports": [
    { "port": 22,   "service": "ssh",       "banner": "SSH-2.0-OpenSSH_8.9p1" },
    { "port": 80,   "service": "http",      "banner": "nginx/1.24.0" },
    { "port": 443,  "service": "https",     "banner": null },
    { "port": 9001, "service": "tor-relay", "banner": null }
  ],
  "reverse_dns": "tor-exit.f3netze.de",
  "tls": {
    "subject_cn":  "*.f3netze.de",
    "issuer":      "Let's Encrypt",
    "valid_from":  "2026-02-10T00:00:00Z",
    "valid_to":    "2026-05-10T00:00:00Z",
    "sans":        ["f3netze.de", "*.f3netze.de"],
    "fingerprint": "7e:4f:...:b2:e1"
  },
  "banners": {
    "22": "SSH-2.0-OpenSSH_8.9p1",
    "80": "nginx/1.24.0"
  },
  "detected_services": {
    "is_tor_relay":  true,
    "is_ssh_open":   true,
    "is_web_server": true,
    "is_vpn":        false,
    "is_proxy":      false
  }
}

スキャン対象ポート

22 (ssh), 80 / 8080 (http), 443 / 8443 (https), 1080 (socks5), 3128 / 8888 (http-proxy), 9001 / 9030 (tor-relay / tor-dir), 9050 / 9150 (tor-socks), 1194 (openvpn), 4500 (ipsec-nat-t), 51820 (wireguard).

ユースケース

• · アンチフロード — 同一の SSH バージョン／TLS フィンガープリントを持つボットファームを検出
• · 脅威インテル — バナー／証明書の変更を C2 サーバーで監視
• · OSINT／バグバウンティ — 任意のパブリック IP のサービスを素早く列挙
• · ホスティング／ISP オペレーション — ネットワーク内のオープンプロキシ／Tor 出口を検出

GET /v1/proxy-attribution/{ip}

IP が既知のレジデンシャルプロキシプール、商用 VPN、またはデータセンターレンジに属しているかどうかを識別します。一般的な is_proxy フラグとは異なり、このエンドポイントは IP を特定のプロバイダー（Bright Data、Oxylabs、NordVPN など）に帰属させます。特定のプロバイダーを許可・ブロックする必要がある不正対策チームにとって重要です。 プロキシインテルアドオン

レスポンス例（VPN レンジの IP）

{
  "ip": "2.56.16.42",
  "detected": true,
  "primary_provider": {
    "provider":     "unknown_vpn",
    "display_name": "Unknown VPN",
    "network_type": "vpn",
    "confidence":   0.75
  },
  "networks": [
    {
      "provider":    "unknown_vpn",
      "network_type": "vpn",
      "confidence":   0.75,
      "source":       "x4bnet-vpn",
      "cidr":         "2.56.16.0/22"
    },
    {
      "provider":    "unknown_datacenter",
      "network_type": "datacenter",
      "confidence":   0.75,
      "source":       "x4bnet-datacenter"
    }
  ],
  "recommendation": "treat_as_vpn"
}

ネットワークタイプ

• · residential — レジデンシャルプロキシプール（Bright Data、Oxylabs、Smartproxy、IPRoyal、Hola、Honeygain、EarnApp、Peer2Profit、SOAX）
• · vpn — 商用 VPN プロバイダー（NordVPN、ExpressVPN、Surfshark、Mullvad、ProtonVPN、PIA、IPVanish、CyberGhost）
• · datacenter — 商用プロキシ出口に頻繁に使用されるホスティングプロバイダー（AWS、DigitalOcean、OVH、Hetzner など）
• · tor — Tor 出口／リレーノード
• · mobile — モバイルキャリアプロキシプール

推奨アクション

GET /v1/account/usage

アカウントの現在の請求期間の使用統計を返します。

Example response

{
  "plan": "Pro",
  "period_start": "2026-03-01",
  "period_end": "2026-03-31",
  "lookups_used": 184320,
  "lookups_limit": 500000,
  "lookups_remaining": 315680,
  "reset_at": "2026-04-01T00:00:00Z"
}

GET /v1/database/list

プランで利用可能な MMDB データベースをリスト表示します。MaxMind .mmdb のオフライン／エッジ用ドロップイン代替品 — 任意の MaxMind DB リーダー（PHP、Go、Python、Node.js、Rust、Java）で動作します。

Example response

{
  "plan": "Business",
  "sources": [
    {
      "source": "country",
      "filename": "geo-whois-asn-country.mmdb",
      "size_bytes": 8225621,
      "updated_at": "2026-04-18T02:00:00+00:00",
      "etag": "\"fa2b851f9155838b\"",
      "download_url": "https://api.openipapi.com/v1/database/download/country"
    }
  ]
}

GET /v1/database/download/{source}

生の MMDB ファイルをストリーミングします。 ETag + If-None-Match 条件付き GET（ファイルが変更されていない場合は 304 Not Modified）をサポートします。レート制限：1 ソースあたり 1 日 10 ダウンロード。

利用可能なソース

例：PHP でのダウンロードと使用

# Download latest MMDB
$ curl -H "X-API-Key: YOUR_KEY" \
    -o asn.mmdb \
    https://api.openipapi.com/v1/database/download/asn

# Use with maxmind-db/reader
$ composer require maxmind-db/reader

<?php
use MaxMind\Db\Reader;
$reader = new Reader('asn.mmdb');
$record = $reader->get('8.8.8.8');
// ['autonomous_system_number' => 15169,
//  'autonomous_system_organization' => 'Google LLC']

制裁フラグ

すべての /v1/lookup レスポンスには geo ブロック内に 2 つのフィールドが含まれており、IP の国が国際制裁の対象かどうかを示します。

対象制裁リスト：OFAC（米国）、EU、国連安全保障理事会、英国 OFSI。現在フラグが立てられている国には、イラン、北朝鮮、ロシア、ベラルーシ、シリア、キューバ、ベネズエラ、スーダンなどが含まれます。リストはプログラムの変更に応じて維持・更新されます。

制裁対象国の例

"geo": {
  "country_code": "IR",
  "country": "Iran",
  ...
  "is_sanctioned": true,
  "sanction_lists": ["OFAC", "EU", "UN"]
}

ボット検出

OpenIPApi は 二重逆引き DNS 検証 を実行して正規のクローラーを識別します。結果はすべてのルックアップで threat.bot_type で利用できます。

検証方法：(1) IP の PTR ルックアップ → ホスト名。(2) ホスト名はボットのドメインパターンと一致する必要があります（例： *.googlebot.com). (3) ホスト名の正引き DNS が元の IP に解決される必要があります。結果は 24 時間キャッシュされます。

検証済み Googlebot の例

"threat": {
  "is_vpn": false,
  "is_proxy": false,
  "is_tor": false,
  "threat_score": 0,
  "bot_type": "googlebot"
}

履歴ルックアップ

任意の単一 IP ルックアップに ?date=YYYY-MM-DD パラメータを追加して、その日付のスナップショットを取得します。

リクエスト例

$ curl "https://api.openipapi.com/v1/lookup/185.220.101.45?date=2026-01-15" \
     -H "X-API-Key: oip_your_api_key_here"

レスポンスエンベロープ

{
  "ip": "185.220.101.45",
  "snapshot_date": "2026-01-15",
  "is_historical": true,
  "data": {
    /* standard lookup response */
  }
}

エラー：スナップショットなし

{
  "error": "No historical snapshot available for this IP on 2026-01-15",
  "code": "no_snapshot"
}

エラーコード

レート制限

月間ルックアップクォータに加え、リクエストはスライディングウィンドウを使用して API キーごとにレート制限されます。超過した場合、API は HTTP 429 と Retry-After ヘッダーを返します。

追加制限： /v1/validate （未認証）は呼び出し元 IP ごとに 60 req/分に制限； /v1/me 30 req/分に制限。MMDB ダウンロードはアカウントごとにソースあたり 1 日 10 件に制限。レート制限レスポンスには Retry-After.

Webhook

Webhook を使用すると、監視している IP のステータスが変化したときにリアルタイムの HTTP POST 通知を受け取ることができます。 の コンソール → Webhook, またはダッシュボード UI で設定できます。API 呼び出しは不要です。

イベント

リクエストヘッダー

POST https://your-endpoint.example.com/webhook
Content-Type: application/json
User-Agent: OpenIPApi-Webhook/1.0
X-OpenIPApi-Event: high_threat
X-OpenIPApi-Signature: sha256=8c7f1a...b2e

ペイロード例

{
  "event": "high_threat",
  "delivered_at": "2026-04-18T12:34:56Z",
  "webhook_id": 142,
  "data": {
    "ip": "185.220.101.45",
    "threat_score": 92,
    "previous_score": 45,
    "is_tor": true,
    "is_vpn": true
  }
}

署名の検証

すべての Webhook は、Webhook シークレットを使用した生の JSON ボディの HMAC-SHA256 で署名されています。署名は X-OpenIPApi-Signature ヘッダーで sha256=<hex>. として送信されます。ペイロードに対してアクションを実行する前に必ず検証してください：

$body = file_get_contents('php://input');
$hdr  = $_SERVER['HTTP_X_OPENIPAPI_SIGNATURE'] ?? '';
$expected = 'sha256=' . hash_hmac(
    'sha256', $body, $webhookSecret
);
if (!hash_equals($expected, $hdr)) {
    http_response_code(401);
    exit;
}
// Safe to process $body now

const crypto = require('crypto');

app.post('/webhook',
  express.raw({ type: 'application/json' }),
  (req, res) => {
    const hdr = req.headers['x-openipapi-signature'];
    const expected = 'sha256=' + crypto
      .createHmac('sha256', process.env.WEBHOOK_SECRET)
      .update(req.body).digest('hex');
    if (expected !== hdr) return res.status(401).end();
    // Process JSON.parse(req.body)
  });

リトライポリシー

エンドポイントは受信確認として 10 秒以内に HTTP 2xx で応答する必要があります。その他のステータス（またはタイムアウト）は指数バックオフリトライをトリガーします：1 分、5 分、30 分、2 時間、12 時間。最終試行後、Webhook は失敗としてマークされ、ダッシュボードアラートが発生します。

配信履歴とリプレイ

コンソール → Webhook はアカウントごとに最新 100 件の配信試行を保持し、イベントタイプ、HTTP ステータスコード、エンドポイントが返したレスポンスボディを表示します。 リプレイ 以前の任意の配信を再送して元の署名済みペイロードを再送信し、組み込みの 署名デバッガー を使用してシークレットをサーバーと共有することなくブラウザ側で HMAC-SHA256 署名を検証できます。

リプレイされた配信には追加の X-OpenIPApi-Replay: 1 ヘッダーが含まれているため、エンドポイントはライブイベントと区別できます。

コードサンプル — curl

単一ルックアップ

$ curl https://api.openipapi.com/v1/lookup/8.8.8.8 \
     -H "X-API-Key: oip_your_api_key_here"

バッチルックアップ

$ curl -X POST https://api.openipapi.com/v1/lookup/batch \
     -H "X-API-Key: oip_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{"ips": ["8.8.8.8", "1.1.1.1", "185.220.101.45"]}'

自分の IP

$ curl https://api.openipapi.com/v1/me \
     -H "X-API-Key: oip_your_api_key_here"

コードサンプル — JavaScript

単一ルックアップ（fetch）

const response = await fetch('https://api.openipapi.com/v1/lookup/8.8.8.8', {
  headers: {
    'X-API-Key': 'oip_your_api_key_here'
  }
});

const data = await response.json();
console.log(data.geo.country);       // "United States"
console.log(data.threat.is_vpn);     // false
console.log(data.threat.threat_score); // 0

バッチルックアップ

const response = await fetch('https://api.openipapi.com/v1/lookup/batch', {
  method: 'POST',
  headers: {
    'X-API-Key': 'oip_your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ips: ['8.8.8.8', '1.1.1.1', '185.220.101.45']
  })
});

const { results } = await response.json();
for (const info of results) {
  console.log(info.ip, info.geo.city, info.threat.threat_score);
}

コードサンプル — Python

単一ルックアップ（requests）

import requests

API_KEY = "oip_your_api_key_here"
headers = {"X-API-Key": API_KEY}

r = requests.get(
    "https://api.openipapi.com/v1/lookup/8.8.8.8",
    headers=headers
)
r.raise_for_status()
data = r.json()

print(data["geo"]["country"])       # United States
print(data["threat"]["is_vpn"])     # False
print(data["threat"]["threat_score"]) # 0

バッチルックアップ

import requests

API_KEY = "oip_your_api_key_here"
headers = {
    "X-API-Key": API_KEY,
    "Content-Type": "application/json"
}

payload = {
    "ips": ["8.8.8.8", "1.1.1.1", "185.220.101.45"]
}

r = requests.post(
    "https://api.openipapi.com/v1/lookup/batch",
    json=payload,
    headers=headers
)
r.raise_for_status()

for info in r.json()["results"]:
    print(info["ip"], info["geo"]["city"], info["threat"]["threat_score"])