Skip to main content
cURL
Read a paginated list of residential proxy assets for the authenticated account. This endpoint retrieves existing assets; it does not purchase, renew, or generate proxies.

Query existing assets

  1. Obtain a token from Log in and enter it as the Bearer credential.
  2. Set pagination and any required status, product type, location, keyword, or sorting filters using the parameters below.
  3. Send the request, check the HTTP and business results, then inspect the returned page and total before requesting the next page with the same filters.
Choose Vid and IspType from their documented enumerations. Keep IspType=0 when you intend that filter value; zero is a valid choice, not an empty field. Sorting supports the documented fields and asc or desc order. Omitting an optional filter differs from supplying a filter value. The form’s pagination bounds come from the current public interface. Use the static residential quick start to manage purchased IPs in the dashboard, and see API response handling for errors.

Online debugging

Source: official residential asset reference.

Authorizations

Authorization
string
header
required

Use token from the login response in the Authorization: Bearer header. The source does not specify token lifetime or refresh behavior.

Query Parameters

PageNo
integer
required

Page number starting at 1.

Example:

1

PageSize
integer
required

Number of records per page.

Example:

10

IspType
enum<integer>

-1 returns all; 0 is exclusive; 1 is shared.

Available options:
-1,
0,
1
Example:

-1

Vid
enum<string>

Inventory status filter.

Available options:
all,
new,
valid,
exp,
expiringsoon
Example:

"all"

IspLocation
string

Optional ISP location filter.

KeyWord
string

Search by IP or related identifier.

SortField
enum<string>

Optional created-time or expiry-time sorting.

Available options:
sysCreateTime,
expireTime
SortOrder
enum<string>

Optional. Omit it for the current default ascending behavior.

Available options:
asc,
desc

Response

Paged ISP inventory

code
integer
message
string
body
object