Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
City

Search City

Search City entries using various filters.

get/public/user/city/search

Query parameters

city_idstring

ID of the City

city_namestring

Name of the City

subdivision_idstring

ID of the Subdivision which the City is in

city_timezonestring

Timezone of the City

city_is_populousboolean

Whether the City one of the ten largest cities in its timezone with atleast 300,000 population

city_aliasstring

Indentifier of the city when used in backconnect proxy

city_example_postcodestring

Example postcode of the City

city_latitudestring

Latitude of the City

city_longitudestring

Longitude of the City

city_node_countinteger

Current number of online nodes in the City

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful City search

item_countinteger

Total number of City items returned in the data field.

messagestring

Status message for the search.

pageinteger

Current page number of the search results returned.

per_pageinteger

Number of City items returned per page.

total_countinteger

Total of City items that match the search filter.

Example response

{
  "data": [
    {
      "city_alias": "City of Lights",
      "city_example_postcode": "75004",
      "city_id": 379657,
      "city_is_populous": true,
      "city_latitude": 48.85341,
      "city_longitude": 2.3488,
      "city_name": "Paris",
      "city_node_count": 9320,
      "city_population": 2138551,
      "city_timezone": "Europe/Paris",
      "subdivision_id": "Ile-de-France"
    }
  ],
  "item_count": 1,
  "message": "City search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}