* API接口可能会因为各种网络原因和攻击都可能产生阻断，请开发时做好冗余和异常处理

* 当HTTP请求返回的状态码非200时，请做异常处理，比如 202 状态码造成的原因可能是无效Token、余额不足、格式错误

* 所有接口同时兼容IPv4和IPv6

iP查询接口文档说明

接口地址

http协议：
国内大陆优化（支持ipv6）http://api.ipshudi.com/ipdata/
国际各洲覆盖（部份ipv6）http://api.ip138.com/ipdata/

https协议：
国内大陆优化（支持ipv6）https://api.ipshudi.com/ipdata/
国际各洲覆盖（部份ipv6）https://api.ip138.com/ipdata/

请求方式

get

示例1（Linux命令行下执行）

参数说明:
1. ip string ip地址 例如 117.25.13.123（可选，默认为请求者iP）
2. datatype string txt|jsonp|xml（可选，默认为jsonp）
3. callback string 回调函数 当前参数仅为jsonp格式数据提供（可选，默认为空）
4. token string 购买服务后会提供（必填）

curl "https://api.ip138.com/ipdata/?ip=8.8.8.8&datatype=jsonp&callback=find" -H "token:cc87f3c77747bccbaaee35006da1ebb65e0bad57"

示例2（js引入推荐方案）

参数说明:
1. ip string ip地址 例如 117.25.13.123（可选，默认为请求者iP）
2. datatype string txt|jsonp|xml（可选，默认为jsonp）
3. callback string 回调函数 当前参数仅为jsonp格式数据提供（可选，默认为空）
4. sign string 签名验证 签名算法:md5("ip=" + ip + "&token=" + token)（必填）
5. oid string 购买服务后提供（必填）
6. mid string 购买服务后提供（必填）

https://api.ip138.com/ipdata/?ip=8.8.8.8&callback=find&oid={oid}&mid={mid}&sign=签名算法

示例3（为了您的token安全，请勿在前端代码中使用token，js引入请参考示例2）

参数说明:
1. ip string ip地址 例如 117.25.13.123（可选，默认为请求者iP）
2. datatype string txt|jsonp|xml（可选，默认为jsonp）
3. callback string 回调函数 当前参数仅为jsonp格式数据提供（可选，默认为空）
4. token string 购买服务后会提供（必填）

JSONP请求示例（IPv4）

https://api.ip138.com/ipdata/?ip=58.16.180.3&datatype=jsonp&token=cc87f3c77747bccbaaee35006da1ebb65e0bad57

JSONP返回示例（IPv4）

说明：ret 值为 ok 时 返回data查询结果数据 为err时返回msg错误信息

{
    "ret": "ok",          // ret 值为 ok 时 返回 data 数据 为err时返回msg数据
    "ip": "58.16.180.3",  // IPv4
    "data": [
        "中国",             // 国家（极少为空）
        "贵州",             // 省份/自治区/直辖市（少数为空）
        "安顺",             // 地级市（部份为空）
        "西秀",             // 区/县（部份为空）
        "联通",             // 运营商
        "561000",           // 邮政编码
        "0851",             // 地区区号
        "城域网"            // 网络类型（部份为空）
    ]
}

JSONP请求示例（IPv6）

http://api.ip138.com/ipdata/?ip=240e:398:1:90a0:585e:a0f6:97d3:bd5&datatype=jsonp&token=cc87f3c77747bccbaaee35006da1ebb65e0bad57

JSONP返回示例（IPv6）

说明：ret 值为 ok 时 返回data查询结果数据 为err时返回msg错误信息

{
    "ret": "ok",        // ret 值为 ok 时 返回 data 数据 为err时返回msg数据
    "ip": "240e:398:1:90a0:585e:a0f6:97d3:bd5",     // IPv6
    "data": [
        "中国",             // 国家（极少为空）
        "四川",             // 省份/自治区/直辖市（少数为空）
        "成都",             // 地级市（部份为空）
        "锦江",             // 区/县（部份为空）
        "电信",             // 运营商
        "610000",           // 邮政编码
        "028",              // 地区区号
        "城域网"            // 网络类型（部份为空）
    ]
}

XML返回示例

说明：ret 值为 ok 时 返回data查询结果数据 为err时返回msg错误信息

<xmlinfo>
  <ret>ok</ret>
  <ip>58.16.180.3</ip>
  <data>
   <country>中国</country>
   <region>贵州</region>
   <city>安顺</city>
   <district>西秀</district>
   <isp>联通</isp>
   <zip>561000</zip>
   <zone>0851</zone>
   <tag>城域网</tag>
  </data>
</xmlinfo>

文本格式返回示例

58.16.180.3 中国 贵州 安顺 西秀 联通 561000 0851

查询token使用情况

URL

https://api.ip138.com/status/

请求方式

get

参数

1. token `string` ip查询服务token

示例

https://api.ip138.com/status/?token=cc87f3c77747bccbaaee35006da1ebb65e0bad57

响应

{
    "ret":"ok",
    "data":{
        "reqs":10,   //当前小时请求数
        "hour":3000, //当前小时购买次数
        "package":19767 //配额次数
    }
}