Skip to content

Projects

GET
/v2/projects

Provides a list of projects

Parameters

Query Parameters

country_id
required
Any of:
integer
limit
required
Any of:
integer
page
required
Any of:
integer
offset
required
Any of:
integer
sort
Any of:
string
Allowed values: asc desc

Limit results by a certain country using two digit country ID. e.g. 13

parameter_id
Any of:
integer

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

parameter
Any of:
Array<string>

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

unit
Any of:
Array<string>

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

project_id
Any of:
integer
project
Any of:
Array<string>

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

order_by

(optional) A parameter ID to filter measurement results. e.g. parameter_id=2 (i.e. PM2.5) will limit measurement results to only PM2.5 measurements

string
Allowed values: id name subtitle firstUpdated lastUpdated

(optional) A parameter ID to filter measurement results. e.g. parameter_id=2 (i.e. PM2.5) will limit measurement results to only PM2.5 measurements

is_mobile
Any of:
boolean

(optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25&parameter=pm10

is_analysis
Any of:
boolean
entity
Any of:
string
sensor_type
Any of:
string
source_name
Any of:
Array<string>

Request Body required

Any of:
Array<string>

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
subtitle
required
string
isMobile
required
boolean
isAnalysis
Any of:
boolean
entity
Any of:
string
sensorType
Any of:
string
locations
required
integer
locationIds
required
Array<integer>
countries
required
Array<string>
parameters
required
Array<object>
object
id
required
integer
unit
required
string
count
required
integer
average
required
number
parameter
required
string
lastValue
Any of:
number
displayName
Any of:
string
lastUpdated
required
string
parameterId
required
integer
firstUpdated
required
string
manufacturers
Any of:
Array<object>
object
modelName
required
string
manufacturerName
required
string
bbox
Any of:
Array<number>
measurements
required
integer
firstUpdated
required
string
lastUpdated
required
string
sources
required
Array<object>
object
id
required
string
name
required
string
readme
Any of:
string
data_avg_dur
Any of:
string
organization
Any of:
string
lifecycle_stage
Any of:
string

422

Validation Error

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