OpenAPI Documentation
OpenAPI Documentation

Get Static Proxy Inventory

Returns the current available quantity for a static proxy type and region.

API Information

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

Query Parameters

Parameter Type Required Description
static_type string Yes ISP (static residential proxy) or ISP_NATIVE (static native proxy)
region_code string Yes Region code returned by the static proxy regions endpoint

Request Example

curl --request GET \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/static/inventory?static_type=ISP&region_code=107' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>'

Response Fields

Field Type Description
static_type string ISP or ISP_NATIVE
region_code string Region code
available_quantity integer Current available quantity; 0 means no stock is currently available
in_stock boolean Whether inventory is available
checked_time string Time of this inventory check in GMT+8 ISO-8601 format

Successful Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "static_type": "ISP",
    "region_code": "107",
    "available_quantity": 25,
    "in_stock": true,
    "checked_time": "2026-08-24T15:30:00.000+08:00"
  },
  "next": null
}

Inventory can change. A query result does not reserve inventory; availability is checked again when an order is created.

Possible Error Codes

code Description
300323 The specified type and region are currently unavailable
300324 Real-time inventory is temporarily unavailable
400001 Authentication failed
400009 The type, region, or another parameter does not meet the requirements
500000 System processing failed and the request was not completed

On this page