List residential regions

GET

/proxies/residential/locations/regions

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.ltesocks.io/v2/proxies/residential/locations/regions?country_code=example&page=1&page_size=25");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.ltesocks.io/v2/proxies/residential/locations/regions?country_code=example&page=1&page_size=25"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.ltesocks.io/v2/proxies/residential/locations/regions?country_code=example&page=1&page_size=25"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.ltesocks.io/v2/proxies/residential/locations/regions?country_code=example&page=1&page_size=25"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.ltesocks.io/v2/proxies/residential/locations/regions?country_code=example&page=1&page_size=25")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.ltesocks.io/v2/proxies/residential/locations/regions',
  params: {country_code: 'example', page: '1', page_size: '25'},
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.ltesocks.io/v2/proxies/residential/locations/regions?country_code=example&page=1&page_size=25';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.ltesocks.io/v2/proxies/residential/locations/regions?country_code=example&page=1&page_size=25")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build()

val response = client.newCall(request).execute()

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.ltesocks.io/v2/proxies/residential/locations/regions";

    let querystring = [
        ("country_code", "example"),
        ("page", "1"),
        ("page_size", "25"),
    ];

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .query(&querystring)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

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

wget --quiet \
  --method GET \
  --header 'Authorization: Bearer <token>' \
  --output-document \
  - 'https://api.ltesocks.io/v2/proxies/residential/locations/regions?country_code=example&page=1&page_size=25'

List regions belonging to country_code. Search matches a region name or code. Uses page/page_size pagination with a maximum page_size of 100. Requires the proxy.residential.locations.regions token ability or a wildcard token.

Authorizations

bearerAuth

Parameters

Query Parameters

country_code

required

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.

Responses

200

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

application/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

country_code

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

401

Missing or invalid bearer token.

application/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
}

403

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

application/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
}

422

Invalid query parameters or missing required country_code.

application/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
}

429

Request rate limit exceeded.

application/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
}

500

Internal service or upstream failure.

application/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
}

502

Residential provider returned invalid data.

application/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
}

503

Residential provider is unavailable.

application/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
}