Insight API

版本: 1.0.0

网站: https://api.checkip.com/insight-api

Swagger-UI: https://api.checkip.com/doc/swagger.html

关于

Insight API提供REST API以访问IP洞察数据。

快速开始

无需了解任何细节即可快速使用。

请求:

curl -H "Token: {{token}}" "https://api.checkip.com/v1/insight/IP_ADDRESS"

响应:

ip              查询的IP地址
as              自治系统详情
ip_label        IP基础设施分类
location        IP定位信息
risks           有关此IP的风险和威胁
services        此IP被哪些服务所使用(比如 BrightData)

鉴权

作为您部署(或试用)的一部分,您会收到一个Token,或是用仪表盘生成一个。通过在HTTP头中传递您的Token来执行API服务的认证。例如,使用cURL工具,一个经过认证的请求看起来像

curl -H "Token: {{token}}" "https://api.checkip.com/v1/insight/IP_ADDRESS"

响应

API将始终在响应头中返回有关您账户的信息:

x-Credit-Remaining: 您账户剩余的查询额度
X-Current-Product: 您当前的产品名称

提示: 您也可以使用 status 接口查看额度信息

API将返回一个带有code的JSON对象:

200: 请求成功
400: 提供了错误的输入,IP必须是公共IPv4或IPv6地址
401: 未经授权,您的Token可能无效
403: 您的账户没有足够的额度来执行此操作
404: 提供的IP地址未找到或不可用
429: 您已达到速率限制
500: 发生了一些错误

接口

GET /v1/insight/:IP

通过IPv4或IPv6地址检索IP洞察对象。IP洞察对象总结了关于查询IP地址的所有可用信息。如果某些字段不可用,将被排除。

查询:

curl -H "Token: {{token}}" "https://api.checkip.com/v1/insight/IP_ADDRESS"

响应示例:

{
   "code":200,
   "data":{
      "ip":"27.131.249.86",
      "as":{
         "number":45700,
         "organization":"PT. NAP Info Lintas Nusa"
      },
      "ip_label":"cellular",
      "location":{
         "country_code":"ID",
         "country":"Indonesia",
         "state":"Jakarta",
         "city":"Jakarta"
      },
      "risks":[
         "Residential Proxy"
      ],
      "services":[
         "dataimpulse",
         "geonode",
         "oxylabs",
         "smartproxy"
      ]
   },
   "message":"success"
}

GET /v1/status

查询您的API令牌状态、您的剩余查询次数和您的产品名称。

查询:

curl -H "Token: {{token}}" "https://api.checkip.com/v1/status"

响应示例:

{
  "code": 200,
  "data": {
    "product_name": "Trial",
    "credit_remaining": 10
  },
  "message": "success"
}