OpenIPApi

公式 OpenIPApi SDK

JavaScript、Python、PHP 向けの軽量な公式クライアントをダウンロードできます。

すべての SDK は同じ REST API(https://api.openipapi.com)を対象とし、X-API-Key ヘッダーで認証を行い、同じメソッドを公開します:lookup(ip)me()batch(ips)asn(asn)validate(ip)

JavaScript / TypeScript

ダウンロード: openipapi.js

インストール / 使用

ファイルをプロジェクトにドロップ(またはブラウザで /sdk/javascript/openipapi.js から直接インポート)してください。最新のブラウザと Node.js 18+ で動作します。ビルド手順やサードパーティ依存関係は不要です。

エンドポイント互換性

5 つの REST エンドポイントすべて:lookup、me、batch、asn、validate。プラン制限のあるエンドポイントは、引き続き API キーに該当するプランが必要です。

import { OpenIPApi } from '/sdk/javascript/openipapi.js';

const client = new OpenIPApi('YOUR_KEY');
const data = await client.lookup('8.8.8.8');
console.log(data.threat?.is_vpn);

// Batch lookup
const batch = await client.batch(['8.8.8.8', '1.1.1.1']);

インストール / 使用

ファイルをプロジェクトにドロップしてインポートしてください。Python 3.8+。標準ライブラリ(urllib)のみを使用します。

エンドポイント互換性

5 つの REST エンドポイントすべて:lookup、me、batch、asn、validate。プラン制限のあるエンドポイントは、引き続き API キーに該当するプランが必要です。

from openipapi import OpenIPApi

client = OpenIPApi("YOUR_KEY")
data = client.lookup("8.8.8.8")
print(data.get("threat", {}).get("is_vpn"))

# Batch lookup
batch = client.batch(["8.8.8.8", "1.1.1.1"])

インストール / 使用

ファイルをプロジェクトにドロップして require してください。PHP 8.0+。利用可能な場合は curl を使用し、ストリームコンテキストへのフォールバックも備えています。Composer は不要です。

エンドポイント互換性

5 つの REST エンドポイントすべて:lookup、me、batch、asn、validate。プラン制限のあるエンドポイントは、引き続き API キーに該当するプランが必要です。

require __DIR__ . '/OpenIPApiClient.php';

$client = new OpenIPApiClient('YOUR_KEY');
$data = $client->lookup('8.8.8.8');
echo !empty($data['threat']['is_vpn']) ? 'yes' : 'no';

// Batch lookup
$batch = $client->batch(['8.8.8.8', '1.1.1.1']);

直接 HTTP フォールバック

OpenIPApi の使用に SDK は必要ありません。API はシンプルな REST + JSON レイヤーであり、任意の HTTP クライアントで動作します:

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

npm、PyPI、Packagist のパッケージレジストリ版は後日追加される可能性があります。