Skip to content
OpenAQ Docs

Get a parameters

GET
/v3/parameters

Provides a list of parameters

Authorizations

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

parameter_type
Any of:
string
Allowed values: pollutant meteorological

Limit the results to a specific parameters type

coordinates
Any of:
string

WGS 84 Coordinate pair in form latitude,longitude. Supports up to 4 decimal points of precision, additional decimal precision will be truncated in the query e.g. 38.9074,-77.0373

radius
Any of:
integer
> 0 <= 25000

Search radius from coordinates as center in meters. Maximum of 25,000 (25km) defaults to 1000 (1km) e.g. radius=1000

bbox
Any of:
string

Geospatial bounding box of Min X, min Y, max X, max Y in WGS 84 coordinates. Up to 4 decimal points of precision, addtional decimal precision will be truncated to 4 decimal points precision e.g. -77.037,38.907,-77.0,39.910

iso
Any of:
string

Limit the results to a specific country using ISO 3166-1 alpha-2 code

countries_id
Any of:
Array<integer>

Limit the results to a specific country or countries by country ID as a single country ID or a comma delimited list of IDs

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
name
required
string
units
required
string
displayName
Any of:
string
description
Any of:
string

422

Validation Error

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