API Documentation | OwlProxy API

Introduction

This document provides detailed API descriptions, syntax, parameter explanations, and examples, allowing you to manage cloud phone service resources through API calls.

OpenAPI Interface List

Static IP service

Obtain-the-proxy-type

Interface address

/owlproxy/api/openApi/vcProxyShop/getProxyTypeList

Request method

GET

Request data type

application/json

Request Query params

Parameter Name	Example Value	Type	Description
proxyMode	1	Integer	1 = Static 2 = Dynamic 3 = Mobile proxy If omitted, returns all types

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data		Object[]
├─id	1	Long	Type ID
├─typeName	静态IPV6/32代理	String	Type Name
├─typeIllustrate	更纯净的代理地址，高隐蔽性、高性价比，适用于部分平台	String	Description

Response example

{
    "msg": "success",
        "code": 200,
        "data": [
        {
            "defSelected": 0,
            "typeName": "静态IPV6/32代理",
            "typeIllustrate": "更纯净的代理地址，高隐蔽性、高性价比，适用于部分平台",
            "typeMarkColor": "",
            "id": 4,
            "sort": 1,
            "typeMark": ""
        }
    ],
        "ts": 1751179652664
}

Get-Static-IP-Regions

Interface address

/owlproxy/api/openApi/vcProxyGood/getProxyCountry

Request method

GET

Request data type

application/json

Request Query params

Parameter Name	Example Value	Parameter Type	Parameter Description
proxyType	1	Integer	Proxy type

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data		Object[]	Status code
├─countryCode	US	String	Regional code
├─countryName	美国	String	Regional Name

请求示例

?proxyType=4

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "countryCode": "US",
            "countryName": "美国"
        },
    ],
    "ts": 1749808527634
}

Obtain-the-option-for-static-IP-quality

Interface address

/owlproxy/api/openApi/vcProxyGood/proxyIdType

Request method

GET

Request data type

application/json

Request Query params

Parameter Name	Example Value	Parameter Type	Parameter Description
proxyType	2	Integer	Proxy type

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data		Object[]
├─msg	IP净度高，满足大部分场景需求	String	Description
├─name	普通	String	name
├─proxyIdType	ord	String	type

Request Example

?proxyType=4

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "countryCode": "US",
            "countryName": "美国"
        },
    ],
    "ts": 1749808527634
}

Obtain-static-IP-service-provider

Interface address

/owlproxy/api/openApi/vcProxyShop/getProxyShopList

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Required
countryCode	US	String	Regional code
proxyType	4	String	Proxy type
proxyIdType	ord	String	IP quality

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data		Object[]
├─proxyMaxNum	3	Integer	The maximum number of ips that can be purchased at a time
├─proxyName	A区	String	Name of Service provider
├─icon		String	Icon address
├─proxySort	1	Integer	sort
├─proxyId	2	Integer	Service Provider ID

Request Example

{
    "countryCode": "US"
}

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "proxyMaxNum": 100,
            "proxyName": "A区",
            "icon": "https://file.owlproxy.com/upload/880d10ccc89f3371b9274aed7f6ca139.png",
            "proxySort": 1,
            "proxyId": 2
        },
        {
            "proxyMaxNum": 3,
            "proxyName": "B区",
            "icon": "https://file.vmoscp.com/agent/mallApp/icon/proxyline-icon.png",
            "proxySort": 2,
            "proxyId": 1
        }
    ],
    "ts": 1749809117448
}

Obtain-the-static-IP-package

Interface address

/owlproxy/api/openApi/vcProxyGood/proxyGoodList

Request method

GET

Request data type

application/json

Request Query params

Parameter Name	Example Value	Parameter Type	Parameter Description
proxyShopId	1	Integer	Service Provider ID
countryCode	US	Integer	Region
proxyType	2	Integer	Proxy type
proxyIdType	ord	String	IP quality

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data		Object[]
├─proxyGoodName	1天	String	Package name
├─proxyGoodId	5	Integer	Package ID
├─proxyGoodOldPrice	69	Integer	Original price
├─proxyGoodTime	1440	String	Package time (minutes)
├─proxyGoodPrice	61	Integer	Package price
├─proxyGoodreNewalFee	61	Integer	Renewal price
├─proxyGoodType	2	Integer	Service Provider ID
├─autoRenew	true	Boolean	Whether automatic renewal is supported

