Skip to content
OpenAQ Docs

Get parameters

Deprecated
GET
/v2/parameters

Provides a list of parameters supported by the platform

Authorizations

Parameters

Query Parameters

limit
Any of:
integer

Change the number of results returned. e.g. limit=1000 will return up to 1000 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
string
default: id
Allowed values: id name preferredUnit

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

422

Validation Error

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