NaProxy

app_key authentication key can be viewed on the personal center homepage after logging in.

Please keep the key safe, as it has administrator privileges for your account.

Authentication Methods

App Key Authentication

POST parameters:

app_key: {your_app_key}

Or as query parameter:

?app_key={your_app_key}

Response Format

All APIs return a unified JSON format:

{
	"code": 200,
	"message": "Operation successful",
	"data": {}
}

code: Status code, 200 indicates success, other values indicate failure
message: Response message
data: Response data

Base URLs:

Authentication

HTTP Authentication, scheme: bearer

API Key (apiKeyAuth)
- Parameter Name: app_key, in: query. Supports GET/POST

Proxy Account Management

GET Proxy Account List

GET /api-gate/whitelist-account/list

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"username": "string",
				"password": "string",
				"created_at": "string",
				"remark": "string",
				"product_type": 9,
				"usage_flow": 0,
				"limit_flow": 102400,
				"status": 0
			}
		]
	}
}

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	responseCode	false	none	Status code, 200 success, 3 app_key invalid
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Account ID
»»» username	string	false	none	Proxy account username
»»» password	string	false	none	Proxy account password
»»» created_at	string	false	none	Creation time
»»» remark	string	false	none	Remark
»»» product_type	productTypes	false	none	Package type, 9 Dynamic Residential Traffic Package, 11 Dynamic Residential IP, 14 Static Data Center IP, 25 Static Residential IP
»»» usage_flow	integer	false	none	Used traffic, unit: KB
»»» limit_flow	integer	false	none	Custom traffic limit: unit GB, max 102400, 0 for unlimited
»»» status	integer	false	none	Enable status: 1 enabled, 0 disabled

Enum Values

Property	Value
product_type	9
product_type	11
product_type	14
product_type	25

POST Add Proxy Account

POST /api-gate/whitelist-account/add

Body Request Parameters

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01:pass,user02:pass,user03:pass",
	"remark": "",
	"product_type": 9
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	no	none
» app_key	body	string	no	Authorization key
» accounts	body	string	no	Account password, please fill in the format username:password, account and password only support numbers and letters, no special symbols or spaces allowed, colon separates account and password. Supports batch addition, separated by English comma (,).
» remark	body	string	no	Proxy account description
» product_type	body	productTypes	no	Package type, 9 Dynamic Residential Traffic Package, 11 Dynamic Residential IP, 14 Static Data Center IP, 25 Static Residential IP

Enum Values

Property	Value
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": 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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	null	false	none	none

POST Delete Proxy Account

POST /api-gate/whitelist-account/delete

Please note that deletion cannot be recovered, and used traffic cannot be queried. Deletion has a waiting period of about 5 minutes, during which fees may still be incurred.

Body Request Parameters

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	no	none
» app_key	body	string	no	Authorization key
» accounts	body	string	no	Proxy accounts, only supports numbers and letters. Supports batch operation, separated by English comma (,)

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": 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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	null	false	none	none

POST Disable Proxy Account

POST /api-gate/whitelist-account/disable

Disabling has a waiting period of about 5 minutes, during which fees may still be incurred.

Body Request Parameters

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	no	none
» app_key	body	string	no	Authorization key
» accounts	body	string	no	Proxy accounts, only supports numbers and letters. Supports batch operation, separated by English comma (,)

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": 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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	null	false	none	none

POST Enable Proxy Account

POST /api-gate/whitelist-account/enable

Body Request Parameters

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	no	none
» app_key	body	string	no	Authorization key
» accounts	body	string	no	Proxy accounts, only supports numbers and letters. Supports batch operation, separated by English comma (,)

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": 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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	null	false	none	none

POST Change Proxy Account Password

POST /api-gate/whitelist-account/change-password

Please note that after modification, there is a 5-minute waiting period during which the old password may still work.

Body Request Parameters

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"password": "pass"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	no	none
» app_key	body	string	no	Authorization key
» account	body	string	no	Proxy account, only supports numbers and letters.
» password	body	string	no	New proxy account password, only supports numbers and letters.

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": 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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	null	false	none	none

POST Change Proxy Account Remark

POST /api-gate/whitelist-account/change-remark

Body Request Parameters

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"remark": ""
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	no	none
» app_key	body	string	no	Authorization key
» account	body	string	no	Proxy account, only supports numbers and letters.
» remark	body	string	no	New proxy account remark, within 32 Chinese characters or 64 English characters.

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": 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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	null	false	none	none

