List and filter cities

get

https://api.referential.io/v1/city

Get a list of up to 1000 cities matching optional query filter critiera in the specified language sorted alphabetically by name

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

search by ame using 'contains' in the specified language, english by default

prefix

string

search by name using "begins with" in the specified language, english by default

iso_a2

string

search by exact match two letter iso a2 country code

lang

string

Defaults to en

two letter iso code in what language to return results in, if available, otherwise in english

state_code

string

search by exact match on state code of city. It is not neccessary to use iso_a2 country code when using state_code.

timezone

string

search by timezone name

state_hasc

string

search by exact match hasc state code of city

string

ip address v4 or v6 of the resource you want to locate

sort

string

sort by field of results. one of population, name, timezone, state_code, state_hasc, iso_a2

limit

integer

1 to 1000

integer limit of results returned. 1000 max.

order

string

enum

Defaults to asc

sort direction of results by value of 'sort' field. one of asc or desc.

Allowed:

fields

string

enum

Defaults to id,name

comma delimited list of additional fields to return for in result. By default returns name in chosen language

Allowed:

Responses

404

The query has no results. Check your parameters in case there are any spelling issues. The language requested may not be supported.

5XX

Server error, probably a bug.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response