IP Extraction

Extract IP

GET

/pub/ip/v3

Request Parameters

Name	Location	Type	Required	Description
app_key	query	string(password)	Yes	Access key
cc	query	string	No	Country or region
state	query	string	No	State or province
city	query	string	No	City
format	query	string	No	Output format
lb	query	string	No	Separator, only valid for text format
num	query	number	No	Number of IPs to extract
life	query	number	No	Session duration in minutes
ep	query	string	No	Proxy network

Enumeration Values

Property	Value
ep	us
ep	hk
ep	de

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			[
				"150.109.114.72:1140",
				"150.109.114.72:1141",
				"150.109.114.72:1142",
				"150.109.114.72:1143",
				"150.109.114.72:1144",
				"150.109.114.72:1145",
				"150.109.114.72:1146",
				"150.109.114.72:1147",
				"150.109.114.72:1148",
				"150.109.114.72:1149"
			]
		]
	}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Request successful	Inline

Response Data Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	false	none	Status code: 200 success, 3 invalid app_key, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[any]	false	none	none

City List

GET

/pub/ip/dynamic-citys

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "美国",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"city": null,
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Request successful	Inline

Response Data Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	false	none	Status code: 200 success, 3 invalid app_key, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[object]	false	none	List
»»» name_zh_cn	string	false	none	Country or region name
»»» name_en	string	false	none	Country or region name
»»» continent_code	string	false	none	Continent code
»»» country_code	string	false	none	Country or region code
»»» items	[object]	false	none	State or province
»»»» city	string	false	none	City name
»»»» state	string	false	none	State or province code
»»»» continent_code	string	false	none	Continent code
»»»» country_code	string	false	none	Country or region code

City Search

GET

/pub/ip/dynamic-citys/search

Request Parameters

Name	Location	Type	Required	Description
country_code	query	string	Yes	Country or region code
state	query	string	Yes	State or province code

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Request successful	Inline

Response Data Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	false	none	Status code: 200 success, 3 invalid app_key, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[string]	false	none	List

State List

GET

/pub/ip/dynamic-states

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "美国",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Request successful	Inline

Response Data Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	false	none	Status code: 200 success, 3 invalid app_key, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[object]	false	none	List
»»» name_zh_cn	string	false	none	Country or region name
»»» name_en	string	false	none	Country or region name
»»» continent_code	string	false	none	Continent code
»»» country_code	string	false	none	Country or region code
»»» items	[object]	false	none	State or province
»»»» state	string	false	none	State or province code
»»»» continent_code	string	false	none	Continent code
»»»» country_code	string	false	none	Country or region code

State/Province Search

GET

/pub/ip/dynamic-states/search

Request Parameters

Name	Location	Type	Required	Description
country_code	query	string	Yes	Country or region code

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Request successful	Inline

Response Data Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	false	none	Status code: 200 success, 3 invalid app_key, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[string]	false	none	List

Extract Purchased Static IP List

GET

/pub/ip/get-static-ip

Request Parameters

Name	Location	Type	Required	Description
country_code	query	string	No	Country or region code
product_type	query	number	No	Product type: 25: Static Residential IP, 14: Datacenter IP
trade_no	query	string	No	Filter IPs by order number
page	query	number	No	Page number
size	query	number	No	Items per page
status	query	number	No	Status: 1: Active, 2: Inactive, 3: Expiring soon, 4: Under maintenance

Enumeration Values

Property	Value
product_type	14
product_type	25
status	1
status	2
status	3
status	4

Response Example

200 Response

{}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	none	Inline

Response Data Structure

Get Available Static IP Count by Region

GET

/pub/static-ip-region

Request Parameters

Name	Location	Type	Required	Description
isp	query	string	No	IP type

Detailed Description

isp: IP type

IP Type	Description
1	Residential Static IP
0	Datacenter Static IP

Response Example

200 Response

{
	"code": 200,
	"msg": "请求成功",
	"data": {
		"list": [
			{
				"code": "US",
				"number": 55
			}
		]
	}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Request successful	Inline

Response Data Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	false	none	Status code: 200 success
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» code	string	false	none	Country or region code
»»» number	integer	false	none	Quantity