Country
Updated:
Returns the countries available for a given proxy type. Use this before Create an order to validate country selection.
ISP uses a different base path. While IPv4, IPv6, and MOBILE use /client/api/v1/, ISP requests go to /users/client/api/v1/.
Endpoint:
GET/client/api/v1/{apiKey}/country
Path parameters
Name | Type | Description |
|---|---|---|
apiKey* | String | Your personal API key. |
Query parameters
Name | Type | Description |
|---|---|---|
proxyType* | String | Which proxy type to list countries for. Country availability differs by type: |
Examples
GET/client/api/v1/$KEY/country?proxyType=IPv4
GET/client/api/v1/$KEY/country?proxyType=IPv6
GET/client/api/v1/$KEY/country?proxyType=MOBILE
GET/client/api/v1/$KEY/country?proxyType=ISP
Response
{
"success": true,
"countries": [
{ "name": "Egypt", "alpha3code": "EGY" },
{ "name": "Australia", "alpha3code": "AUS" }
],
"error": null
}{
"success": false,
"countries": [],
"error": {
"code": 4,
"message": "Incorrect proxy type"
}
}