Skip to content

Get a region

GET
/locations/regions/{id}
curl --request GET \
--url https://api.proxyrequest.com/api/v1/locations/regions/example \
--header 'Authorization: Bearer <token>'

Returns one region and its available network targeting options.

id
required
string

The operation completed successfully.

Media typeapplication/json
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
ExampleRegion
{
"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>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
Exampleexample

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."
}

The requested resource does not exist in the current account scope.

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
ExampleResourceNotFound

Resource not found

{
"detail": "Not found."
}