OpenAQ Sensors API
The Sensors API from OpenAQ — 19 operation(s) for sensors.
OpenAPI Specification
openapi: 3.1.0
info:
title: OpenAQ Averages Sensors API
description: '
OpenAQ is a nonprofit organization providing universal access to air
quality data to empower a global community of changemakers to solve air
inequality-the unequal access to clean air.'
version: 2.0.0
tags:
- name: Sensors
paths:
/v3/sensors/{sensors_id}/measurements:
get:
tags:
- Sensors
summary: OpenAQ Get measurements by sensor ID
description: Provides a list of measurements by sensor ID
operationId: sensor_measurements_get_v3_sensors__sensors_id__measurements_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
examples:
- '100'
default: 100
title: Limit
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
- name: page
in: query
required: false
schema:
type: integer
description: Paginate through results. e.g. page=1 will return first page of results
examples:
- '1'
default: 1
title: Page
description: Paginate through results. e.g. page=1 will return first page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/openaq_api__v3__models__responses__MeasurementsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/measurements/hourly:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated to hours by sensor ID
description: Provides a list of measurements by sensor ID
operationId: sensor_measurements_aggregated_get_hourly_v3_sensors__sensors_id__measurements_hourly_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
examples:
- '100'
default: 100
title: Limit
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
- name: page
in: query
required: false
schema:
type: integer
description: Paginate through results. e.g. page=1 will return first page of results
examples:
- '1'
default: 1
title: Page
description: Paginate through results. e.g. page=1 will return first page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/openaq_api__v3__models__responses__MeasurementsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/measurements/daily:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated to days by sensor ID
description: Provides a list of measurements by sensor ID
operationId: sensor_measurements_aggregated_get_daily_v3_sensors__sensors_id__measurements_daily_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
examples:
- '100'
default: 100
title: Limit
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
- name: page
in: query
required: false
schema:
type: integer
description: Paginate through results. e.g. page=1 will return first page of results
examples:
- '1'
default: 1
title: Page
description: Paginate through results. e.g. page=1 will return first page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/openaq_api__v3__models__responses__MeasurementsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/hours:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated to hour by sensor ID
description: Provides a list of hourly data by sensor ID
operationId: sensor_hourly_measurements_get_v3_sensors__sensors_id__hours_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
examples:
- '100'
default: 100
title: Limit
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
- name: page
in: query
required: false
schema:
type: integer
description: Paginate through results. e.g. page=1 will return first page of results
examples:
- '1'
default: 1
title: Page
description: Paginate through results. e.g. page=1 will return first page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/hours/daily:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from hour to day by sensor ID
description: Provides a list of daily summaries of hourly data by sensor ID
operationId: sensor_hourly_measurements_aggregate_to_day_get_v3_sensors__sensors_id__hours_daily_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
examples:
- '100'
default: 100
title: Limit
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
- name: page
in: query
required: false
schema:
type: integer
description: Paginate through results. e.g. page=1 will return first page of results
examples:
- '1'
default: 1
title: Page
description: Paginate through results. e.g. page=1 will return first page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/hours/monthly:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from hour to month by sensor ID
description: Provides a list of daily summaries of hourly data by sensor ID
operationId: sensor_hourly_measurements_aggregate_to_month_get_v3_sensors__sensors_id__hours_monthly_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
examples:
- '100'
default: 100
title: Limit
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
- name: page
in: query
required: false
schema:
type: integer
description: Paginate through results. e.g. page=1 will return first page of results
examples:
- '1'
default: 1
title: Page
description: Paginate through results. e.g. page=1 will return first page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/hours/yearly:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from hour to year by sensor ID
description: Provides a list of yearly summaries of hourly data by sensor ID
operationId: sensor_hourly_measurements_aggregate_to_year_get_v3_sensors__sensors_id__hours_yearly_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
examples:
- '100'
default: 100
title: Limit
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
- name: page
in: query
required: false
schema:
type: integer
description: Paginate through results. e.g. page=1 will return first page of results
examples:
- '1'
default: 1
title: Page
description: Paginate through results. e.g. page=1 will return first page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/hours/hourofday:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from hour to day of week by sensor ID
description: Provides a list of yearly summaries of hourly data by sensor ID
operationId: sensor_hourly_measurements_aggregate_to_hod_get_v3_sensors__sensors_id__hours_hourofday_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/hours/dayofweek:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from hour to day of week by sensor ID
description: Provides a list of yearly summaries of hourly data by sensor ID
operationId: sensor_hourly_measurements_aggregate_to_dow_get_v3_sensors__sensors_id__hours_dayofweek_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/hours/monthofyear:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from hour to day of week by sensor ID
description: Provides a list of yearly summaries of hourly data by sensor ID
operationId: sensor_hourly_measurements_aggregate_to_moy_get_v3_sensors__sensors_id__hours_monthofyear_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: datetime_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime To
description: To when?
- name: datetime_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Datetime From
description: From when?
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/days/dayofweek:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from day to day of week by sensor ID
description: Provides a list of yearly summaries of dayly data by sensor ID
operationId: sensor_daily_measurements_aggregate_to_dow_get_v3_sensors__sensors_id__days_dayofweek_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: date_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Date To
description: To when?
- name: date_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Date From
description: From when?
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/days/monthofyear:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from day to day of week by sensor ID
description: Provides a list of yearly summaries of daily data by sensor ID
operationId: sensor_daily_measurements_aggregate_to_moy_get_v3_sensors__sensors_id__days_monthofyear_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: date_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Date To
description: To when?
- name: date_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Date From
description: From when?
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HourlyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/days:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated to day by sensor ID
description: Provides a list of daily data by sensor ID
operationId: sensor_daily_get_v3_sensors__sensors_id__days_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: date_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Date To
description: To when?
- name: date_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Date From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
examples:
- '100'
default: 100
title: Limit
description: "Change the number of results returned.\n e.g. limit=100 will return up to 100 results"
- name: page
in: query
required: false
schema:
type: integer
description: Paginate through results. e.g. page=1 will return first page of results
examples:
- '1'
default: 1
title: Page
description: Paginate through results. e.g. page=1 will return first page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DailyDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/sensors/{sensors_id}/days/monthly:
get:
tags:
- Sensors
summary: OpenAQ Get measurements aggregated from hour to month by sensor ID
description: Provides a list of daily summaries of hourly data by sensor ID
operationId: sensor_daily_aggregate_to_month_get_v3_sensors__sensors_id__days_monthly_get
security:
- APIKeyHeader: []
parameters:
- name: sensors_id
in: path
required: true
schema:
type: integer
description: Limit the results to a specific sensors id
title: Sensors Id
description: Limit the results to a specific sensors id
- name: date_to
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: To when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Date To
description: To when?
- name: date_from
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
format: date
- type: 'null'
description: From when?
examples:
- '2022-10-01T11:19:38-06:00'
- '2022-10-01'
title: Date From
description: From when?
- name: limit
in: query
required: false
schema:
type: integer
description: "Change the number of results returned.\n
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openaq/refs/heads/main/openapi/openaq-sensors-api-openapi.yml