Skip to content
OpenAQ Docs

Get flags by location ID

GET
/v3/locations/{locations_id}/flags
 
curl --request GET \
  --url 'https://example.com/v3/locations/1/flags?limit=100&page=1&datetime_from=2022-10-01T11%3A19%3A38-06%3A00&datetime_to=2022-10-01T11%3A19%3A38-06%3A00' \
  --header 'X-API-Key: <X-API-Key>'

Provides a list of flags by location ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
locations_id
required
Locations Id

Limit the results to a specific locations

integer

Limit the results to a specific locations

Query Parameters

Section titled “Query Parameters ”
limit
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
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

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
LocationFlagsResponse
object
meta
Meta
object
name
Name
string
default: openaq-api
website
Website
string
default: /
page
Page
integer
default: 1
limit
Limit
integer
default: 100
found
Any of:
integer
results
required
Results
Array<object>
LocationFlag
object
locationId
required
Locationid
integer
flagType
required
FlagType
object
id
required
Id
integer
label
required
Label
string
level
required
Level
string
datetimeFrom
required
DatetimeObject
object
utc
required
Utc
string format: date-time
local
required
Local
string format: date-time
datetimeTo
required
DatetimeObject
object
utc
required
Utc
string format: date-time
local
required
Local
string format: date-time
sensorIds
Sensorids
Array<integer>
default:
note
Any of:
string
Example 
{
  "meta": {
    "name": "openaq-api",
    "website": "/",
    "page": 1,
    "limit": 100
  },
  "results": [
    {
      "sensorIds": []
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}