Skip to content

List available regions

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

Returns regions supported by the selected package and country, including targetable ISPs and autonomous system numbers.

code
string
country__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
required
string format: uuid

Package whose targeting availability should be returned.

Examples
ExampleResidentialPackage

Residential package

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

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

Accept-Language
string
default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Examples
de

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

Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france

string
<= 255 characters
iso31662
ISO 3166-2

ISO 3166-2 subdivision code for this region. US-CA FR-IDF

string
<= 10 characters
name
required

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

string
<= 255 characters
original_name

Native-language name of the region as it appears in the source data.

string
<= 255 characters
country
required
object
code
required
string
name
required
string
original_name
string
isps
required
Array<object>
object
code
required
string
name
required
string
asns
required
Array<object>
object
code
required
string
name
required
string
Examples
ExampleAvailableRegions

Available regions

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "us-ca",
"code": "california",
"iso31662": "US-CA",
"name": "California",
"original_name": "California",
"country": {
"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>
key
additional properties
One of:
string
Examples
ExampleValidationError

Validation error

{
"non_field_errors": [
"The request could not be processed."
]
}
Content-Language
string

Language used for human-readable errors.

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>
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}
Content-Language
string

Language used for human-readable errors.

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>
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}
Content-Language
string

Language used for human-readable errors.