Skip to content

Get country by ID

GET
/v1/countries/{country_id}

Provides a single country by country ID

Parameters

Path Parameters

country_id
required
integer

Query Parameters

limit

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

integer
default: 100

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

page
Any of:
integer

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

offset
Any of:
integer
sort
Any of:
string
Allowed values: asc desc

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

order_by

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

string
Allowed values: code name locations firstUpdated lastUpdated parameters count cities sources

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

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
results
required
Array<object>
object
code
required
string
name
required
string
locations
required
integer
firstUpdated
required
string
lastUpdated
required
string
parameters
required
Array<string>
count
required
integer
cities
required
integer
sources
required
integer

422

Validation Error

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