Projects

GET

/v2/projects

Provides a list of projects

Parameters

Query Parameters

country_id

required

Any of:

integer

integer

null

null

limit

required

Any of:

integer

integer

null

null

page

required

Any of:

integer

integer

null

null

offset

required

Any of:

integer

integer

null

null

sort

Any of:

Sort

string

Allowed values: asc desc

null

null

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

parameter_id

Any of:

integer

integer

null

null

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>

Array<string>

null

null

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

unit

Any of:

Array<string>

Array<string>

null

null

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

project_id

Any of:

integer

integer

null

null

project

Any of:

Array<string>

Array<string>

null

null

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

boolean

null

null

(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

boolean

null

null

entity

Any of:

string

string

null

null

sensor_type

Any of:

string

string

null

null

source_name

Any of:

Array<string>

Array<string>

null

null

Request Body ^required

Any of:

Array<string>

Array<string>

null

null

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

integer

string

string

null

null

results

required

Array<object>

object

id

required

integer

name

required

string

subtitle

required

string

isMobile

required

boolean

isAnalysis

Any of:

boolean

boolean

null

null

entity

Any of:

string

string

null

null

sensorType

Any of:

string

string

null

null

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

number

null

null

displayName

Any of:

string

string

null

null

lastUpdated

required

string

parameterId

required

integer

firstUpdated

required

string

manufacturers

Any of:

Array<object>

Array<object>

object

modelName

required

string

manufacturerName

required

string

Manufacturer

object

modelName

required

string

manufacturerName

required

string

bbox

Any of:

Array<number>

Array<number>

null

null

measurements

required

integer

firstUpdated

required

string

lastUpdated

required

string

sources

required

Array<object>

object

id

required

string

name

required

string

readme

Any of:

string

string

null

null

data_avg_dur

Any of:

string

string

null

null

organization

Any of:

string

string

null

null

lifecycle_stage

Any of:

string

string

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string