get-observations-by-monitoring-site-by-geographic-bounding-box
Retrieve air quality observations from monitoring sites within a specific geographic area. Specify pollutants, data format, and time range to access detailed air quality data.
Instructions
Get observations by monitoring site within a geographic bounding box.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
bbox | Yes | Geographic bounding box of the area of interest in latitude and longitude. The format is a comma separated list minX,minY,maxX,maxY. Example: 122.715607,38.181254,-120.012970,39.022646 | |
datatype | Yes | Data type to return. Example: C | |
enddate | No | The end date and time of the data requested. Format: UTC Date or DateTime as end of measurement period. Examples: 2014-01-02T13:00, 2014-01-02T13, or 2014-01-02 | |
format | Yes | MIME type of the file to be returned. Example: application/json | |
includerawconcentrations | No | When set to 1, an additional field that contains the raw concentration will be added to the output. Default is 0. | |
monitortype | No | The type of monitor to be returned. Options include: Permanent Only (0), Mobile Only (1), Permanent and Mobile (2). Example: 0 | |
parameters | Yes | Comma separated list of pollutant parameters short codes to return data for. Options include: ozone, pm25, pm10, co, no2, so2. Example: ozone,pm25 | |
startdate | No | The start date and time of the data requested. Format: UTC Date or DateTime as beginning of measurement period. Examples: 2014-01-01T13:00, 2014-01-01T13, or 2014-01-01 | |
verbose | No | When set to 1, provides additional site information including Site Name, Agency Name, AQS ID, and Full AQS ID. Default is 0. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"bbox": {
"description": "Geographic bounding box of the area of interest in latitude and longitude. The format is a comma separated list minX,minY,maxX,maxY. Example: 122.715607,38.181254,-120.012970,39.022646",
"type": "string"
},
"datatype": {
"description": "Data type to return. Example: C",
"enum": [
"A",
"C",
"B"
],
"type": "string"
},
"enddate": {
"description": "The end date and time of the data requested. Format: UTC Date or DateTime as end of measurement period. Examples: 2014-01-02T13:00, 2014-01-02T13, or 2014-01-02",
"type": "string"
},
"format": {
"description": "MIME type of the file to be returned. Example: application/json",
"enum": [
"text/csv",
"application/json",
"application/xml",
"application/vnd.google-earth.kml"
],
"type": "string"
},
"includerawconcentrations": {
"description": "When set to 1, an additional field that contains the raw concentration will be added to the output. Default is 0.",
"enum": [
"0",
"1"
],
"type": "string"
},
"monitortype": {
"description": "The type of monitor to be returned. Options include: Permanent Only (0), Mobile Only (1), Permanent and Mobile (2). Example: 0",
"enum": [
"0",
"1",
"2"
],
"type": "string"
},
"parameters": {
"description": "Comma separated list of pollutant parameters short codes to return data for. Options include: ozone, pm25, pm10, co, no2, so2. Example: ozone,pm25",
"type": "string"
},
"startdate": {
"description": "The start date and time of the data requested. Format: UTC Date or DateTime as beginning of measurement period. Examples: 2014-01-01T13:00, 2014-01-01T13, or 2014-01-01",
"type": "string"
},
"verbose": {
"description": "When set to 1, provides additional site information including Site Name, Agency Name, AQS ID, and Full AQS ID. Default is 0.",
"enum": [
"0",
"1"
],
"type": "string"
}
},
"required": [
"bbox",
"parameters",
"datatype",
"format"
],
"type": "object"
}