POST Change Proxy Account Traffic Limit

POST /api-gate/whitelist-account/change-limit

Please note that traffic statistics may have a delay of up to 5 minutes, meaning actual traffic consumption may exceed this limit.

Body Request Parameters

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"limit": 0
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	no	none
» app_key	body	string	no	Authorization key
» account	body	string	no	Proxy account, only supports numbers and letters.
» limit	body	integer	no	Traffic limit, unit: GB, 0 for no limit

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": 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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	null	false	none	none

Traffic Log Query

GET Traffic Usage Summary by Day

GET /api-gate/user-usage-flow/total

Request Parameters

Name	Location	Type	Required	Description
app_key	query	string(password)	yes	Authentication key
start_time	query	string(Y-m-d H:i:s)	no	Start time, can be accurate to seconds. Please note that log recording has a delay within 5 minutes. Default is within 7 days.
end_time	query	string(Y-m-d H:i:s)	no	End time, can be accurate to seconds. Please note that log recording has a delay within 5 minutes. Default is current time.
username	query	string	no	Sub-account name, default queries all accounts, can specify sub-account. Please note if you have added sub-accounts with the same name, this query will return all usage records for proxy accounts with the same name.
product_type	query	number	no	Package type

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"day": "2022-08-01",
				"flow": 0
			}
		]
	}
}

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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» day	string	false	none	Date
»»» flow	integer	false	none	Traffic consumed, unit KB

Package Query

GET Purchased Package List

GET /api-gate/user-product/list

Request Parameters

Name	Location	Type	Required	Description
app_key	query	string(password)	yes	Authentication key
trade_no	query	string	no	Order number, please enter complete order number. Fuzzy search not supported.
page	query	number	no	Page number, default: 1
size	query	number	no	Page size, default: 20
product_type	query	number	no	Package type

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"created_at": "2022-05-13 12:14:15",
				"expired_at": "2022-05-13 12:14:15",
				"product_type": 9,
				"trade_no": "2022051312134339861461465434",
				"order": {
					"created_at": "2022-05-13 12:13:43",
					"pay_at": "2022-05-13 12:13:43",
					"title": "Entry Level"
				}
			}
		],
		"page": 1,
		"page_size": 20,
		"total_count": 0,
		"total_page": 0
	}
}

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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Package ID
»»» created_at	string	false	none	Package effective time
»»» expired_at	string	false	none	Package expiration time, traffic cannot be used after expiration.
»»» product_type	productTypes	false	none	Package type, 9 Dynamic Residential Traffic Package, 11 Dynamic Residential IP, 14 Static Datacenter IP, 25 Static Residential IP
»»» trade_no	string	false	none	Order transaction number
»»» order	object	false	none	none
»»»» created_at	string	false	none	Order creation time
»»»» pay_at	string	false	none	Order payment time
»»»» title	string	false	none	Order description
»» page	integer	false	none	Current page
»» page_size	integer	false	none	Page size
»» total_count	integer	false	none	Total record count
»» total_page	integer	false	none	Total page count

Enum Values

Property	Value
product_type	9
product_type	11
product_type	14
product_type	25

IP Extraction

GET Extract IP

GET /api-gate/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	Province or state
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	Extraction quantity
life	query	number	no	Session duration - minutes
ep	query	string	no	Proxy network

Enum 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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[any]	false	none	none

GET City List

GET /api-gate/ip/dynamic-citys

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "United States",
				"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 app_key invalid, 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	Province or state
»»»» city	string	false	none	City name
»»»» state	string	false	none	Province or state name code
»»»» continent_code	string	false	none	Continent code
»»»» country_code	string	false	none	Country or region code

GET City Search

GET /api-gate/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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[string]	false	none	List

GET State List

GET /api-gate/ip/dynamic-states

Response Example

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "United States",
				"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 app_key invalid, 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	Province or state
»»»» state	string	false	none	Province or state name code
»»»» continent_code	string	false	none	Continent code
»»»» country_code	string	false	none	Country or region code

GET State/Province Search

GET /api-gate/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 app_key invalid, 156 account not verified
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[string]	false	none	List

GET Extract Purchased Static IP List

GET /api-gate/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 IP by order number
page	query	number	no	Page number
size	query	number	no	Items per page
status	query	number	no	Status, 1: Valid, 2: Invalid, 3: Expiring soon, 4: Under maintenance

