View Categories

List Static Proxy

What this endpoint does

Use this endpoint to retrieve the static proxy nodes associated with your account. The response includes connection details, network type, country or region, purchase time, expiration time, and auto-renewal status.

Endpoint

GET /openapi/static/node/list

Full URL:

https://{domain}/openapi/static/node/list

Include your user-id and access-key in the request headers.

Query parameters

ParameterRequiredTypeDescription
node_idNostringA proxy ID. To request multiple nodes, separate their IDs with commas.
page_noNointPage number. The default is 1.
page_limitNointNumber of records per page. The default is 100, and the maximum is 100.

Retrieve the first page with up to 20 records:

GET /openapi/static/node/list?page_no=1&page_limit=20 HTTP/1.1
Host: {domain}
client-id: {your-user-id}
access-key: {your-access-key}

Retrieve a specific proxy:

GET https://{domain}/openapi/static/node/list?node_id={node-id}

Retrieve multiple specific proxies:

GET https://{domain}/openapi/static/node/list?node_id={node-id-1},{node-id-2}

Response fields

Node records are returned in the info.items array.

FieldTypeDescription
node_idstringThe proxy ID.
network_typeintNetwork type: 1 for datacenter IPv4, 2 for IPv6, and 3 for residential IPv4.
region_idintThe product ID.
endpoint_hoststringThe host used to establish the proxy connection.
display_ipstringThe IP address displayed for the node.
endpoint_portstringThe proxy connection port.
access_userstringThe proxy authentication username.
access_secretstringThe proxy authentication password.
link_typestringThe connection protocol, such as http or socks5.
auto_renewintThe auto-renewal status, returned as 0 or 1.
valid_untilintThe expiration time as a Unix timestamp in seconds.
acquired_atintThe purchase time as a Unix timestamp in seconds.
geo_codestringThe country or region code.
memostringA note associated with the node.

Example response

The IP address and credentials below are examples only:

{
  "code": 0,
  "msg": "Ok",
  "info": {
    "items": [
      {
        "node_id": "xK9mP2nQ",
        "network_type": 1,
        "region_id": 101,
        "endpoint_host": "1.2.3.4",
        "display_ip": "1.2.3.4",
        "endpoint_port": "10001",
        "access_user": "user_abc",
        "access_secret": "pass_xyz",
        "link_type": "http",
        "auto_renew": 0,
        "valid_until": 1756656000,
        "acquired_at": 1754064000,
        "geo_code": "US",
        "memo": "note"
      }
    ],
    "item_total": 1,
    "page_no": 1,
    "page_limit": 20
  }
}

Use the returned connection details

You will normally need the following fields to connect to a proxy:

  • Host: endpoint_host
  • Port: endpoint_port
  • Username: access_user
  • Password: access_secret
  • Protocol: link_type

The access_secret field contains sensitive information. Avoid writing complete node responses to public or unsecured logs.

Pagination

If item_total is greater than the number of records you have retrieved, increase page_no to request the next page. The maximum supported page_limit is 100.