API Reference

API 文档说明

查看接口地址、请求参数、返回参数和多语言代码示例。需要生成专属提取链接时，请返回提取 API 页面配置参数。

返回提取 API

API接口文档

通过API接口自动提取代理IP，简单快捷，支持多种协议和返回格式

接口地址

GET https://yuzhouip.com.cn/prod-api/extract/ip

请求方式：GET，支持 HTTP/HTTPS。type=0 返回 JSON，type=1 返回 TXT；province/city 使用行政区划编码，不是中文名

请求参数

参数名	必填	类型	说明
key	是	string	套餐 key（appKey），在提取API 页面选择套餐后自动带入
timeId	是	string	提取时效ID（durationConfigId）。按次/余额提取实际必传，缺失会返回 HTTP 500；页面按所选套餐或时效自动带入
protocol	是	int	代理协议：0=HTTP/HTTPS（默认），1=SOCKS5
count	是	int	提取数量，默认 1；页面限制 1-200
type	是	int	返回类型：0=JSON，1=TXT。缺省为 1；页面按「数据格式」显式传入
textSep	否	int	文本分隔符（仅 type=1 生效）：0=\r\n（默认），1=\r，2=\n，3=\t。页面生成链接时会固定带 0
isp	否	int	运营商：0=不限，1=电信，2=联通，3=移动。为 0 时页面不拼该参数
distinct	是	int	去重：0=不去重，1=当天去重。页面默认传 0
province	否	string	省份行政区划编码，如湖北=420000；多个用英文逗号分隔，如 420000,440000；不传表示不限。
city	否	string	城市行政区划编码，如武汉=420100；多个用英文逗号分隔，如 420100,420200；不传表示不限
os	否	int	返回出口 IP outIp：1=返回；页面默认不传
is	否	int	返回运营商 isp：1=返回；页面默认不传
cs	否	int	返回省市 pro/city：1=返回；页面默认不传
es	否	int	返回过期时间 expire/expireTimestamp：1=返回；页面默认不传
isAuth	是	boolean	账密认证：true=返回 username/password，false=仅返回 ip/port。提取页可切换，默认按套餐配置带入

提取 API 页面生成的链接默认包含 key、timeId、protocol、count、type、textSep、distinct、isAuth，并按需追加 isp、province、city。os/is/cs/es 为可选扩展字段，默认不传。

返回参数

字段	类型	说明
code	int	状态码，200 表示成功
msg	string	提示信息
data	array	IP 列表
data[].ip	string	代理IP地址
data[].port	int	代理端口
data[].username	string	代理账号（isAuth=true 时返回）
data[].password	string	代理密码（isAuth=true 时返回）
data[].outIp	string	出口IP（os=1 时返回）
data[].isp	string	运营商（is=1 时返回）
data[].pro	string	省份（cs=1 时返回）
data[].city	string	城市（cs=1 时返回）
data[].expire	string	过期时间（es=1 时返回）
data[].expireTimestamp	int64	过期时间戳，毫秒（es=1 时返回）

文本格式（type=1）：isAuth=true 返回账号:密码@IP:端口，否则返回 IP:端口。data[].username/password 仅在 isAuth=true 时出现。

代码示例

import requests

# key / timeId 在提取API 页面选择套餐后自动生成
# timeId 文档未单列，但余额/按次提取实际必传
URL = "https://yuzhouip.com.cn/prod-api/extract/ip"

def get_proxy():
    params = {
        "key": "YOUR_API_KEY",
        "timeId": "YOUR_TIME_ID",
        "protocol": 0,    # 0=HTTP/HTTPS 1=SOCKS5
        "count": 1,       # 提取数量，默认 1
        "type": 0,        # 0=JSON 1=TXT
        "textSep": 0,     # 仅TXT生效：0=\r\n 1=\r 2=\n 3=\t
        "distinct": 0,    # 0=不去重 1=当天去重
        "province": "420000",
        "city": "420100",
        "isAuth": "true",  # 账密认证：true 返回 username/password，false 仅返回 ip:port
    }
    resp = requests.get(URL, params=params, timeout=15)
    data = resp.json()
    if data.get("code") == 200 and data.get("data"):
        p = data["data"][0]
        if p.get("username"):
            return f"{p['username']}:{p['password']}@{p['ip']}:{p['port']}"
        return f"{p['ip']}:{p['port']}"
    return None

if __name__ == "__main__":
    print(get_proxy())