ProxyLite OpenAPI

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

app_key Please log in and view the authentication key on your account center homepage.

Please keep the key secure. It has administrator access to your account.

Authentication

App Key Authentication

POST parameters:

app_key: {your_app_key}

Or as a query parameter:

?app_key={your_app_key}

Response Format

All endpoints return a unified JSON response format:

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

code: Status code. 200 means success; other values indicate failure.
message: Response message.
data: Response data.

Base URLs:

https://api.proxylite.com

Authentication

HTTP Authentication, scheme: bearer

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

Proxy Account Management

Proxy Account List

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/list

Parameters

Name	In	Type	Required	Description
app_key	query	string(password)	true	Authentication key

Example responses

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
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	responseCode	false	none	Status code, 200 successful, 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 number
»»» username	string	false	none	Proxy account name
»»» password	string	false	none	Proxy account password
»»» created_at	string	false	none	Created at
»»» 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	Customized traffic limit: maximum unit GB is 102400, 0 is no limit
»»» status	integer	false	none	Enabled status: 1 enabled, 0 disabled

Enumerated Values

Property	Value
product_type	9
product_type	11
product_type	14
product_type	25

Add Proxy Account

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/add

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» accounts	body	string	false	Account password, please fill it in the format username:password. Account and password only support numbers and letters. It is prohibited to enter any special symbols or spaces. A colon separates the account and password. Batch addition is supported, and agent accounts are separated by English commas (,).
» remark	body	string	false	Proxy account description
» product_type	body	productTypes	false	Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP

Enumerated Values

Parameter	Value
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	null	false	none	none

Delete proxy account

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/delete

Please note that it cannot be restored after deletion, and the used traffic cannot be queried. There will be a waiting time of approximately 5 minutes for deletion, during which charges may still be incurred.

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» accounts	body	string	false	Proxy account, only letters and numbers are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	null	false	none	none

Disable proxy account

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/disable

There will be a waiting time of approximately 5 minutes for disabling, during which time charges may still be incurred.

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» accounts	body	string	false	Proxy account, only letters and numbers are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	null	false	none	none

Enable proxy account

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/enable

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» accounts	body	string	false	Proxy account, only letters and numbers are supported. Support batch operations, English commas (,) separate agent accounts

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	null	false	none	none

Change Proxy Account Password

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-password

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

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» account	body	string	false	Proxy account, only letters and numbers are supported.
» password	body	string	false	The new password for the agent account, only supports numbers and letters.

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	null	false	none	none

Change Proxy Account Remark

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-remark

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» account	body	string	false	Proxy account, only letters and numbers are supported.
» remark	body	string	false	New remarks for agency accounts, within 32 Chinese characters or 64 English characters.

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	null	false	none	none

Change Proxy Account Traffic Limit

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-limit

Please note that traffic statistics may be delayed within 5 minutes, that is, the actual traffic consumed may exceed this limit.

Body parameter

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

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» account	body	string	false	Proxy account, only letters and numbers are supported.
» limit	body	integer	false	Traffic limit, unit: GB, 0 means no upper limit

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	null	false	none	none

Change Proxy Account Information

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/change

Modify the proxy account password, remarks, traffic limit, daily traffic limit, enabled status, or UDP switch.

Body parameter

