Skip to content
OpenAQ Docs

Get locations

GET
/v3/locations

Provides a list of locations

Parameters

Query Parameters

coordinates
Any of:
string

WGS 84 Coordinate pair in form latitude,longitude. Supports up to 4 decimal points of precision, additional decimal precision will be truncated in the query e.g. 38.9074,-77.0373

radius
Any of:
integer
> 0 <= 25000

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

providers_id
Any of:
Array<integer>

Limit the results to a specific provider or multiple providers with a single provider ID or a comma delimited list of IDs

parameters_id
Any of:
Array<integer>
limit

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

integer
default: 100

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

page

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

integer
default: 1

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

owner_contacts_id
Any of:
Array<integer>

Limit the results to a specific owner by owner ID with a single owner ID or comma delimited list of IDs

manufacturers_id
Any of:
Array<integer>
order_by
Any of:
string

The field by which to order results

sort_order
Any of:
string
Allowed values: asc desc

Sort results ascending or descending. Default ASC

licenses_id
Any of:
Array<integer>
monitor
Any of:
boolean

Is the location considered a reference monitor?

mobile
Any of:
boolean

Is the location considered a mobile location?

instruments_id
Any of:
Array<integer>
iso
Any of:
string

Limit the results to a specific country using ISO 3166-1 alpha-2 code

countries_id
Any of:
Array<integer>

Limit the results to a specific country or countries by country ID as a single country ID or a comma delimited list of IDs

bbox
Any of:
string

Geospatial bounding box of Min X, min Y, max X, max Y in WGS 84 coordinates. Up to 4 decimal points of precision, addtional decimal precision will be truncated to 4 decimal points precision e.g. -77.037,38.907,-77.0,39.910

Responses

200

Successful Response

object
meta
object
name
string
default: openaq-api
website
string
default: /
page
integer
default: 1
limit
integer
default: 100
found
Any of:
integer
results
required
Array<object>
object
id
required
integer
name
Any of:
string
locality
Any of:
string
timezone
required
string
country
required
object
id
Any of:
integer
code
required
string
name
required
string
owner
required
object
id
required
integer
name
required
string
provider
required
object
id
required
integer
name
required
string
isMobile
required
boolean
isMonitor
required
boolean
instruments
required
Array<object>
object
id
required
integer
name
required
string
sensors
required
Array<object>
object
id
required
integer
name
required
string
parameter
required
object
id
required
integer
name
required
string
units
required
string
displayName
Any of:
string
coordinates
required
object
latitude
Any of:
number
longitude
Any of:
number
licenses
Any of:
Array<object>
object
id
required
integer
name
required
string
attribution
required
object
name
required
string
url
Any of:
string
dateFrom
Any of:
string format: date
dateTo
Any of:
string format: date
bounds
required
Array<number>
>= 4 items <= 4 items
distance
Any of:
number
datetimeFirst
Any of:
object
utc
required
string format: date-time
local
required
string format: date-time
datetimeLast
Any of:
object
utc
required
string format: date-time
local
required
string format: date-time

422

Validation Error

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