Understanding the City object and its role in the Ping Proxies API
Attribute | Type | Description |
---|---|---|
city_id | integer | Unique identifier for the city |
city_name | string | Full name of the city (e.g., “Paris”) |
city_alias | string | Human-friendly unique identifier for the city (e.g., “city_of_lights”) |
city_latitude | number | Latitude coordinates of the city |
city_longitude | number | Longitude coordinates of the city |
city_timezone | string | Timezone of the city (e.g., “Europe/Paris”) |
city_population | integer | Population of the city |
city_is_populous | boolean | Indicates if the city is among the populous cities in its region |
city_example_postcode | string | Example postal/zip code for the city |
subdivision_id | string | ID of the subdivision (state/province) where the city is located |
Endpoint | Description |
---|---|
GET /public/user/city/retrieve/{city_id} | Retrieve a specific city by ID |
GET /public/user/city/search | Search cities using various filters |
GET /public/user/residential/list?city_alias={city_alias} | Generate residential proxies for a specific city |
city_alias
is particularly important for residential proxy targetingcity_is_populous
flag indicates cities that are among the top ten largest in their timezone with at least 300,000 populationcity_is_populous
set to truecity_timezone
attribute is useful for time-sensitive operations that need to account for local timecountry_id
parameter or by subdivision using the subdivision_id
parameter