Request Example

?proxyShopId=2

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "proxyGoodName": "1天",
            "proxyGoodId": 5,
            "proxyGoodOldPrice": 69,
            "updateTime": 1749473960000,
            "proxyGoodTime": 1440,
            "proxyGoodRemark": "88折",
            "proxyGoodType": 2,
            "createTime": 1728889525000,
            "proxyGoodreNewalFee": 61,
            "autoRenew": true,
            "proxyGoodPrice": 61
        }
    ],
    "ts": 1749901953306
}

Purchase-Static-IP-Package

Interface address

/owlproxy/api/openApi/vcProxyGood/createProxyOrder

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
proxyGoodId	1	Integer	Package ID
num	1	Integer	Quantity
country	US	String	Region
proxyShopId	1	Integer	Service Provider ID
autoRenew	false	Integer	Automatic renewal is: true; no: false
backUrl	"http://localhost:8080/callback"	String	回调URL

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp

Request Example

{
    "proxyGoodId": 1, 
    "num": 1,
    "country": "US", 
    "proxyShopId": 1,
    "autoRenew": false
}

Response example

{
    "msg": "success",
    "code": 200,
    "ts": 1745823575860
}

Get IP Information by Order ID

Interface Endpoint

/owlproxy/api/openApi/vcProxy/queryByorderIdList

Request Content-Type

application/json

Request Body Parameters

Parameter Name	Example Value	Type	Description
orderIds	["Owl-PROXY176881932132132132132213"]	JSONArray / String[]	List of order IDs to query (supports batch query)

Response Parameters

Parameter Name	Example Value	Type	Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1768879288540	Integer	Timestamp (milliseconds)
data		Object[]	List of proxy order data
├─ orderAmount	175	Integer	Order amount
├─ orderId	Owl-PROXY176881923201484268	String	Order ID
├─ proxyInfoList		Object[]	List of proxy information under this order
│ ├─ ip	45.196.253.34	String	Proxy IP address
│ ├─ port	9481	Integer	Proxy port
│ ├─ username	T5c2u2E2z0o5	String	Proxy username
│ ├─ password	H6k9o5N1J7f5	String	Proxy password
│ ├─ expireTime	2026-02-19 14:13:33	String	Proxy expireTime

Request Example

{
  "orderIds": [
    "Owl-PROXY176881232321321312",
    "Owl-PROXY1768819212323132"
  ]
}

Response Example

{
    "msg"
:
    "success",
        "code"
:
    200,
        "data"
:
    [
        {
            "orderAmount": 175,
            "orderId": "Owl-PROXY176881232321321312",
            "proxyInfoList": [
                {
                    "orderId": "Owl-PROXY176881232321321312",
                    "orderAmount": 175,
                    "ip": "45.196.233.11",
                    "port": 1231,
                    "username": "T5c2u2E23213",
                    "password": "H6k9o5N32133"
                }
            ]
        },
        {
            "orderAmount": 175,
            "orderId": "Owl-PROXY1768819212323132",
            "proxyInfoList": [
                {
                    "orderId": "Owl-PROXY1768819212323132",
                    "orderAmount": 175,
                    "ip": "45.196.123.123",
                    "port": 1231,
                    "username": "H5L6q8b12321",
                    "password": "w5X8w1232131"
                }
            ]
        }
    ],
        "ts"
:
    1768879288540
    /* 2026-01-20 11:21:28 */
}

Get-Static-IP-List

Interface address

/owlproxy/api/openApi/vcProxy/queryList

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
current	1	Integer	Current page
size	10	Integer	Page size
proxyName	129	String	Remarks
proxyBuyStatusId	1	Integer	Status about to expire: 1. Expired: 2. Normal: 3

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ total	10	Integer	Total number of records
├─ pages	10	Integer	Total number of pages
├─ records		Object[]	Record list
│ ├─ proxyId	1	Integer	id
│ ├─ proxyName	1	String	Remarks
│ ├─ proxyGoodId	1	Integer	Package ID
│ ├─ shopName	B区	String	Service provider
│ ├─ proxyPort	63999	Integer	port
│ ├─ account	*****	String	Account number
│ ├─ password	*****	String	Password
│ ├─ modifyTime	1749909233000	Timestamp	Modify the time
│ ├─ expectedExpireTime	1749909233000	Timestamp	Expiration time
│ ├─ proxyBuyStatusId	1749909233000	Timestamp	Status
│ ├─ proxyHost	45.193.43.243	String	Host
│ ├─ renewGood	false	Boolean	Whether to renew automatically
│ ├─ autoRenewGoodId	1	Integer	Automatic renewal Package ID
│ ├─ proxyHttpPort	7778	Integer	Htt port

