OpenAPI Documentation
OpenAPI Documentation
List Static Proxy Regions
Returns the currently available static proxy types and regions. Results are returned as a flat list without country, state/province, or city hierarchy.
API Information
| Item | Value |
|---|---|
| Method | GET |
| Path | /open-api/v1/static/regions |
| Authentication | X-API-Key |
| Processing | Synchronous |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
static_type |
string | No | ISP (static residential proxy) or ISP_NATIVE (static native proxy); omit to return all types |
Region names are returned according to X-LANG.
Request Example
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/static/regions?static_type=ISP' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>' \
--header 'X-LANG: en_US'
Response Fields
data is an array of regions.
| Field | Type | Description |
|---|---|---|
static_type |
string | ISP or ISP_NATIVE |
region_code |
string | Static proxy region code |
name |
string | Region name corresponding to X-LANG |
Successful Response Example
{
"code": 0,
"msg": "success",
"data": [
{
"static_type": "ISP",
"region_code": "107",
"name": "United States"
}
],
"next": null
}
The region shown is only an example of the format. When purchasing, use the type and region code returned by the endpoint in real time.
Possible Error Codes
code |
Description |
|---|---|
400001 |
Authentication failed |
400009 |
The static type or another parameter does not meet the requirements |
500000 |
System processing failed and the request was not completed |