{
	"app_key": "string",
	"account": "string",
	"password": "string",
	"remark": "string",
	"limit": 0,
	"daily_limit": 0,
	"status": 0,
	"udp": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» account	body	string	false	Proxy account name
» password	body	string	false	New password, 6-16 digits or letters; if not passed, it will not be modified.
» remark	body	string	false	New note
» limit	body	integer	false	Traffic limit, unit GB, 0 means no limit
» daily_limit	body	integer	false	Daily traffic limit in GB, 0 means no limit
» status	body	integer	false	Enabled status
» udp	body	integer	false	UDP support switch, only effective for package types 14, 16, 21, and 25

Enumerated Values

Parameter	Value
» status	0
» status	1
» udp	0
» udp	1

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	Status message
» data	null	false	none	none

Order management

Order creation, inquiry, cancellation, etc.

order list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/order/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/list

Parameters

Name	In	Type	Required	Description
page_no	query	integer	false	none
page_size	query	integer	false	none
trade_no	query	string	false	order number
start_time	query	string(date-time)	false	Start time (inclusive), such as 2024-01-01 00:00:00
end_time	query	string(date-time)	false	End time (not included)
status	query	integer	false	Order status
product_type	query	integer	false	product type
invoice	query	integer	false	Invoice status: 0 no limit 1 invoiced -1 uninvoiced (can be reissued)
pay_fee_status	query	integer	false	Long and short payment screening: 1 Overpayment 2 Short payment

Detailed descriptions

status: Order status

Status	Description
0	Pending payment
1	Paid
2	Canceled due to overtime and non-payment
3	Refunded

product_type: product type | Product Type | Description | |---|---| |3|Balance Recharge| |9|Dynamic traffic package| |11|Dynamic Global Time 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 replacement quota| |21|Static traffic package v2| |24|Static traffic add-on package| |25|Residential Static IP Package| |26|Replacement order - Some payment channels require users to manually fill in the amount, such as: virtual currency. If a short payment occurs, you need to contact customer service to make a repayment through this product| |27|Serp| |28|Video|

Enumerated Values

Parameter	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
invoice	-1
invoice	0
invoice	1
pay_fee_status	1
pay_fee_status	2

Example responses

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"list": [
			{
				"id": 0,
				"trade_no": "string",
				"out_trade_no": "string",
				"product_id": 0,
				"product_type": 0,
				"amount": 0,
				"unit_price": 0.1,
				"total_fee": 0.1,
				"goods_fee": 0.1,
				"pay_fee": 0.1,
				"discount_fee": 0.1,
				"handling_fee": 0.1,
				"refund_fee": 0.1,
				"pm_id": 0,
				"pm_title": "string",
				"pm_logo": "string",
				"status": 0,
				"title": "string",
				"detail": "string",
				"region_desc": "string",
				"pay_at": "2019-08-24T14:15:22Z",
				"pay_timestamp": 0,
				"created_at": "2019-08-24T14:15:22Z",
				"pay_fee_status": 0,
				"invoice": {
					"name": "string",
					"org_name": "string",
					"first_name": "string",
					"last_name": "string",
					"phone": "string",
					"email": "[email protected]",
					"role_type": 0,
					"vat_id": "string",
					"address_country": "string",
					"address_city": "string",
					"address_line1": "string",
					"address_line2": "string",
					"address_postal_code": "string"
				}
			}
		],
		"pagination": {
			"total": 0,
			"page_no": 0,
			"page_size": 0,
			"total_pages": 0
		}
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	success	Inline

Response Schema

Create order

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/create

Since there are many types of packages and each package has different configurations, please fill in the parameters according to the actual situation. Improperly filling in parameters may result in order creation failure.

examples:

Renew static IP

{
    "pid": package ID, // obtained from /end-point/product interface
    "upids": "1,2,3,4,5,6", // Get the corresponding id field from the /end-point/ip/get-static-ip interface
    "pm_id": 1 // Obtained from /end-point/payment/list or /end-point/payment/groups interface
  }

Static Residential IP Purchase

{
  "pid": package ID, // obtained from /end-point/product interface
  "pm_id": payment method ID, // obtained from /end-point/payment/list or /end-point/payment/groups interface
  "region_list": "JP,15,333|DE,10,444|US,5,555" // Format: region, quantity, ASN|region, quantity, ASN (ASN number optional)
}

Static data center IP purchase

{
  "pid": package ID, // obtained from /end-point/product interface
  "pm_id": payment method ID, // obtained from /end-point/payment/list or /end-point/payment/groups interface
  "region_list": "JP,15,333|DE,10,444|US,5,555" // Format: region, quantity, ASN|region, quantity, ASN (ASN number optional)
}

Dynamic residential traffic purchase

{
  "pid": package ID, // obtained from /end-point/product interface
  "pm_id": Payment method ID // Obtained from /end-point/payment/list or /end-point/payment/groups interface
}

Static rotation traffic purchase

{
  "pid": package ID, // obtained from /end-point/product interface
  "pm_id": Payment method ID // Obtained from /end-point/payment/list or /end-point/payment/groups interface
}

Dynamic unlimited traffic purchase

{
  "pid": package ID, // obtained from /end-point/product interface
  "pm_id": payment method ID, // obtained from /end-point/payment/list or /end-point/payment/groups interface
  "product_sku_bandwidth_id": bandwidth specification ID,
  "product_sku_concurrency_id": concurrency specification ID
}

Balance recharge

{
  "pid": package ID, // obtained from /end-point/product interface
  "pm_id": payment method ID, // obtained from /end-point/payment/list or /end-point/payment/groups interface
  "recharge_amount": recharge amount
}

Body parameter

{
	"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,
	"product_sku_duration_id": 0,
	"etd": 1,
	"recharge_amount": 0
}

Parameters

| Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | --- | --- | --- | | body | body | object | true | none | | » pid | body | integer | true | Package ID, from the id field returned by the /end-point/product interface | | » upids | body | string | false | List of renewal package IDs (comma separated), from the id field returned by the /end-point/user-product/list or /end-point/ip/get-static-ip interface | | » amount | body | number | false | Number of new packages purchased | | » pm_id | body | integer | true | Payment method ID, from the id field returned by the /end-point/payment/list or /end-point/payment/groups interface | | » region_list | body | string | false | When purchasing a static IP, specify the region + quantity + ASN number. The format is: region, quantity, ASN | region, quantity, ASN. For example: JP,15,333 | DE,10,444 | US,5,555 (ASN number is optional) | | » coupon_sn | body | string | false | Coupon number | | » use_invitation_registration_discount | body | boolean | false | Whether to use invitation registration discount | | » renew_duration | body | integer | false | Renewal time-static IP optional | | » product_sku_bandwidth_id | body | integer | false | Package 11: Bandwidth Package ID | | » product_sku_concurrency_id | body | integer | false | Package 11: Concurrent Package ID | | » product_sku_duration_id | body | integer | false | Package type=11Required: Duration Specification ID | | » etd | body | integer | false | Duration multiple, obtained from package extension_of_time_days, 2 represents the number of days × 2, the price will increase | | » recharge_amount | body | integer | false | Package 3: Recharge amount |

Example responses

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"id": 0,
		"trade_no": "string",
		"out_trade_no": "string",
		"product_id": 0,
		"product_type": 0,
		"amount": 0,
		"unit_price": 0.1,
		"total_fee": 0.1,
		"goods_fee": 0.1,
		"pay_fee": 0.1,
		"discount_fee": 0.1,
		"handling_fee": 0.1,
		"refund_fee": 0.1,
		"pm_id": 0,
		"pm_title": "string",
		"pm_logo": "string",
		"status": 0,
		"title": "string",
		"detail": "string",
		"region_desc": "string",
		"pay_at": "2019-08-24T14:15:22Z",
		"pay_timestamp": 0,
		"created_at": "2019-08-24T14:15:22Z",
		"pay_fee_status": 0,
		"invoice": {
			"name": "string",
			"org_name": "string",
			"first_name": "string",
			"last_name": "string",
			"phone": "string",
			"email": "[email protected]",
			"role_type": 0,
			"vat_id": "string",
			"address_country": "string",
			"address_city": "string",
			"address_line1": "string",
			"address_line2": "string",
			"address_postal_code": "string"
		}
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Created successfully	Inline

Response Schema

Cancel order

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/close \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/close

Body parameter

{
	"trade_no": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» trade_no	body	string	true	none

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Operation successful	SuccessResponse

Order pre-check

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/order/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/check

Called before creating an order, it is used to preview prices, discounts, IP renewal details, etc. The order will not actually be created. The parameters are exactly the same as /end-point/order/create.

Body parameter

{
	"pid": 0,
	"upids": "string",
	"amount": 1,
	"pm_id": 0,
	"region_list": "string",
	"coupon_sn": "string",
	"renew_duration": "1m",
	"product_sku_bandwidth_id": 0,
	"product_sku_concurrency_id": 0,
	"product_sku_duration_id": 0,
	"etd": 1,
	"recharge_amount": 0
}

Parameters

| Name | In | Type | Required | Description | | ---------------------------- | ---- | ------- | -------- | ----------------------------------------------------------------- | ------------------- | | body | body | object | true | none | | » pid | body | integer | true | Package ID | | » upids | body | string | false | IP renewal: list of user package IDs, separated by commas | | » amount | body | integer | false | Purchase quantity | | » pm_id | body | integer | true | Payment method ID | | » region_list | body | string | false | Static IP purchase region + quantity, format: region ID, quantity | region ID, quantity | | » coupon_sn | body | string | false | Coupon number | | » renew_duration | body | string | false | IP renewal period: 1m=1 month, 2m=2 months, em=end of next month | | » product_sku_bandwidth_id | body | integer | false | Package type=11Required: Bandwidth Specification ID | | » product_sku_concurrency_id | body | integer | false | Package type=11Required: Concurrency specification ID | | » product_sku_duration_id | body | integer | false | Package type=11Required: Duration Specification ID | | » etd | body | integer | false | Duration multiple, obtained from package extension_of_time_days | | » recharge_amount | body | number | false | Package type=3Required: recharge amount |

Enumerated Values

Parameter	Value
» renew_duration	1m
» renew_duration	2m
» renew_duration	em

Example responses

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"product_id": 0,
		"amount": 0,
		"discount_fee": 0.1,
		"total_fee": 0.1,
		"pay_fee": 0.1,
		"product_type": 0,
		"title": "string",
		"detail": "string",
		"ip_result": [
			{
				"ip": "string",
				"price": 0.1,
				"country_code": "string",
				"current_time": "2019-08-24T14:15:22Z",
				"renewal_time": "2019-08-24T14:15:22Z",
				"country": {
					"name_zh_cn": "string",
					"flag": "string",
					"square_flag": "string"
				}
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Preflight successful	Inline

Response Schema

IP Whitelist

IP whitelist list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/proxy-ip/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-ip/list

Parameters

Name	In	Type	Required	Description
app_key	query	string(password)	true	Authentication key
product_type	query	integer	false	Package type number

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"ip": "1.1.1.1",
				"remark": "string",
				"product_type": 0,
				"created_at": "string"
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	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
»»» ip	string	false	none	Whitelist IP
»»» remark	string	false	none	Remark
»»» product_type	integer	false	none	Package type
»»» created_at	string	false	none	creation time

Add IP whitelist

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/add

Body parameter

{
	"app_key": "string",
	"ips": "1.1.1.1,2.2.2.2",
	"remark": "string",
	"product_type": 0,
	"user_product_id": 0
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» ips	body	string	false	Whitelist IPs that need to be added, separate multiple ones with commas or newlines.
» remark	body	string	false	Remark
» product_type	body	integer	false	Package type number
» user_product_id	body	integer	false	User package ID, required when package type is 11

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	Status message
» data	null	false	none	none

Delete IP whitelist

Code samples

# You can also use wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/delete

Body parameter

{
	"app_key": "string",
	"ips": "1.1.1.1,2.2.2.2",
	"verify_type": "string",
	"verify_code": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» app_key	body	string	false	Authentication key
» ips	body	string	false	Whitelist IPs that need to be deleted, multiple ones separated by commas
» verify_type	body	string	false	Verification type: phone, email, wechat, totp
» verify_code	body	string	false	Verification code

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	Status message
» data	null	false	none	none

Traffic Log Query

Traffic usage is summarized by day

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/total?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/total

Parameters

Name	In	Type	Required	Description
app_key	query	string(password)	true	Authentication key
start_time	query	string(Y-m-d H:i:s)	false	Starting time, accurate to seconds. Please note that logging is delayed within 5 minutes. Default is within 7 days.
end_time	query	string(Y-m-d H:i:s)	false	Deadline, accurate to seconds. Please note that logging is delayed within 5 minutes. Default current time.
username	query	string	false	Sub-account name, query all accounts by default, sub-account can be specified. Please note that if you add a sub-account with the same name, this query will return all usage records for the agent account with the same name.
product_type	query	number	false	Package type

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» 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	Consumption traffic, unit KB

Package Query

List of purchased packages

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-product/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/list

Parameters

Name	In	Type	Required	Description
app_key	query	string(password)	true	Authentication key
trade_no	query	string	false	Order number, please enter the complete order number. Fuzzy search is not supported.
page	query	number	false	Pagination, default: 1
size	query	number	false	Number of pages displayed, default: 20
product_type	query	number	false	Package type

Example responses

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
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Package number
»»» created_at	string	false	none	Package effective time
»»» expired_at	string	false	none	The expiration time of the package. After expiration, the traffic cannot be used.
»»» 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
»»» 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	paging size
»» total_count	integer	false	none	Total number of records
»» total_page	integer	false	none	Total number of pages

Enumerated Values

Property	Value
product_type	9
product_type	11
product_type	14
product_type	25

Summary of user package data

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/user-product/summary?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/summary

Obtain statistical summary information of user packages, including total amount, effective amount, upcoming amount, expired amount, etc.

Parameters

Name	In	Type	Required	Description
app_key	query	string(password)	true	Authentication key
product_type	query	integer	false	Product type, only supports 9 (dynamic traffic package), 12 (long-term IDC traffic package)

Enumerated Values

Parameter	Value
product_type	9
product_type	12

Example responses

200 Response

{
	"code": 200,
	"msg": "success",
	"data": {
		"total": 1048576,
		"total_count": 5,
		"effective": 524288,
		"effective_count": 3,
		"effective_total": 786432,
		"effective_used": 262144,
		"temporary": 102400,
		"temporary_count": 1,
		"expired": 51200,
		"expired_count": 1,
		"used": 473088
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	object	false	none	none
»» total	integer	false	none	Traffic/Total IP volume (unit: KB)
»» total_count	integer	false	none	Total number of packages
»» effective	integer	false	none	Effective remaining amount (unit: KB)
»» effective_count	integer	false	none	Number of valid packages
»» effective_total	integer	false	none	Effective total amount (unit: KB)
»» effective_used	integer	false	none	Effective amount used (unit: KB)
»» temporary	integer	false	none	Total amount due (due within 7 days, unit: KB)
»» temporary_count	integer	false	none	Number of expiring packages (expiry within 7 days)
»» expired	integer	false	none	Expired remaining amount (unit: KB)
»» expired_count	integer	false	none	Number of expired packages
»» used	integer	false	none	Total amount used (unit: KB)

IP Extraction

Extract IP

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/v3?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/v3

Parameters

Name	In	Type	Required	Description
app_key	query	string(password)	true	access key
cc	query	string	false	Country or region
state	query	string	false	province or state
city	query	string	false	City
format	query	string	false	Get format
lb	query	string	false	Separator, only valid in text format
num	query	number	false	Extract quantity
life	query	number	false	Hold period - minutes
ep	query	string	false	proxy network

Enumerated Values

Parameter	Value
ep	us
ep	hk
ep	de

Example responses

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"
			]
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[any]	false	none	none

Dynamic regional city list V4

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dcl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dcl4

Get the city list by user name, login authentication is required, and the account must belong to the current user

Parameters

Name	In	Type	Required	Description
username	query	string	true	Proxy account username

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"cache": true,
		"list": [
			{
				"City": "Los Angeles",
				"Area": "US",
				"State": "California"
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	Status message
» data	object	false	none	none
»» cache	boolean	false	none	Whether it comes from cache
»» list	[object]	false	none	none
»»» City	string	false	none	City
»»» Area	string	false	none	area
»»» State	string	false	none	State/Province

Dynamic regional state/province list V4

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dsl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dsl4

Get the state/province list by user name, login authentication is required, and the account must belong to the current user

Parameters

Name	In	Type	Required	Description
username	query	string	true	Proxy account username

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"cache": true,
		"list": [
			{
				"City": "Los Angeles",
				"Area": "US",
				"State": "California"
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	Status message
» data	object	false	none	none
»» cache	boolean	false	none	Whether it comes from cache
»» list	[object]	false	none	none
»»» City	string	false	none	City
»»» Area	string	false	none	area
»»» State	string	false	none	State/Province

Dynamic regional state/province city fusion list V4

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dal4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dal4

Get a merged list of states/provinces and cities by username, grouped by region. Login authentication is required, and the account must belong to the current user

Parameters

Name	In	Type	Required	Description
username	query	string	true	Proxy account username

Example responses

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"cache": true,
		"list": [
			{
				"Area": "US",
				"states": [
					{
						"State": "California",
						"cities": ["Los Angeles"]
					}
				]
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	Status message
» data	object	false	none	none
»» cache	boolean	false	none	Whether it comes from cache
»» list	[object]	false	none	Area list
»»» Area	string	false	none	area code
»»» states	[object]	false	none	State/Province List
»»»» State	string	false	none	State/province name
»»»» cities	[string]	false	none	City list

City list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» 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	[any]	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

City search

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys/search?country_code=string&state=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys/search

Parameters

Name	In	Type	Required	Description
country_code	query	string	true	Country or region code
state	query	string	true	State or province code

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[string]	false	none	list

State List

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» 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	[any]	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

State/Province Search

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states/search?country_code=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states/search

Parameters

Name	In	Type	Required	Description
country_code	query	string	true	Country or region code

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 successful, 3 app_key invalid, 156 account not authenticated.
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[string]	false	none	list

Extract purchased static IP list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/get-static-ip \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-static-ip

Parameters

Name	In	Type	Required	Description
country_code	query	string	false	Country or region code
product_type	query	number	false	Product Type, 25: Static Residential IP, 14: Data Center IP
trade_no	query	string	false	Filter IP by order number
page	query	number	false	page number
size	query	number	false	Quantity per page
status	query	number	false	Status, 1: valid, 2: invalid, 3: about to expire, 4: under maintenance

Enumerated Values

Parameter	Value
product_type	14
product_type	25
status	1 - 2 - 3 - 4

Responses

Status	Meaning	Description	Schema

Get the number of static IPs for sale in the region

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/ip/static-ip-region \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/static-ip-region

Parameters

Name	In	Type	Required	Description
isp	query	integer	false	ISP filtering, no filtering if not transmitted (default is 1 except site 1/4/5)
asn	query	integer	false	Whether to return ASN packet data
exclusive	query	integer	false	Whether to count according to exclusive inventory

Detailed descriptions

isp: ISP filtering, no filtering if not transmitted (default is 1 except site 1/4/5)

value	description
0	Data Center Static IP (IDC)
1	Home Static IP (ISP)

asn: Whether to return ASN packet data

value	description
0	Do not return ASN packet data (default)
1	Return ASN packet data

exclusive: Whether to count according to exclusive inventory

value	description
0	Statistics based on current user/sharing group caliber (default)
1	Exclude all assigned IPs and only count available inventory

Enumerated Values

Parameter	Value
isp	0
isp	1
asn	0
asn	1
exclusive	0
exclusive	1

Example responses

200 Response

{
	"code": 200,
	"msg": "Request successful",
	"data": {
		"list": [
			{
				"code": "US",
				"number": 55
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	Status code, 200 success
» msg	string	false	none	Status message
» data	object	false	none	none
»» list	[any]	false	none	none
»»» code	string	false	none	Country or region code
»»» number	integer	false	none	quantity

Get host_pool supported countries/regions

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/host-pool/regions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/host-pool/regions

Query the list of countries/regions supported by the current site of the host_pool service.

This interface is oriented to the random extraction scenario of data center IP based on traffic points, and only counts countries/regions based on the data center IP inventory available at the current site. ASN, ISP, exclusive inventory filtering is not supported, and IPs are not excluded by user purchased records.

Example responses

200 Response

{
	"code": 200,
	"msg": "Request successful",
	"data": {
		"list": [
			{
				"code": "US",
				"number": 55,
				"name_zh_cn": "USA",
				"name_en": "United States",
				"square_flag": "https://example.com/static/flags/us.png"
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	Request successful	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	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, ISO 3166-1 alpha-2
»»» number	integer	false	none	Number of data center IPs available at the current site
»»» name_zh_cn	string	false	none	Country or region Chinese name
»»» name_en	string	false	none	English name of country or region
»»» square_flag	string	false	none	Square Flag Image URL

Payment Management

Get a list of payment methods

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/payment/groups \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/groups

Parameters

Name	In	Type	Required	Description
trade_no	query	undefined	false	Order number - can be passed in when some orders require a specific payment method

Example responses

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"list": [
			{
				"name": "string",
				"logos": ["string"],
				"items": [
					{
						"id": 0,
						"title": "string",
						"logo": "string",
						"group": "string",
						"disabled": false,
						"min": 0,
						"max": 0
					}
				]
			}
		]
	}
}

Responses

Status	Meaning	Description	Schema
200	OK	get success	Inline

Response Schema

Marketing

Recharge bonus ratio

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/activity/balance-recharge-gift-ratio \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/activity/balance-recharge-gift-ratio

Recharge bonus ratio

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Products

Product list

Code samples

# You can also use wget
curl -X GET https://api.proxylite.com/end-point/product \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/product

Get the list of packages available for purchase on the current site, and support filtering by type, validity period, and other conditions.

Parameters

Name	In	Type	Required	Description
type	query	integer	false	Package type, see Product.type enumeration description. If not passed, all types will be returned.
parent_product_type	query	integer	false	Parent package type, only valid when type=19 (IP renewal), used to filter product lines: 14=data center 25=residential
time_days	query	any	false	Validity period filtering, supports single value or array, such as 30 / [30,90,365]
show_type	query	any	false	Display type filtering, supports single value or array

Enumerated Values

Parameter	Value
parent_product_type	14
parent_product_type	25

Example responses

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": [
		{
			"id": 0,
			"title": "string",
			"type": 0,
			"show_type": 0,
			"status": 0,
			"price": 0.1,
			"usd_price": 0.1,
			"price_hkd": 0.1,
			"original_price": 0.1,
			"original_usd_price": 0.1,
			"original_price_hkd": 0.1,
			"local_price": 0.1,
			"local_original_price": 0.1,
			"preferred_currency": "string",
			"support_currencies": "string",
			"flow_value": 0.1,
			"flow_give": 0.1,
			"balance_give": 0.1,
			"balance_value": 0.1,
			"time_validity": 0.1,
			"time_price": 0.1,
			"time_days": 0,
			"tip1": "string",
			"tip2": "string",
			"introduce": ["string"],
			"region_list_id": 0,
			"renew_product_list": "string",
			"parent_product_type": 0,
			"total_count": 0,
			"remain_count": 0,
			"extension_of_time_days": [0],
			"time_days_price_rate": 0.1,
			"desc": {
				"subtitle": "string",
				"flow_value": 0.1,
				"flow_give": 0.1,
				"balance_give": 0.1,
				"time_validity": 0.1,
				"time_price": 0.1,
				"tip1": "string",
				"tip2": "string",
				"introduce": ["string"]
			},
			"sku": {
				"bandwidth_list": [
					{
						"id": 0,
						"value": 0,
						"price": 0.1,
						"price_usd": 0.1,
						"price_hkd": 0.1
					}
				],
				"duration_list": [
					{
						"id": 0,
						"value": 0,
						"price": 0.1,
						"price_usd": 0.1,
						"price_hkd": 0.1
					}
				],
				"concurrency_list": [
					{
						"id": 0,
						"value": 0,
						"price": 0.1,
						"price_usd": 0.1,
						"price_hkd": 0.1
					}
				]
			}
		}
	]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Schemas

productTypes

Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	Package type, 9 dynamic residential traffic package, 11 dynamic residential IP, 14 static data center IP, 25 static residential IP

Enumerated Values

Property	Value
anonymous	9
anonymous	11
anonymous	14
anonymous	25

apiKey

{}

Authentication key

Properties

None

responseCode

Status code, 200 successful, 3 app_key invalid

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	Status code, 200 successful, 3 app_key invalid

responseMsg

"success"

response message

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	response message

SuccessResponse

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

Properties

Name	Type	Required	Restrictions	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	Restrictions	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	Restrictions	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",
	"out_trade_no": "string",
	"product_id": 0,
	"product_type": 0,
	"amount": 0,
	"unit_price": 0.1,
	"total_fee": 0.1,
	"goods_fee": 0.1,
	"pay_fee": 0.1,
	"discount_fee": 0.1,
	"handling_fee": 0.1,
	"refund_fee": 0.1,
	"pm_id": 0,
	"pm_title": "string",
	"pm_logo": "string",
	"status": 0,
	"title": "string",
	"detail": "string",
	"region_desc": "string",
	"pay_at": "2019-08-24T14:15:22Z",
	"pay_timestamp": 0,
	"created_at": "2019-08-24T14:15:22Z",
	"pay_fee_status": 0,
	"invoice": {
		"name": "string",
		"org_name": "string",
		"first_name": "string",
		"last_name": "string",
		"phone": "string",
		"email": "[email protected]",
		"role_type": 0,
		"vat_id": "string",
		"address_country": "string",
		"address_city": "string",
		"address_line1": "string",
		"address_line2": "string",
		"address_postal_code": "string"
	}
}

Properties

| Name | Type | Required | Restrictions | Description | | --------------------- | ----------------- | -------- | ------------ | ------------------------------------------------------------------------------------ | ----- | ----------- | ---- | --- | --- | ---- | --- | --------------- | ---- | --- | ---- | ---- | --- | -------------------- | ---- | --- | -------- | --- | | id | integer | false | none | Order ID | | trade_no | string | false | none | Internal order number | | out_trade_no | string | false | none | External order number | | product_id | integer | false | none | Package ID | | product_type | integer | false | none | Package type, see product type enumeration | | amount | integer | false | none | Purchase quantity | | unit_price | number(float) | false | none | unit price | | total_fee | number(float) | false | none | Total order price (excluding discounts and handling fees) | | goods_fee | number(float) | false | none | Product price (including discounts, excluding handling fees) | | pay_fee | number(float) | false | none | Actual amount paid (including discounts and handling fees) | | discount_fee | number(float) | false | none | Discount amount | | handling_fee | number(float) | false | none | handling fee | | refund_fee | number(float) | false | none | Refund amount | | pm_id | integer | false | none | Payment method ID (from /end-point/payment/list) | | pm_title | string | false | none | Payment method name | | pm_logo | string | false | none | Payment method Logo URL | | status | integer | false | none | Order status
| value | description |
| --- | --- |
| 0 | Pending payment |
| 1 | Paid |
| 2 | Timeout cancellation |
| 3 | Refunded | | | title | string | false | none | Package title | | detail | string | false | none | Package description | | region_desc | string | false | none | Region specification description | | pay_at | string(date-time) | false | none | payment time | | pay_timestamp | integer | false | none | Payment timestamp | | created_at | string(date-time) | false | none | creation time | | pay_fee_status | integer | false | none | Long and short payment status: 0 normal 1 long payment (overpayment) 2 short payment | | invoice | object | false | none | Invoice information (only valuable for online payment orders) | | » name | string | false | none | full name | | » org_name | string | false | none | Company name | | » first_name | string | false | none | none | | » last_name | string | false | none | none | | » phone | string | false | none | none | | » email | string(email) | false | none | none | | » role_type | integer | false | none | 1 person 2 companies | | » vat_id | string | false | none | Tax ID number | | » address_country | string | false | none | none | | » address_city | string | false | none | none | | » address_line1 | string | false | none | none | | » address_line2 | string | false | none | none | | » address_postal_code | string | false | none | none |

OrderCheckResult

{
	"product_id": 0,
	"amount": 0,
	"discount_fee": 0.1,
	"total_fee": 0.1,
	"pay_fee": 0.1,
	"product_type": 0,
	"title": "string",
	"detail": "string",
	"ip_result": [
		{
			"ip": "string",
			"price": 0.1,
			"country_code": "string",
			"current_time": "2019-08-24T14:15:22Z",
			"renewal_time": "2019-08-24T14:15:22Z",
			"country": {
				"name_zh_cn": "string",
				"flag": "string",
				"square_flag": "string"
			}
		}
	]
}

Order pre-check results

Properties

Name	Type	Required	Restrictions	Description
product_id	integer	false	none	Package ID
amount	integer	false	none	quantity
discount_fee	number(float)	false	none	Discount amount
total_fee	number(float)	false	none	Order total
pay_fee	number(float)	false	none	Actual amount paid
product_type	integer	false	none	Package type
title	string	false	none	Package title
detail	string	false	none	Package description
ip_result	[object]	false	none	IP batch renewal results (returned only during IP renewal)
» ip	string	false	none	none
» price	number(float)	false	none	none
» country_code	string	false	none	none
» current_time	string(date-time)	false	none	none
» renewal_time	string(date-time)	false	none	none
» country	object	false	none	none
»» name_zh_cn	string	false	none	none
»» flag	string	false	none	Circle Flag URL
»» square_flag	string	false	none	Square Flag URL

Product

{
	"id": 0,
	"title": "string",
	"type": 0,
	"show_type": 0,
	"status": 0,
	"price": 0.1,
	"usd_price": 0.1,
	"price_hkd": 0.1,
	"original_price": 0.1,
	"original_usd_price": 0.1,
	"original_price_hkd": 0.1,
	"local_price": 0.1,
	"local_original_price": 0.1,
	"preferred_currency": "string",
	"support_currencies": "string",
	"flow_value": 0.1,
	"flow_give": 0.1,
	"balance_give": 0.1,
	"balance_value": 0.1,
	"time_validity": 0.1,
	"time_price": 0.1,
	"time_days": 0,
	"tip1": "string",
	"tip2": "string",
	"introduce": ["string"],
	"region_list_id": 0,
	"renew_product_list": "string",
	"parent_product_type": 0,
	"total_count": 0,
	"remain_count": 0,
	"extension_of_time_days": [0],
	"time_days_price_rate": 0.1,
	"desc": {
		"subtitle": "string",
		"flow_value": 0.1,
		"flow_give": 0.1,
		"balance_give": 0.1,
		"time_validity": 0.1,
		"time_price": 0.1,
		"tip1": "string",
		"tip2": "string",
		"introduce": ["string"]
	},
	"sku": {
		"bandwidth_list": [
			{
				"id": 0,
				"value": 0,
				"price": 0.1,
				"price_usd": 0.1,
				"price_hkd": 0.1
			}
		],
		"duration_list": [
			{
				"id": 0,
				"value": 0,
				"price": 0.1,
				"price_usd": 0.1,
				"price_hkd": 0.1
			}
		],
		"concurrency_list": [
			{
				"id": 0,
				"value": 0,
				"price": 0.1,
				"price_usd": 0.1,
				"price_hkd": 0.1
			}
		]
	}
}

Properties

| Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | id | integer | false | none | Package ID | | title | string | false | none | Package main title | | type | integer | false | none | Package type
| value | description |
| --- | --- |
| 3 | Balance recharge |
| 9 | Dynamic residential traffic package |
| 10 | Dynamic global package package |
| 11 | Customized dynamic global package V2 (including SKU) |
| 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 Residential IP Package |
| 19 | Static IP Renewal Package |
| 20 | Static IP replacement qualifications |
| 21 | Static Residential IP Package |
| 24 | Static traffic add-on package |
| 25 | Static IP rate package | | | show_type | integer | false | none | Display type: 1 Ordinary 2 Large recommendation 3 Not available for purchase (needs customization) 4 Trial | | status | integer | false | none | Status: 1 on the shelves 0 off the shelves | | price | number(float) | false | none | RMB price | | usd_price | number(float) | false | none | dollar price | | price_hkd | number(float) | false | none | Hong Kong dollar price | | original_price | number(float) | false | none | Original price (CNY) | | original_usd_price | number(float) | false | none | Original price (USD) | | original_price_hkd | number(float) | false | none | Original price (HKD) | | local_price | number(float) | false | none | Localized price (depends on preferred_currency) | | local_original_price | number(float) | false | none | Localized original price (depends on preferred_currency) | | preferred_currency | string | false | none | It is recommended to display the currency, such as usd / cny / hkd | | support_currencies | string | false | none | List of supported currencies, separated by commas, such as usd, cny | | flow_value | number(float) | false | none | Default traffic of data plan (GB) | | flow_give | number(float) | false | none | Free traffic (GB) | | balance_give | number(float) | false | none | Balance recharge bonus | | balance_value | number(float) | false | none | Recharge amount | | time_validity | number(float) | false | none | The default validity period of standard plans | | time_price | number(float) | false | none | Standard package price per IP | | time_days | integer | false | none | Number of days of validity, such as 30/90/180/365 | | tip1 | string | false | none | Label description 1 | | tip2 | string | false | none | Label description 2 | | introduce | [string] | false | none | Text introduction list | | region_list_id | integer | false | none | Region ID | | renew_product_list | string | false | none | List of renewable package IDs (comma separated) | | parent_product_type | integer | false | none | Parent package type (valid when type=19): 14 or 25 | | total_count | integer | false | none | Total inventory, 0 means no limit | | remain_count | integer | false | none | remaining stock | | extension_of_time_days | [integer] | false | none | List of duration multiples. If it is empty or contains only 1, it means it is not supported. | | time_days_price_rate | number(float) | false | none | Duration price coefficient, price × (1 + (multiply-1) × rate) | | desc | object | false | none | Package description information | | » subtitle | string | false | none | subtitle | | » flow_value | number(float) | false | none | none | | » flow_give | number(float) | false | none | none | | » balance_give | number(float) | false | none | none | | » time_validity | number(float) | false | none | none | | » time_price | number(float) | false | none | none | | » tip1 | string | false | none | none | | » tip2 | string | false | none | none | | » introduce | [string] | false | none | none | | sku | object | false | none | Specification parameters (returned when type=11) | | » bandwidth_list | [object] | false | none | Bandwidth specification list | | »» id | integer | false | none | none | | »» value | integer | false | none | Bandwidth value (Mbps) | | »» price | number(float) | false | none | none | | »» price_usd | number(float) | false | none | none | | »» price_hkd | number(float) | false | none | none | | » duration_list | [object] | false | none | Duration specification list | | »» id | integer | false | none | none | | »» value | integer | false | none | Duration (days) | | »» price | number(float) | false | none | none | | »» price_usd | number(float) | false | none | none | | »» price_hkd | number(float) | false | none | none | | » concurrency_list | [object] | false | none | Concurrency specification list | | »» id | integer | false | none | none | | »» value | integer | false | none | Number of concurrencies | | »» price | number(float) | false | none | none | | »» price_usd | number(float) | false | none | none | | »» price_hkd | number(float) | false | none | none |

WhiteIp

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

Properties

Name	Type	Required	Restrictions	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	Restrictions	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	Restrictions	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	Restrictions	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	Restrictions	Description
total	integer	false	none	none
page_no	integer	false	none	none
page_size	integer	false	none	none
total_pages	integer	false	none	none