Request Example

{
    "current": 1,
    "size": 20,
    "proxyName": "",
    "proxyBuyStatusId": "" 
}

Response example

{
    "msg": "success",
    "code": 200,
    "data": {
        "current": 1,
        "total": 3,
        "pages": 1,
        "optimizeCountSql": true,
        "size": 20,
        "records": [
            {
                "proxyGoodId": 1,
                "proxyName": "45.192.43.243",
                "shopName": "B区",
                "password": "NedyYDqp",
                "modifyTime": 1749909233000,
                "expectedExpireTime": 1751199998,
                "proxyShopId": 1,
                "proxyBuyStatusId": 3,
                "proxyType": 1,
                "autoRenewGoodId": 1,
                "proxyHost": "45.192.128.243",
                "userId": 997875,
                "proxyBuyStatus": "正常",
                "proxyHttpPort": 7778,
                "renewGood": false,
                "proxyCountry": "US",
                "expireTime": 1751199998,
                "createTime": 1749903999000,
                "account": "**********",
                "proxyId": 93847
            }
        ],
        "searchCount": true,
        "orders": []
    },
    "ts": 1749955326816
}

Modify-Static-IP-Remarks

Interface address

/owlproxy/api/openApi/vcProxy/updateProxyName

Request method

GET

Request data type

application/json

Request Query params

Parameter Name	Example Value	Parameter Type	Parameter Description
proxyName	1	String	Remarks
proxyId	1	Integer	The id of the static ip

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp

Request Example

?proxyName=45.192.43.243&proxyId=93847

Response example

{
    "msg": "success",
    "code": 200,
    "ts": 1749955342960
}

Renew-Static-IP

Interface address

/owlproxy/api/openApi/vcProxyGood/createRenewProxyOrder

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
proxyGoodId	1	Integer	Package ID
proxyShopId	1	Integer	Service Provider ID
proxyIps	45.192.43.243	String	Renewal IP
backurl	"http://localhost:8080/callback"	String	回调URL

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp

Request Example

{
    "proxyGoodId": 1, 
    "proxyShopId": 1,
    "proxyIps": "45.192.43.243", 
}

Response example

{
    "msg": "success",
    "code": 200,
    "ts": 1749955352069
}

Set-Static-IP-Auto-Renewal

Interface address

/owlproxy/api/openApi/vcProxy/autoRenewClose

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
proxyId	93847	Integer	Agent ID
autoRenew	false	boolean	Yes: true No: false

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp

Request Example

{
    "proxyId": 93847, 
    "autoRenew": false
}

Response example

{
    "msg": "success",
    "code": 200,
    "ts": 1749955352069
}

Batch-Calculate-Renewal-Price

Interface address

/owlproxy/api/openApi/vcProxy/batchCalculateRenewPrice

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
proxyIps	["192.168.1.1","192.168.1.2"]	List<String>	List of proxy IPs to renew
renewalDays	30	Integer	Renewal days

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data		Object	Response data
├─ totalPrice	280	Long	Total price (cents)
├─ ipCount	2	Integer	Number of IPs to renew
├─ renewalDays	30	Integer	Renewal days
├─ ipPriceDetails		List	Price details list
│ ├─ proxyIp	192.168.1.1	String	Proxy IP
│ ├─ unitPrice	140	Long	Final price (cents)
│ ├─ originalPrice	175	Long	Original price (cents)
│ ├─ subtotal	140	Long	Subtotal (cents)
│ ├─ goodName	US-Residential-IP	String	Product name
│ ├─ shopId	1	Integer	Proxy provider ID
│ ├─ goodPeriodDays	30	Integer	Product period days
├─ errorList		List	Error information list
│ ├─ proxyIp	192.168.1.2	String	Proxy IP
│ ├─ errorMsg	IP has expired, cannot renew	String	Error message

Request Example

{
    "proxyIps": ["192.168.1.1", "192.168.1.2"],
    "renewalDays": 30
}

Response example

