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+。无需构建步骤,无第三方依赖。
端点兼容性
全部五个 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
下载: openipapi.py安装 / 使用
将文件放入你的项目并导入。Python 3.8+。仅使用标准库(urllib)。
端点兼容性
全部五个 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,否则使用 stream-context 作为兼容方案。无需 Composer。
端点兼容性
全部五个 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 上的包注册表版本将在后续添加。