Enum 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

GET Get Available Static IP Count by Region

GET /api-gate/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	Data Center Static IP

Response Example

200 Response

{
	"code": 200,
	"msg": "Request successful",
	"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

Order Management

GET Order List

GET /api-gate/order/list

Request Parameters

Name	Location	Type	Required	Description
page_no	query	integer	no	none
page_size	query	integer	no	none
trade_no	query	string	no	Order number
status	query	integer	no	Order status
product_type	query	integer	no	Product type

Detailed Description

status: Order Status

Status	Description
0	Pending Payment
1	Paid
2	Cancelled Due to Timeout
3	Refunded

product_type: Product Type | Product Type | Description | |---|---| |3|Balance Recharge| |9|Dynamic Traffic Package| |11|Dynamic Global Time-based Package V2| |12|Long-term IDC Traffic Package| |13|Residential Static IP Traffic Package| |14|Data Center Static IP Package| |15|Long-term ISP Traffic Package| |16|Static Traffic Package| |17|Dynamic IP Quantity Package| |18|web-scraper| |19|Static IP Renewal| |20|Static IP Change Quota| |21|Static Traffic Package v2| |24|Static Traffic Add-on Package| |25|Residential Static IP Package| |26|Supplementary Order - Some payment channels require users to manually enter the amount, such as virtual currency. If there is a shortage, contact customer service to make up the payment through this product| |27|Serp| |28|Video|

Enum Values

Property	Value
status	0
status	1
status	2
status	3
product_type	3
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	17
product_type	18
product_type	19
product_type	21
product_type	24
product_type	25
product_type	26
product_type	27
product_type	28

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"list": [
			{
				"id": 0,
				"trade_no": "string",
				"product_id": 0,
				"product_name": "string",
				"total_fee": 0.1,
				"pay_fee": 0.1,
				"status": 0,
				"created_at": "2019-08-24T14:15:22Z"
			}
		],
		"pagination": {
			"total": 0,
			"page_no": 0,
			"page_size": 0,
			"total_pages": 0
		}
	}
}

Response Result

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

{
	"pid": x, // Contact customer service to obtain
	"upids": "1,2,3,4,5,6", // Obtain corresponding IDs from /api-gate/ip/get-static-ip
	"pm_id": 1 // Obtain from /api-gate/payment/list
	"coupon_sn: "xxx", // Optional coupon
  }

Body Request Parameters

{
	"pid": 0,
	"upids": "string",
	"amount": 0,
	"pm_id": 0,
	"region_list": "string",
	"coupon_sn": "string",
	"use_invitation_registration_discount": true,
	"renew_duration": 0,
	"product_sku_bandwidth_id": 0,
	"product_sku_concurrency_id": 0,
	"recharge_amount": 0
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	yes	none
» pid	body	integer	yes	Package ID
» upids	body	string	no	Renewal package ID list
» amount	body	number	no	New purchase package quantity
» pm_id	body	integer	yes	Payment method ID
» region_list	body	string	no	Specify region + quantity when purchasing static IP
» coupon_sn	body	string	no	Coupon number
» use_invitation_registration_discount	body	boolean	no	Whether to use invitation registration discount
» renew_duration	body	integer	no	Renewal duration - optional for static IP
» product_sku_bandwidth_id	body	integer	no	Package 11: Bandwidth package ID
» product_sku_concurrency_id	body	integer	no	Package 11: Concurrency package ID
» recharge_amount	body	integer	no	Package 3: Recharge amount

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"id": 0,
		"trade_no": "string",
		"product_id": 0,
		"product_name": "string",
		"total_fee": 0.1,
		"pay_fee": 0.1,
		"status": 0,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Response Result

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

Response Data Structure

POST Cancel Order

POST /api-gate/order/close

Body Request Parameters

{
	"trade_no": "string"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	yes	none
» trade_no	body	string	yes	none

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Operation successful	SuccessResponse

User Management

GET Get User Information - Not Yet Available

GET /api-gate/user/info

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"id": 0,
		"email": "[email protected]",
		"phone": "string",
		"balance": 0.1,
		"status": 0,
		"is_real_name": true,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Response Result

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

Response Data Structure

Payment Management

GET Get Payment Method List

GET /api-gate/payment/groups

Request Parameters

Name	Location	Type	Required	Description
trade_no	query	string	no	Order number - can be passed when partial orders need to obtain specific payment methods

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"list": [
			{
				"name": "string",
				"logos": [null],
				"items": [null]
			}
		]
	}
}