{
    "msg": "success",
    "code": 200,
    "data": {
        "totalPrice": 280,
        "ipCount": 2,
        "renewalDays": 30,
        "ipPriceDetails": [
            {
                "proxyIp": "192.168.1.1",
                "unitPrice": 140,
                "originalPrice": 175,
                "goodPeriodDays": 30,
                "subtotal": 140,
                "goodName": "US-Residential-IP",
                "shopId": 1
            }
        ],
        "errorList": [
            {
                "proxyIp": "192.168.1.2",
                "errorMsg": "IP has expired, cannot renew"
            }
        ]
    },
    "ts": 1751179652664
}

Static-IP-Order-List

Interface address

/owlproxy/api/openApi/vcProxyOrder/selectProxyOrderList

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
page	1	Integer	Current page
rows	10	Integer	Page size
completeStartTime	2025-06-13 00:00:00	String	Start time
completeEndTime	2025-06-14 23:59:59	String	End time

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ total	10	Integer	Total number of records
├─ pages	10	Integer	Total number of pages
├─ records		Object[]	Record list
│ ├─ goodNum	1	Integer	Purchase quantity
│ ├─ createTime	1749909120000	Integer	Creation time
│ ├─ orderId	Owl-PROXY174990911995959082	String	Order number
│ ├─ completeTime	1749909121000	Integer	Payment time
│ ├─ orderStatus	1	Integer	Order status: 0 - Waiting for payment, 1 - Payment completed, 2 - Payment failed, 3 - Refunded, 4 - Expired, 5 - Refunding, 6 - Refund failed
│ ├─ orderPrice	600	Integer	Order price
│ ├─ payPrice	600	Integer	Payment price
│ ├─ goodPrice	600	Integer	Package price
│ ├─ goodName	2GB	String	Package name
│ ├─ goodSize	2000	Integer	Size (MB)

Request Example

{
    "completeStartTime": "2025-06-13 00:00:00", 
    "completeEndTime": "2025-06-14 23:59:59",
    "page": 1,
    "rows": 20
}

Response example

{
    "msg": "success",
    "code": 200,
    "data": {
        "current": 1,
        "total": 5,
        "pages": 1,
        "optimizeCountSql": true,
        "size": 20,
        "records": [
            {
                "buyNumber": 1,
                "goodName": "88折",
                "createTime": 1749909120000,
                "orderId": "Owl-PROXY174990911995959082",
                "payPrice": 176,
                "completeTime": 1749909121000,
                "orderStatus": 1,
                "orderPrice": 176,
                "businessType": 2,
                "goodPrice": 176,
                "goodNum": 1
            }
        ],
        "searchCount": true,
        "orders": []
    },
    "ts": 1749955360398
}

Dynamic proxy service

Query-Dynamic-Traffic-Balance

Interface address

/owlproxy/api/openApi/vcDynamicGood/queryCurrentTrafficBalance

Request method

GET

Request data type

application/json

Request Query params None

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ useTraffic	0	Integer	Used (MB）
├─ remainingTraffic	0	Integer	Remaining (MB)
├─ accumulatedTraffic	0	Integer	Total (MB)

Response example

{
    "msg": "success",
    "code": 200,
    "data": {
        "useTraffic": 0,
        "remainingTraffic": 8000,
        "accumulatedTraffic": 8000
    },
    "ts": 1749955456833
}

Get-Dynamic-IP-Packages

Interface address

/owlproxy/api/openApi/vcDynamicGood/getDynamicGoodService

Request method

GET

Request data type

application/json

Request Query params None

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ goodName	2GB	String	Product name
├─ createTime	1740639794000	Integer	Creation time
├─ oldPrice	800	Integer	Original price
├─ recommendContent	25% off	String	Recommended content
├─ reorder	1	Integer	sort
├─ goodId	1	Integer	Product ID
├─ goodPrice	600	Integer	Current price
├─ firstPurchase	600	Integer	First purchase price
├─ totalTraffic	2000	Integer	Size (MB)

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "goodName": "2GB",
            "createTime": 1740639794000,
            "oldPrice": 800,
            "recommendContent": "25折",
            "reorder": 1,
            "goodId": 1,
            "goodPrice": 600,
            "firstPurchase": 600,
            "totalTraffic": 2000
        },
    ],
    "ts": 1749955652636
}

Purchase-Dynamic-IP-Package

