Skip to content
OpenAQ Docs

Get flags by location ID

GET
/v3/locations/{locations_id}/flags

Provides a list of flags by location ID

Authorizations

Parameters

Path Parameters

locations_id
required

Limit the results to a specific locations

integer

Limit the results to a specific locations

Query Parameters

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

datetime_from
Any of:
string format: date-time

To when?

datetime_to
Any of:
string format: date-time

To when?

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
locationId
required
integer
flagType
required
object
id
required
integer
label
required
string
level
required
string
datetimeFrom
required
object
utc
required
string format: date-time
local
required
string format: date-time
datetimeTo
required
object
utc
required
string format: date-time
local
required
string format: date-time
sensorIds
Array<integer>
default:
note
Any of:
string

422

Validation Error

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