Response Result

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

Response Data Structure

Marketing

GET Balance Recharge Gift Ratio

GET /api-gate/activity/balance-recharge-gift-ratio

Balance recharge gift ratio

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"list": [null]
	}
}

Response Result

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

Response Data Structure

Data Models

productTypes

Package type, 9 Dynamic Residential Traffic Package, 11 Dynamic Residential IP, 14 Static Datacenter IP, 25 Static Residential IP

Properties

Name	Type	Required	Constraint	Chinese Name	Description
anonymous	integer	false	none		Package type, 9 Dynamic Residential Traffic Package, 11 Dynamic Residential IP, 14 Static Datacenter IP, 25 Static Residential IP

Enum Values

Property	Value
anonymous	9
anonymous	11
anonymous	14
anonymous	25

apiKey

null

Authentication key

Properties

None

responseCode

Status code, 200 success, 3 app_key invalid

Properties

Name	Type	Required	Constraint	Chinese Name	Description
anonymous	integer	false	none		Status code, 200 success, 3 app_key invalid

responseMsg

"success"

response message

Properties

Name	Type	Required	Constraint	Chinese Name	Description
anonymous	string	false	none		response message

SuccessResponse

{
	"code": 0,
	"message": "Operation successful",
	"data": {}
}

Properties

Name	Type	Required	Constraint	Description
code	integer	false	none	none
message	string	false	none	none
data	object	false	none	none

ErrorResponse

{
	"code": 400,
	"message": "Parameter error",
	"errors": {}
}

Properties

Name	Type	Required	Constraint	Description
code	integer	false	none	none
message	string	false	none	none
errors	object	false	none	none

User

{
	"id": 0,
	"email": "[email protected]",
	"phone": "string",
	"balance": 0.1,
	"status": 0,
	"is_real_name": true,
	"created_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Constraint	Description
id	integer	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
balance	number(float)	false	none	none
status	integer	false	none	none
is_real_name	boolean	false	none	none
created_at	string(date-time)	false	none	none

Order

{
	"id": 0,
	"trade_no": "string",
	"product_id": 0,
	"product_name": "string",
	"total_fee": 0.1,
	"pay_fee": 0.1,
	"status": 0,
	"created_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Constraint	Description
id	integer	false	none	none
trade_no	string	false	none	none
product_id	integer	false	none	none
product_name	string	false	none	none
total_fee	number(float)	false	none	none
pay_fee	number(float)	false	none	none
status	integer	false	none	none
created_at	string(date-time)	false	none	none

Product

{
	"id": 0,
	"name": "string",
	"type": 0,
	"price": 0.1,
	"description": "string"
}

Properties

Name	Type	Required	Constraint	Description
id	integer	false	none	none
name	string	false	none	none
type	integer	false	none	none
price	number(float)	false	none	none
description	string	false	none	none

WhiteIp

{
	"id": 0,
	"ip": "string",
	"remark": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Constraint	Description
id	integer	false	none	none
ip	string	false	none	none
remark	string	false	none	none
created_at	string(date-time)	false	none	none

WhitelistAccount

{
	"id": 0,
	"username": "string",
	"limit": 0,
	"used": 0,
	"status": 0
}

Properties

Name	Type	Required	Constraint	Description
id	integer	false	none	none
username	string	false	none	none
limit	integer	false	none	none
used	integer	false	none	none
status	integer	false	none	none

Coupon

{
	"id": 0,
	"name": "string",
	"code": "string",
	"discount": 0.1,
	"expire_time": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Constraint	Description
id	integer	false	none	none
name	string	false	none	none
code	string	false	none	none
discount	number(float)	false	none	none
expire_time	string(date-time)	false	none	none

Article

{
	"id": 0,
	"title": "string",
	"content": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Constraint	Description
id	integer	false	none	none
title	string	false	none	none
content	string	false	none	none
created_at	string(date-time)	false	none	none

Pagination

{
	"total": 0,
	"page_no": 0,
	"page_size": 0,
	"total_pages": 0
}

Properties

Name	Type	Required	Constraint	Description
total	integer	false	none	none
page_no	integer	false	none	none
page_size	integer	false	none	none
total_pages	integer	false	none	none