Interface address

/owlproxy/api/openApi/vcDynamicGood/buyDynamicProxy

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
goodId	1	Integer	Package ID
goodNum	1	Integer	Quantity
autoRenewOrder	0	Integer	Automatic renewal Yes: 1 No: 0

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp

Request Example

{
    "goodId": 1,
    "goodNum": 1,
    "autoRenewOrder": 0
}

Response example

{
    "msg": "success",
    "code": 200,
    "ts": 1749956181581
}

Get-Dynamic-IP-Extraction-Regions

Interface address

/owlproxy/api/openApi/vcDynamicGood/getDynamicProxyRegion

Request method

GET

Request data type

application/json

Request Query params None

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ city	Sharjahcity	String	City
├─ state	Sharjah	String	State/Province
├─ countryName	阿联酋	String	Country
├─ region	AE	String	Country/Region

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "city": "Sharjahcity",
            "state": "Sharjah",
            "countryName": "阿联酋",
            "region": "AE"
        }
    ],
    "ts": 1749956394204
}

Get-Dynamic-IP-Extraction-Regions

Interface address

/owlproxy/api/openApi/vcDynamicGood/getDynamicProxyHost

Request method

GET

Request data type

application/json

Request Query params None

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ value	Sharjahcity	String	Regions value
├─ name	Sharjah	String	Regions name

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "value": "change4.owlproxy.com:7778",
            "name": "美洲区（南美与北美）"
        },
        {
            "value": "change5.owlproxy.com:7778",
            "name": "亚太Region(包括大洋洲)"
        },
        {
            "value": "change6.owlproxy.com:7778",
            "name": "欧洲及非洲"
        }
    ],
    "ts": 1749956718585
}

Extract-Dynamic-IP

Interface address

/owlproxy/api/openApi/vcDynamicGood/createProxy

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
countryCode	AE	String	国家/Region
state	Sharjah	String	州/省
city	Sharjahcity	String	城市
proxyHost	change4.owlproxy.com:7778	String	proxyHost
proxyType	socks5	String	Agreement: socks5 http https
time	5	Integer	IP rotation cycle (minutes) 5/10/15/30/45/60/90
goodNum	1	Integer	Quantity

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ proxyHost	change4.owlproxy.com	String	host
├─ proxyPort	7778	String	port
├─ userName	******_custom_zone_AE_st__city_sid_34494893_time_5	String	Account number
├─ password	******	String	Password
├─ proxyType	socks5	String	Agreement

Request Example

{
    "countryCode": "AE",
    "state": "Sharjah",
    "city": "Sharjahcity",
    "proxyHost": "change4.owlproxy.com:7778",
    "proxyType": "socks5",
    "time": 5, 
    "goodNum": 1
}

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "proxyHost": "change4.owlproxy.com",
            "proxyPort": 7778,
            "userName": "J2uwNUFxjj90_custom_zone_AE_st__city_sid_34494893_time_5",
            "password": "997875",
            "proxyType": "socks5"
        }
    ],
    "ts": 1749957227938
}

Dynamic-IP-Auto-Renewal-Orders

Interface address

/owlproxy/api/openApi/vcDynamicGood/getDynamicProxyAutomaticRenewal

Request method

GET

Request data type

application/json

Request Query params None

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ good_size	2000	Integer	Size (MB)
├─ auto_renew_order	1	Integer	Automatic renewal Yes: 1 No: 0
├─ order_price	600	Integer	Price (points)
├─ good_number	1	Integer	Quantity

Response example

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "good_size": 2000,
            "auto_renew_order": 1,
            "order_price": 600.00,
            "good_name": "OwlProxy 动态流量",
            "good_number": 1
        }
    ],
    "ts": 1749957841875
}

Set-Dynamic-IP-Auto-Renewal

Interface address

/owlproxy/api/openApi/vcDynamicGood/setAutoRenewSwitch

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
autoRenewOrder	1	Integer	Yes: 1 No: 0

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp

Request Example

{
    "autoRenewOrder": 0
}

Response example

{
    "msg": "success",
    "code": 200,
    "ts": 1749957839118
}

Dynamic-IP-Order-List

Interface address

/owlproxy/api/openApi/vcDynamicGood/getDynamicProxyOrders

Request method

POST

Request data type

application/json

