API Docs

• 返回访客公网 IP（Public Egress IP）。
• 响应格式为纯文本（text/plain），不包含 JSON 包装。
• 支持 IPv4 IPv6。
• Dual Stack 指同一入口可同时响应 IPv4 与 IPv6，请求最终返回值取决于客户端实际连通通道。

• Returns the visitor public IP address.
• Response format is plain text (text/plain) without JSON envelope.
• Supports IPv4 and IPv6.
• Dual Stack means one endpoint serves both IPv4 and IPv6; output depends on the client's active network path.

• https://ipwest.com (IPv4 + IPv6 Dual Stack)
• https://ipv4.ipwest.com (IPv4 only)
• https://ipv6.ipwest.com (IPv6 only)

curl 示例

curl ipwest.com
curl -4 ipwest.com
curl -6 ipwest.com
curl ipv4.ipwest.com
curl ipv6.ipwest.com

Linux shell 示例（变量赋值）

#!/bin/sh
ip="$(curl -fsS https://ipwest.com)"
echo "Current public IP: ${ip}"

Node.js

const res = await fetch('https://ipwest.com');
const ip = (await res.text()).trim();
console.log(ip);

Python

import requests
ip = requests.get('https://ipwest.com', timeout=5).text.strip()
print(ip)

PHP

<?php
$ip = trim(file_get_contents('https://ipwest.com'));
echo $ip;

• 返回值是访问者当前公网出口 IP，不是内网地址。
• 若客户端启用 VPN Proxy，返回对应出口节点 IP。
• 双栈环境中，结果取决于客户端实际请求走的 IPv4 或 IPv6 通道。
• 不建议对结果做长期缓存，建议按业务实时获取。

• DDNS 自动更新
• 服务器公网 IP 检测
• IPv6 连通性测试
• 自动防火墙白名单
• CI CD 出口确认

• 输出结构化 JSON，适合前端脚本直接消费。
• 成功响应仅包含一个字段：ip。
• 支持 callback 参数返回 JSONP。
• 返回值为访问者当前公网出口 IP。

• https://api.ipwest.com/jsonip (JSON)
• https://api.ipwest.com/jsonip?callback=getip (JSONP)

• 成功 JSON 响应固定为 {\"ip\":\"...\"}，不附加其它元字段。
• 未传 callback 时返回 application/json。
• 传 callback 时返回 application/javascript。
• callback 仅允许合法函数名。

• 用于获取 IP 地理位置与网络归属信息。
• 响应格式为 JSON（application/json）。
• 输出结构固定为 5 个顶层字段：ip、geo、network、flags、meta。
• 支持 IPv4 IPv6 Domain。
• 传入域名时，服务会先执行 DNS 解析，再返回解析到的 IP 信息。

GET https://api.ipwest.com/geoip/{target}

• {target} 支持 IPv4、IPv6 或域名 Domain。
• IPv4 示例：8.8.8.8
• IPv6 示例：2001:4860:4860::8888
• Domain 示例：example.com

• ip：目标 IP（由上游 query 映射而来）。
• geo：地理信息分组，包含 continent/country/country_code/region/region_name/city/zip/latitude/longitude/timezone。
• network：网络信息分组，包含 reverse/isp/org/as_name/asn/as_org。
• flags：属性标记分组，包含 hosting/proxy/mobile。
• meta：请求元信息分组，包含 source/requested_at/cached/cache_group/cache_saved_at/ok。
• 当 meta.ok=false 时，返回 meta.error.code 与 meta.error.message。

• 地理位置为 IP 归属地推断，不是精确定位。
• 域名查询会先进行 DNS 解析。
• 建议缓存 GeoIP 数据 7-30 天。
• 返回 Content-Type: application/json。
• 上游 status 字段不会透出，错误统一在 meta.error 返回。

• 访客地理展示
• 统计分析
• 基础风控
• 日志增强

为保证服务稳定性与公平使用，IP 与 GeoIP REST API 实施频率限制。

To ensure service stability and fair usage, rate limits are enforced on IP and GeoIP REST APIs.

• Plain Text IP: 60 requests / minute / IP
• GeoIP API: 30 requests / minute / IP

限流基于客户端公网 IP 计算。

Limits are enforced per client public IP.

当请求超过限制时，服务返回 HTTP 429 Too Many Requests。

HTTP 429 Too Many Requests

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please slow down."
  }
}

• X-RateLimit-Limit：当前窗口允许的请求总量。
• X-RateLimit-Remaining：当前窗口剩余可用请求数。
• X-RateLimit-Reset：限流窗口重置时间戳（或秒数）。

• 建议缓存结果，尤其是 GeoIP 数据。
• 禁止滥用、扫描与高频非正常请求。
• 违规访问可能触发临时或长期封禁。

错误返回采用 HTTP 状态码 + JSON 错误对象。

Error responses use HTTP status codes plus JSON error object.

400 示例

400 Example

{
  "error": {
    "code": "INVALID_TARGET",
    "message": "Target must be a valid IPv4, IPv6, or domain."
  }
}

429 示例

429 Example

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please slow down."
  }
}

• Plain Text 接口发生错误时可仅返回 HTTP 状态码与纯文本。
• GeoIP 接口错误返回 JSON 错误对象。
• 错误响应不暴露内部实现细节。