Get locations

Deprecated

GET

/v2/locations

Provides a list of locations

Authorizations

• APIKeyHeader

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

Sort Direction e.g. sort=desc

parameter_id

Any of:

integer

integer

null

null

(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

parameter

Any of:

Array<string>

Array<string>

null

null

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

unit

Any of:

Array<string>

Array<string>

null

null

coordinates

Any of:

string

string

null

null

Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037

radius

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

integer

default: 1000

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

country_id

Any of:

integer

integer

null

null

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

country

Any of:

Array<string>

Array<string>

null

null

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

city

Any of:

Array<string>

Array<string>

null

null

Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston)

location_id

Any of:

Array<integer>

Array<integer>

null

null

location

Any of:

Array<string>

Array<string>

null

null

order_by

Order by a field

string

Allowed values: city country location sourceName firstUpdated lastUpdated count random distance

Order by a field

is_mobile

Any of:

boolean

boolean

null

null

Location is mobile e.g. ?isMobile=true

is_analysis

Any of:

boolean

boolean

null

null

Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true

source_name

Any of:

Array<string>

Array<string>

null

null

Name of the data source e.g. ?sourceName=Houston%20Mobile

entity

Any of:

EntityTypes

string

Allowed values: government community research

null

null

Source entity type. e.g. ?entity=government

sensor_type

Any of:

SensorTypes

string

Allowed values: reference grade low-cost sensor

null

null

Type of Sensor e.g. ?sensorType=reference%20grade

model_name

Any of:

Array<string>

Array<string>

null

null

Model Name of Sensor e.g. ?modelName=AE33

manufacturer_name

Any of:

Array<string>

Array<string>

null

null

Manufacturer of Sensor e.g. ?manufacturer=Ecotech

dump_raw

Any of:

boolean

boolean

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

city

Any of:

string

string

null

null

name

Any of:

string

string

null

null

entity

Any of:

string

string

null

null

country

Any of:

string

string

null

null

sources

Any of:

Array<object>

Array<object>

object

url

Any of:

string

string

null

null

name

required

string

id

Any of:

string

string

null

null

readme

Any of:

string

string

null

null

organization

Any of:

string

string

null

null

lifecycle_stage

Any of:

string

string

null

null

Source

object

url

Any of:

string

string

null

null

name

required

string

id

Any of:

string

string

null

null

readme

Any of:

string

string

null

null

organization

Any of:

string

string

null

null

lifecycle_stage

Any of:

string

string

null

null

isMobile

required

boolean

isAnalysis

Any of:

boolean

boolean

null

null

parameters

Any of:

Array<object>

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

null

null

sensorType

Any of:

string

string

null

null

coordinates

Any of:

Coordinates

object

latitude

Any of:

number

number

null

null

longitude

Any of:

number

number

null

null

null

null

lastUpdated

Any of:

string

string

null

null

firstUpdated

Any of:

string

string

null

null

measurements

required

integer

bounds

Any of:

Array<number>

Array<number>

null

null

manufacturers

Any of:

Array<object>

Array<object>

object

modelName

required

string

manufacturerName

required

string

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string