List available cities

GET

/locations/cities

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/cities?package_id=550e8400-e29b-41d4-a716-446655440002");

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.proxyrequest.com/api/v1/locations/cities?package_id=550e8400-e29b-41d4-a716-446655440002"),
    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.proxyrequest.com/api/v1/locations/cities?package_id=550e8400-e29b-41d4-a716-446655440002"

  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.proxyrequest.com/api/v1/locations/cities?package_id=550e8400-e29b-41d4-a716-446655440002"))
    .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/cities?package_id=550e8400-e29b-41d4-a716-446655440002")
  .get()
  .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/cities',
  params: {package_id: '550e8400-e29b-41d4-a716-446655440002'},
  headers: {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/cities?package_id=550e8400-e29b-41d4-a716-446655440002';
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.proxyrequest.com/api/v1/locations/cities?package_id=550e8400-e29b-41d4-a716-446655440002")
  .get()
  .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/cities";

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

    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.proxyrequest.com/api/v1/locations/cities?package_id=550e8400-e29b-41d4-a716-446655440002' \
  --header 'Authorization: Bearer <token>'

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

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

Authorizations

BearerAuth
StaticAuth

Parameters

Query Parameters

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

string format: uuid

Package whose targeting availability should be returned. Required when package-based authentication is enabled.

Examples

ResidentialPackage

Residential package

550e8400-e29b-41d4-a716-446655440002

region__code

string

search

string

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

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

string

<= 36 characters

code

required

Raw city code as it appears in the source data. los_angeles paris

string

<= 255 characters

name

required

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

string

<= 255 characters

country

required

object

code

required

string

name

required

string

original_name

string

region

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

AvailableCities

Available cities

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "us-ca-los-angeles",
      "code": "los_angeles",
      "name": "Los Angeles",
      "country": {
        "code": "us",
        "name": "United States",
        "original_name": "United States"
      },
      "region": {
        "code": "california",
        "name": "California",
        "original_name": "California"
      },
      "isps": [
        {
          "code": "spectrum",
          "name": "Spectrum"
        }
      ],
      "asns": [
        {
          "code": "20001",
          "name": "Charter Communications"
        }
      ]
    }
  ]
}

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>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

ValidationError

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ],
  "translation": "errors.request.invalid"
}

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>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

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

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>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

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