DocumentationAPI DetailsAvailable Cities

Available Cities

Retrieve a list of all cities available for proxy geotargeting within a specific country. Each response includes city names and corresponding keys that can be used as the proxyCity parameter in scrape requests.

When To Use This

  • City-level geotargeting - When country-level targeting isn’t specific enough and you need requests to originate from a particular city (e.g., comparing prices between New York and Los Angeles).
  • Dynamic city selection - Build integrations that let users select from available cities rather than guessing valid values.
  • Verifying availability - Check which cities are available in your target country before sending scrape requests.

Tip: You can always supply any relevant city name in the proxyCity parameter - a proxy for that city will be attempted even if it doesn’t appear in this list. Use this endpoint to see guaranteed-available options.

OpenAPI Specification

https://api.scrapi.tech/scalar/v1#tag/country/get/v1countriescountrykeycities

Endpoint

GET https://api.scrapi.tech/v1/countries/{countryKey}/cities

The countryKey is an ISO 3166-1 alpha-3 country code (e.g., ZAF, USA, GBR). Get available country codes from the Available Countries endpoint.

JSON Response

The response is an array of city objects, each with a display name and a key for use in the proxyCity parameter:

[
  {
    "name": "Alberton",
    "key": "ALBERTON"
  },
  {
    "name": "Jeffreys Bay",
    "key": "JEFFREYSBAY"
  },
  {
    "name": "Cape Town",
    "key": "CAPETOWN"
  },
  ...
]