Sources

GET

/v2/sources

Provides a list of sources

Parameters

Query Parameters

limit

Any of:

integer

integer

null

null

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

page

Any of:

integer

integer

null

null

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

offset

Any of:

integer

integer

null

null

sort

Any of:

Sort

string

Allowed values: asc desc

null

null

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

source_name

Any of:

Array<string>

Array<string>

null

null

source_id

Any of:

Array<integer>

Array<integer>

null

null

source_slug

Any of:

Array<string>

Array<string>

null

null

order_by

Field by which to order the results e.g. ?order_by=sourceName or ?order_by=firstUpdated

string

Allowed values: sourceName firstUpdated lastUpdated

Field by which to order the results e.g. ?order_by=sourceName or ?order_by=firstUpdated

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

data

Any of:

Datum

object

url

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

null

null

readme

Any of:

string

string

null

null

sourceId

required

integer

locations

required

integer

sourceName

required

string

sourceSlug

Any of:

string

string

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string