OpenAPI Documentation
OpenAPI Documentation

List Static Proxy Resources

Returns a paginated list of all static proxy resources under the current account that match the filters, regardless of the channel through which they were created. The response includes proxy account credentials and passwords.

API Information

Item Value
Method GET
Path /open-api/v1/static/resources
Authentication X-API-Key
Processing Synchronous

Query Parameters

Parameter Type Required Description
static_type string No ISP or ISP_NATIVE
region_code string No Exact region-code match; must not be an empty string
resource_status string No ACTIVE or EXPIRED
expire_time_start string No Inclusive lower bound for expiration time, with Z or an explicit offset
expire_time_end string No Inclusive upper bound for expiration time, with Z or an explicit offset
ip_keyword string No IP address prefix; after trimming leading and trailing whitespace, it must be 1–64 characters and contain only 0-9, A-F, a-f, ., and :
page_no integer No Defaults to 1; must be at least 1
page_size integer No Defaults to 20; range: 1100

The start time must not be later than the end time. ip_keyword performs a prefix match, not a contains match at an arbitrary position.

Request Example

curl --request GET \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/static/resources?static_type=ISP&resource_status=ACTIVE&page_no=1&page_size=20' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>' \
  --header 'X-LANG: en_US'

Response Fields

data uses the pagination structure. Each element in list contains the fields below.

Results may include resources with an HTTP or SOCKS5 protocol. Resources purchased through this Open API always use HTTP.

Field Type Nullable Description
id string No Static proxy resource ID
static_type string No ISP or ISP_NATIVE
region_code string No Region code
region_name string No Region name corresponding to X-LANG
host string Yes Proxy connection host
ip string No Static proxy IP address
port integer No Proxy connection port
account string Yes Proxy account credential; sensitive information
password string Yes Proxy password; sensitive information
protocol string No HTTP or SOCKS5
resource_status string No ACTIVE or EXPIRED
buy_time string No Purchase time in GMT+8 ISO-8601 format
expire_time string No Current expiration time in GMT+8 ISO-8601 format
create_time string No Resource creation time in GMT+8 ISO-8601 format
update_time string No Resource update time in GMT+8 ISO-8601 format

Successful Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "id": "1912345678901234568",
        "static_type": "ISP",
        "region_code": "107",
        "region_name": "United States",
        "host": "203.0.113.10",
        "ip": "203.0.113.10",
        "port": 8000,
        "account": "proxy_user",
        "password": "example-secret",
        "protocol": "HTTP",
        "resource_status": "ACTIVE",
        "buy_time": "2026-08-24T15:30:00.000+08:00",
        "expire_time": "2026-09-23T15:30:00.000+08:00",
        "create_time": "2026-08-24T15:35:00.000+08:00",
        "update_time": "2026-08-24T15:35:00.000+08:00"
      }
    ],
    "total": 1,
    "page_no": 1,
    "page_size": 20
  },
  "next": null
}

A resource may appear in this list as soon as it has been generated and meets the filters. This differs from purchase-order details, which return all resources only after the entire order is completed.

Possible Error Codes

code Description
400001 Authentication failed
400009 The filters, time range, IP prefix, pagination, or another parameter does not meet the requirements
500000 System processing failed and the request was not completed

The response includes proxy account credentials and passwords. Do not cache them or write them to ordinary logs.

On this page