Skip to content

Get a location by ID

GET
/v2/locations/{location_id}

Provides a location by location ID

Parameters

Path Parameters

location_id
required

The ID of the location

integer

The ID of the location

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

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
city
Any of:
string
name
Any of:
string
entity
Any of:
string
country
Any of:
string
sources
Any of:
Array<object>
object
url
Any of:
string
name
required
string
id
Any of:
string
readme
Any of:
string
organization
Any of:
string
lifecycle_stage
Any of:
string
isMobile
required
boolean
isAnalysis
Any of:
boolean
parameters
Any of:
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
sensorType
Any of:
string
coordinates
Any of:
object
latitude
Any of:
number
longitude
Any of:
number
lastUpdated
Any of:
string
firstUpdated
Any of:
string
measurements
required
integer
bounds
Any of:
Array<number>
manufacturers
Any of:
Array<object>
object
modelName
required
string
manufacturerName
required
string

422

Validation Error

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