API Static proxies
API Static proxies
Get Static Proxy Inventory
Get real-time available quantities for multiple regions under one static proxy type. Results are returned in the same order as the requested regions.
API information
| Item | Value |
|---|---|
| Method | POST |
| Path | /open-api/v1/static/inventory |
| Authentication | X-API-Key |
| Content-Type | application/json |
| Processing | Synchronous |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
static_type |
string | Yes | ISP (static residential proxy) or ISP_NATIVE (static native proxy) |
region_codes |
string[] | Yes | Region codes returned by the static proxy region API; the array must not be empty or contain blank or duplicate values |
The previous GET request and single region_code field are no longer supported. The request body must not contain fields that are not listed above.
Request example
curl --request POST \
--url 'https://api.puraroute.com/gin/open-api/v1/static/inventory' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>' \
--data '{
"static_type": "ISP",
"region_codes": ["US_CA", "JP_TK"]
}'
Response fields
data is an array whose elements follow the order of region_codes.
| Field | Type | Description |
|---|---|---|
static_type |
string | ISP or ISP_NATIVE |
region_code |
string | Region code |
available_quantity |
integer | Real-time available quantity; 0 means no inventory is currently available or inventory for this region could not be obtained in this request |
in_stock |
boolean | Whether inventory is available |
checked_time |
string | Inventory check time in GMT+8 ISO-8601 format |
Success response example
{
"code": 0,
"msg": "success",
"data": [
{
"static_type": "ISP",
"region_code": "US_CA",
"available_quantity": 25,
"in_stock": true,
"checked_time": "2026-08-24T15:30:00.000+08:00"
},
{
"static_type": "ISP",
"region_code": "JP_TK",
"available_quantity": 0,
"in_stock": false,
"checked_time": "2026-08-24T15:30:00.000+08:00"
}
],
"next": null
}
Inventory may change, and this request does not reserve it. Inventory is checked again when an order is created.
Possible error codes
code |
Description |
|---|---|
300323 |
The specified type or region is currently unavailable |
400001 |
Authentication failed |
400009 |
The method, type, region list, or request body is invalid |
500000 |
System processing failed and the request was not completed |