Skip to content
OpenAQ Docs

Get countries

GET
/v3/countries

Provides a list of countries

Parameters

Query Parameters

order_by
Any of:
string

The field by which to order results

sort_order
Any of:
string
Allowed values: asc desc

Sort results ascending or descending. Default ASC

providers_id
Any of:
Array<integer>

Limit the results to a specific provider or multiple providers with a single provider ID or a comma delimited list of IDs

parameters_id
Any of:
Array<integer>
limit

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

integer
default: 100

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

page

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

integer
default: 1

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

Responses

200

Successful Response

object
meta
object
name
string
default: openaq-api
website
string
default: /
page
integer
default: 1
limit
integer
default: 100
found
Any of:
integer
results
required
Array<object>
object
id
required
integer
code
required
string
name
required
string
datetimeFirst
Any of:
string format: date-time
datetimeLast
Any of:
string format: date-time
parameters
Any of:
Array<object>
object
id
required
integer
name
required
string
units
required
string
displayName
Any of:
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string