Skip to content

List residential countries

GET
/proxies/residential/locations/countries
curl --request GET \
--url 'https://api.ltesocks.io/v2/proxies/residential/locations/countries?page=1&page_size=25' \
--header 'Authorization: Bearer <token>'

Search available countries by name or code. country_code selects one exact country. Uses page/page_size pagination with a maximum page_size of 100. Requires the proxy.residential.locations.countries token ability or a wildcard token.

country_code
string
<= 128 characters

Country targeting code returned by countries. Matching is case insensitive.

search
string
<= 128 characters

Search by entity name or code.

page
integer
default: 1 >= 1

Page number, starting at 1.

page_size
integer
default: 25 >= 1 <= 100

Number of records per page.

Matching targeting options from the active residential provider. Unknown countries or regions and pages beyond the last page return an empty data array.

Media typeapplication/json
object
success
required
boolean
code
required
integer
data
required
Array<object>
object
code
required

Targeting code; use the exact value returned by the API.

string
name
required
string
page_info
required
object
page
required
integer
>= 1
page_size
required
integer
>= 1 <= 100
total_count
required

Number of matching records before pagination.

integer
Example
{
"success": true,
"code": 200,
"page_info": {
"page": 1,
"page_size": 25,
"total_count": 1
}
}

Missing or invalid bearer token.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Validation errors by query parameter, present for HTTP 422.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422
}

Token does not grant proxy.residential.locations.countries.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Validation errors by query parameter, present for HTTP 422.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422
}

Invalid query parameters or missing required country_code.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Validation errors by query parameter, present for HTTP 422.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422
}

Request rate limit exceeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Validation errors by query parameter, present for HTTP 422.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422
}

Internal service or upstream failure.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Validation errors by query parameter, present for HTTP 422.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422
}

Residential provider returned invalid data.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Validation errors by query parameter, present for HTTP 422.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422
}

Residential provider is unavailable.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Validation errors by query parameter, present for HTTP 422.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422
}