Request Body Parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
page	1	Integer	Current page
rows	10	Integer	Page size
completeStartTime	2025-06-13 00:00:00	String	Start time
completeEndTime	2025-06-14 23:59:59	String	End time

Response parameters

Parameter Name	Example Value	Parameter Type	Parameter Description
msg	success	String	Response message
code	200	Integer	Status code
ts	1736922808949	Integer	Timestamp
data
├─ total	10	Integer	Total number of records
├─ pages	10	Integer	Total number of pages
├─ records		Object[]	Record list
│ ├─ goodNum	1	Integer	购买Quantity
│ ├─ createTime	1749909120000	Integer	Creation time
│ ├─ orderId	Owl-PROXY174990911995959082	String	Order Number
│ ├─ completeTime	1749909121000	Integer	Payment time
│ ├─ orderStatus	1	Integer	Order status :0 Waiting for payment 1 Payment completed 2 Payment failed 3 Refunded 4 Invalid 5 Refund in progress 6 Refund failed
│ ├─ orderPrice	600	Integer	Order price
│ ├─ payPrice	600	Integer	Payment price
│ ├─ goodPrice	600	Integer	Package price
│ ├─ goodName	2GB	String	Package name
│ ├─ goodSize	2000	Integer	Size (MB)

Request Example

{
    "completeStartTime": "2025-06-13 00:00:00",
    "completeEndTime": "2025-06-14 23:59:59",
    "page": 1,
    "rows": 20
}

Response example

{
    "msg": "success",
    "code": 200,
    "data": {
        "current": 1,
        "total": 5,
        "pages": 1,
        "optimizeCountSql": true,
        "size": 20,
        "records": [
            {
                "orderId": "Owl-PROXY174990416811621409",
                "orderPrice": 600.00,
                "payPrice": 600.00,
                "createTime": "2025-06-14 20:29:28",
                "completeTime": "2025-06-14 20:29:28",
                "orderStatus": 1,
                "goodId": 1,
                "goodNum": 1,
                "goodName": "2GB",
                "goodPrice": 600.00,
                "goodSize": 2000,
                "sumSize": 2000,
                "autoRenewOrder": 1
            },

        ],
        "searchCount": true,
        "orders": []
    },
    "ts": 1749955360398
}

Callback Management

Static IP Package Purchase Payment Result Callback

Usage Scenario Please include a callback URL in the Static IP package purchase API.

Parameter Name	Type	Description
orderId	String	Order ID
businessType	String	Business type (e.g., purchase)
amount	BigDecimal	Amount changed (unit: cents)
completeTime	String	Completion time (format: yyyy-MM-dd HH:mm:ss)
status	Integer	Order status
proxyInfo	Object[]	Proxy information list, returned only when proxy resources are included
├─ ip	String	Proxy IP address
├─ port	Integer	Proxy port
├─ username	String	Proxy authentication username
├─ password	String	Proxy authentication password

Static IP Package Payment Result Callback

Usage Scenario Please include a callback URL in the Static IP package purchase API.

Parameter Name	Type	Description
orderId	String	Order ID
businessType	String	Business type (e.g., purchase)
amount	BigDecimal	Amount changed (unit: cents)
completeTime	String	Completion time (format: yyyy-MM-dd HH:mm:ss)
status	Integer	Order status
proxyInfo	Object[]	Proxy information list, returned only when proxy resources are included
├─ ip	String	Proxy IP address
├─ port	Integer	Proxy port
├─ username	String	Proxy authentication username
├─ password	String	Proxy authentication password

Callback Management

Payment Result Callback for Purchasing and Renewing Static IP Packages

Usage Scenario Please include a callback URL in the purchase static IP package or renew static IP package API request.

Parameter Name	Example Value	Parameter Type	Description
orderId	PROXY174841484014636643	String	Order ID
amount	650	BigDecimal	Amount changed (unit: cents)
completeTime	2025.01.01 01.01.01	String	Completion time (format: yyyy-MM-dd HH:mm:ss)
status	1	Integer	Order status: 1 = purchase successful, 0 = failed
proxyInfo		Object[]	Proxy information list, returned only when proxy resources are included
├─ ip	185.145.12.11	String	Proxy IP address
├─ port	3306	Integer	Proxy port
├─ username	123	String	Proxy authentication username
├─ password	123	String	Proxy authentication password
├─ httpPort	3306	Integer	Proxy http port