Skip to content
OpenAQ Docs

Get measurements aggregated to year by sensor ID

GET
/v3/sensors/{sensors_id}/years
 
curl --request GET \
  --url 'https://example.com/v3/sensors/1/years?date_to=2022-10-01T11%3A19%3A38-06%3A00&date_from=2022-10-01T11%3A19%3A38-06%3A00&limit=100&page=1' \
  --header 'X-API-Key: <X-API-Key>'

Provides a list of annual data by sensor ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
sensors_id
required
Sensors Id

Limit the results to a specific sensors id

integer

Limit the results to a specific sensors id

Query Parameters

Section titled “Query Parameters ”
date_to
Any of:
string format: date-time

To when?

date_from
Any of:
string format: date-time

From when?

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
AnnualDataResponse
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>
AnnualData
object
value
Any of:
number
flagInfo
required
FlagInfo
object
hasFlags
required
Hasflags
boolean
parameter
required
ParameterBase
object
id
required
Id
integer
name
required
Name
string
units
required
Units
string
displayName
Any of:
string
period
Any of:
Period
object
label
required
Label
string
interval
required
Interval
string
datetimeFrom
Any of:
DatetimeObject
object
utc
required
Utc
string format: date-time
local
required
Local
string format: date-time
datetimeTo
Any of:
DatetimeObject
object
utc
required
Utc
string format: date-time
local
required
Local
string format: date-time
coordinates
Any of:
Coordinates
object
latitude
Any of:
number
longitude
Any of:
number
summary
Any of:
Summary
object
min
Any of:
number
q02
Any of:
number
q25
Any of:
number
median
Any of:
number
q75
Any of:
number
q98
Any of:
number
max
Any of:
number
avg
Any of:
number
sd
Any of:
number
coverage
Any of:
Coverage
object
expectedCount
required
Expectedcount
integer
expectedInterval
required
Expectedinterval
string
observedCount
required
Observedcount
integer
observedInterval
required
Observedinterval
string
percentComplete
required
Percentcomplete
number
percentCoverage
required
Percentcoverage
number
datetimeFrom
Any of:
DatetimeObject
object
utc
required
Utc
string format: date-time
local
required
Local
string format: date-time
datetimeTo
Any of:
DatetimeObject
object
utc
required
Utc
string format: date-time
local
required
Local
string format: date-time
Example 
{
  "meta": {
    "name": "openaq-api",
    "website": "/",
    "page": 1,
    "limit": 100
  }
}

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"
    }
  ]
}