List available regions

GET

/locations/regions

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept-Language: de");
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.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002"),
    Headers =
    {
        { "Accept-Language", "de" },
        { "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.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002"

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

  req.Header.Add("Accept-Language", "de")
  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.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002"))
    .header("Accept-Language", "de")
    .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.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002")
  .get()
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .build();

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

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.proxyrequest.com/api/v1/locations/regions',
  params: {include_asns: 'true', package_id: '550e8400-e29b-41d4-a716-446655440002'},
  headers: {'Accept-Language': 'de', Authorization: 'Bearer <token>'}
};

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

const url = 'https://api.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002';
const options = {
  method: 'GET',
  headers: {'Accept-Language': 'de', 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.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002")
  .get()
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .build()

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

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.proxyrequest.com/api/v1/locations/regions";

    let querystring = [
        ("include_asns", "true"),
        ("package_id", "550e8400-e29b-41d4-a716-446655440002"),
    ];

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Accept-Language", "de".parse().unwrap());
    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.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002' \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>'

wget --quiet \
  --method GET \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --output-document \
  - 'https://api.proxyrequest.com/api/v1/locations/regions?include_asns=true&package_id=550e8400-e29b-41d4-a716-446655440002'

Returns regions supported by the selected package and country, including targetable ISPs. The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

Authorizations

BearerAuth
StaticAuth

Parameters

Query Parameters

code

string

country__code

string

include_asns

boolean

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

Examples

IncludeASNs

Include ASNs

true

limit

integer

Number of results to return per page.

max_count

integer

<= 18446744073709552000

Inclusive maximum node count in the published location dictionary. Either bound may be omitted. Decimal digits only, with surrounding whitespace ignored; empty values, signs, fractions, overflow and min_count > max_count return 400. Unknown counts are zero. Filters primary records before ordering/pagination; nested networks, parents and ASN geo are unchanged. A detail outside the range returns 404. Counts describe dictionary membership, not live node health.

min_count

integer

<= 18446744073709552000

Inclusive minimum node count in the published location dictionary. Either bound may be omitted. Decimal digits only, with surrounding whitespace ignored; empty values, signs, fractions, overflow and min_count > max_count return 400. Unknown counts are zero. Filters primary records before ordering/pagination; nested networks, parents and ASN geo are unchanged. A detail outside the range returns 404. Counts describe dictionary membership, not live node health.

name

string

offset

integer

The initial index from which to return the results.

ordering

string

Comma-separated fields: id, code, name, original_name, iso31662. Prefix a field with - for descending order. Unsupported fields are ignored. Name ordering follows the catalog collation.

package_id

required

string format: uuid

Package whose targeting availability should be returned.

Examples

ResidentialPackage

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.

Header Parameters

Accept-Language

string

default: en

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

Examples

de

fr-CA, fr;q=0.9, en;q=0.5

Responses

200

The operation completed successfully.

application/json

object

count

required

integer

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

object

count

required

Node count in Rust search mode.

integer

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

count

required

Node count in Rust search mode; unknown quantities are zero.

integer

code

required

string

name

required

string

original_name

string

isps

required

Array<object>

object

count

required

Node count in Rust search mode; unknown quantities are zero.

integer

code

required

string

name

required

string

asns

required

Array<object>

object

count

required

Node count in Rust search mode; unknown quantities are zero.

integer

code

required

string

name

required

string

Examples

AvailableRegions

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",
        "count": 100
      },
      "isps": [
        {
          "code": "comcast",
          "name": "Comcast Cable",
          "count": 100
        }
      ],
      "asns": [],
      "count": 100
    }
  ]
}

Headers

X-Locations-Generation

string

Published dictionary generation used for this response.

Cache-Control

string

Location search responses use no-store.

400

The request is malformed or violates a business rule.

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

string

Examples

ValidationError

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ]
}

Headers

Content-Language

string

Language used for human-readable errors.

401

Authentication credentials are missing, expired, or invalid.

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

string

Examples

AuthenticationRequired

Authentication required

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

Headers

Content-Language

string

Language used for human-readable errors.

403

The authenticated account cannot perform this operation.

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

string

Examples

PermissionDenied

Permission denied

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

Headers

Content-Language

string

Language used for human-readable errors.

503

Location search is unavailable or its published index is not ready. Retry later.

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

string

Examples

LocationSearchUnavailable

Location search unavailable

{
  "detail": "Location search is temporarily unavailable."
}

Headers

Content-Language

string

Language used for human-readable errors.