Get cities

GET

/v1/cities

Provides a list of cities supported by the platform

Parameters

Query Parameters

limit

Any of:

integer

integer

null

null

Change the number of results returned. e.g. limit=1000 will return up to 1000 results

page

Any of:

integer

integer

null

null

Paginate through results. e.g. page=1 will return first page of results

offset

Any of:

integer

integer

null

null

sort

Any of:

Sort

string

Allowed values: asc desc

null

null

Define sort order. e.g. ?sort=asc

order_by

Order by a field e.g. ?order_by=city

string

Allowed values: city country locations count

Order by a field e.g. ?order_by=city

country

Any of:

Array<string>

Array<string>

null

null

Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX

Responses

200

Successful Response

object

meta

object

name

string

default: openaq-api

license

string

""

website

string

default: /

page

integer

default: 1

limit

integer

default: 100

found

Any of:

integer

integer

string

string

null

null

results

required

Array<object>

object

country

required

string

city

required

string

count

required

integer

locations

required

integer

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string