Skip to content

List available countries

GET
/locations/countries
curl --request GET \
--url 'https://api.proxyrequest.com/api/v1/locations/countries?package_id=550e8400-e29b-41d4-a716-446655440002' \
--header 'Authorization: Bearer <token>'

Returns countries supported by the selected package, including targetable ISPs and autonomous system numbers when available.

code
string
limit
integer

Number of results to return per page.

name
string
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

package_id
string format: uuid

Package whose targeting availability should be returned. Required when package-based authentication is enabled.

Examples
ExampleResidentialPackage

Residential package

550e8400-e29b-41d4-a716-446655440002
search
string

Case-insensitive partial search across Country fields: code and name. Separate multiple terms with spaces or commas; every term must match at least one listed field.

The operation completed successfully.

Media typeapplication/json
object
count
required
integer
next
string format: uri
nullable
previous
string format: uri
nullable
results
required
Array<object>
object
id
string
<= 36 characters
code
required
ISO 3166-1 Alpha-2 Code

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

string
<= 10 characters
name
required

English display name of the country used across the admin and API responses.

string
<= 255 characters
original_name

Native-language name of the country as it appears in the source data. Deutschland Français

string
<= 255 characters
isps
required
Array<object>
object
code
required
string
name
required
string
asns
required
Array<object>
object
code
required
string
name
required
string
Examples
ExampleAvailableCountries

Available countries

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "us",
"code": "us",
"name": "United States",
"original_name": "United States",
"isps": [
{
"code": "comcast",
"name": "Comcast Cable"
}
],
"asns": [
{
"code": "7922",
"name": "Comcast Cable Communications"
}
]
}
]
}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleValidationError

Validation error

{
"non_field_errors": [
"The request could not be processed."
],
"translation": "errors.request.invalid"
}

Authentication credentials are missing, expired, or invalid.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}

The authenticated account cannot perform this operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}