|
openapi: 3.0.1 |
|
info: |
|
title: AQS Data API |
|
description: "These are the specifications for the AQS API version 2. Remaining\ |
|
\ to do \n * Add more services\n * Verify return descriptions are correct" |
|
termsOfService: https://aqs.epa.gov/aqsweb/documents/data_api.html#terms |
|
contact: |
|
name: US EPA Air Quality System API v2 |
|
url: https://aqs.epa.gov/aqsweb/documents/data_api.html |
|
email: aqsdatamart@epa.gov |
|
version: 1.2.1 |
|
externalDocs: |
|
description: Find out more about the Open API Specification |
|
url: https://github.com/OAI/OpenAPI-Specification |
|
servers: |
|
- url: https://aqs.epa.gov/data/api |
|
tags: |
|
- name: sampleData |
|
description: Returns sample (raw) data |
|
- name: dailyData |
|
description: Returns daily summary data |
|
- name: annualData |
|
description: Returns annual summary data |
|
- name: qaAnnualPerformanceEvaluations |
|
description: Returns pairs of data (known and measured values) at several concentration |
|
levels |
|
- name: list |
|
description: Returns lists of valid values for data entry elsewhere |
|
- name: available |
|
description: Ping to see if system is on-line |
|
- name: qaCollocatedAssessments |
|
description: Returns QA collocated assessment data |
|
- name: qaPepAudits |
|
description: Returns QA PEP audit data |
|
- name: qaFlowRateAudits |
|
description: Returns QA flow rate audit data |
|
- name: qaFlowRateVerifications |
|
description: Returns QA flow rate verification data |
|
- name: qaBlanks |
|
description: Returns QA blank data |
|
- name: qaOnePointQcRawData |
|
description: Returns QA one point QC raw data |
|
- name: monitors |
|
description: Returns monitor data |
|
- name: metaData |
|
description: Returns meta data for a service |
|
- name: register |
|
description: Create an account |
|
- name: transactionsSample |
|
description: Returns data in AQS transaction format |
|
- name: transactionsQaAnnualPerformanceEvaluations |
|
description: Returns pairs of data QA at several concentration levels in the submission |
|
(transaction) format for AQS |
|
paths: |
|
/sampleData/byState: |
|
get: |
|
tags: |
|
- sampleData |
|
summary: Returns data for a single state |
|
description: | |
|
Returns sample data matching the variables provided. |
|
operationId: sampleDataByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/sampleData/byCounty: |
|
get: |
|
tags: |
|
- sampleData |
|
summary: Returns data for a single county |
|
description: | |
|
Returns sample data matching the variables provided. |
|
operationId: sampleDataByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/sampleData/bySite: |
|
get: |
|
tags: |
|
- sampleData |
|
summary: Returns data for a single monitoring site |
|
description: | |
|
Returns sample data matching the variables provided. |
|
operationId: sampleDataBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/sampleData/byCBSA: |
|
get: |
|
tags: |
|
- sampleData |
|
summary: Returns data for a single CBSA (metropolitan area) |
|
description: | |
|
Returns sample data matching the variables provided. |
|
operationId: sampleDataByCBSA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbsa |
|
in: query |
|
description: CBSA code - must be five digits including leading zeroes. Use |
|
list/cbsas to find the CSA codes. |
|
required: true |
|
schema: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/sampleData/byBox: |
|
get: |
|
tags: |
|
- sampleData |
|
summary: Returns data within a latitude / longitude bounding box |
|
description: | |
|
Returns sample data matching the variables provided. |
|
operationId: sampleDataByBox |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: minlat |
|
in: query |
|
description: Minimum Latitude - the southernmost extent of a bounding box |
|
query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: maxlat |
|
in: query |
|
description: Maximum Latitude - the northernmost extent of a bounding box |
|
query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: minlon |
|
in: query |
|
description: | |
|
Minimum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. And -70 is less than -60. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: maxlon |
|
in: query |
|
description: | |
|
Maximum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/dailyData/byState: |
|
get: |
|
tags: |
|
- dailyData |
|
summary: Returns daily summary data for a single state |
|
description: | |
|
Provides data aggregated to a daily summary matching the variables provided. |
|
operationId: dailyDataByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/dailyData/byCounty: |
|
get: |
|
tags: |
|
- dailyData |
|
summary: Returns daily summary data for a single county |
|
description: | |
|
Provides data aggregated to a daily summary matching the variables provided. |
|
operationId: dailyDataByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/dailyData/bySite: |
|
get: |
|
tags: |
|
- dailyData |
|
summary: Returns daily summary data for a single monitoring site |
|
description: | |
|
Provides data aggregated to a daily summary matching the variables provided. |
|
operationId: dailyDataBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/dailyData/byCBSA: |
|
get: |
|
tags: |
|
- dailyData |
|
summary: Returns daily summary data for a single CBSA (metropolitan area) |
|
description: | |
|
Provides data aggregated to a daily summary matching the variables provided. |
|
operationId: dalyDataByCBSA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbsa |
|
in: query |
|
description: CBSA code - must be five digits including leading zeroes. Use |
|
list/cbsas to find the CSA codes. |
|
required: true |
|
schema: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/dailyData/byBox: |
|
get: |
|
tags: |
|
- dailyData |
|
summary: Returns daily summary data within a latitude / longitude bounding box |
|
description: | |
|
Provides data aggregated to a daily summary matching the variables provided. |
|
operationId: dalyDataByBox |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: minlat |
|
in: query |
|
description: Minimum Latitude - the southernmost extent of a bounding box |
|
query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: maxlat |
|
in: query |
|
description: Maximum Latitude - the northernmost extent of a bounding box |
|
query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: minlon |
|
in: query |
|
description: | |
|
Minimum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. And -70 is less than -60. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: maxlon |
|
in: query |
|
description: | |
|
Maximum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/annualData/byState: |
|
get: |
|
tags: |
|
- annualData |
|
summary: Returns annual summary data for a single state |
|
description: | |
|
Provides data aggregated to an annual summary matching the variables provided. |
|
operationId: annualDataByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/annualData/byCounty: |
|
get: |
|
tags: |
|
- annualData |
|
summary: Returns annual summary data for a single county |
|
description: | |
|
Provides data aggregated to an annual summary matching the variables provided. |
|
operationId: annualDataByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/annualData/bySite: |
|
get: |
|
tags: |
|
- annualData |
|
summary: Returns annual summary data for a single monitoring site |
|
description: | |
|
Provides data aggregated to an annual summary matching the variables provided. |
|
operationId: annualDataBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/annualData/byCBSA: |
|
get: |
|
tags: |
|
- annualData |
|
summary: Returns annual summary data for a single CBSA (metropolitan area) |
|
description: | |
|
Provides data aggregated to an annual summary matching the variables provided. |
|
operationId: annualDataByCBSA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbsa |
|
in: query |
|
description: CBSA code - must be five digits including leading zeroes. Use |
|
list/cbsas to find the CSA codes. |
|
required: true |
|
schema: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/annualData/byBox: |
|
get: |
|
tags: |
|
- annualData |
|
summary: Returns annual summary data within a latitude / longitude bounding |
|
box |
|
description: | |
|
Provides data aggregated to an annual summary matching the variables provided. |
|
operationId: annualDataByBox |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: minlat |
|
in: query |
|
description: Minimum Latitude - the southernmost extent of a bounding box |
|
query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: maxlat |
|
in: query |
|
description: Maximum Latitude - the northernmost extent of a bounding box |
|
query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: minlon |
|
in: query |
|
description: | |
|
Minimum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. And -70 is less than -60. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: maxlon |
|
in: query |
|
description: | |
|
Maximum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
/qaAnnualPerformanceEvaluations/bySite: |
|
get: |
|
tags: |
|
- qaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data for a single site |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided. |
|
operationId: qaAnnualPerformanceEvaluationsBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaAnnualPerformanceEvaluations/byCounty: |
|
get: |
|
tags: |
|
- qaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data for a single county |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided. |
|
operationId: qaAnnualPerformanceEvaluationsByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaAnnualPerformanceEvaluations/byState: |
|
get: |
|
tags: |
|
- qaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data for a single state |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided. |
|
operationId: qaAnnualPerformanceEvaluationsByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaAnnualPerformanceEvaluations/byPQAO: |
|
get: |
|
tags: |
|
- qaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data for a given Primary Quality |
|
Assurance Organization |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided. |
|
operationId: qaAnnualPerformanceEvaluationsBySiteByPQAO |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 |
|
digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaAnnualPerformanceEvaluations/byMA: |
|
get: |
|
tags: |
|
- qaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data for a single Monitoring |
|
Agency |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided. |
|
operationId: qaAnnualPerformanceEvaluationsByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/list/states: |
|
get: |
|
tags: |
|
- list |
|
summary: Returns a list of state codes |
|
description: | |
|
AQS uses FIPS codes for identifying states and counties. This service provides the code for each state. Note, when using a code _always_ include leading zeroes. |
|
operationId: listStates |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/list/countiesByState: |
|
get: |
|
tags: |
|
- list |
|
summary: Returns a list of county codes in the provided state |
|
description: | |
|
AQS uses FIPS codes for identifying states and counties. This service provides the code for each county in a given state. Note, when using a code _always_ include leading zeroes. |
|
operationId: listCountiesByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/list/sitesByCounty: |
|
get: |
|
tags: |
|
- list |
|
summary: Returns a list of site numbers in the given county |
|
description: | |
|
Each site (monitoring station) within a county has a unique 4 digit number. This service provides a list of all sites within the given county. The leading zeroes are part of the site number and the numbers do not have to be sequential. |
|
operationId: listSitesByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/list/cbsas: |
|
get: |
|
tags: |
|
- list |
|
summary: Returns a list of CBSA (metro area) codes |
|
description: | |
|
AQS uses Census codes for identifying metro areas (CBSAs, or Core Based Statistical Areas). This service provides the code for each CBSA. Note, when using a code _always_ include leading zeroes. |
|
operationId: listCBSAs |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/list/classes: |
|
get: |
|
tags: |
|
- list |
|
summary: Returns a list of classes (groups) of parameters |
|
description: | |
|
This service returns the list of AQS parameter classes. A parameter class is a grouping of parameters, like Criteria or Meteorological. |
|
operationId: listClasses |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/list/parametersByClass: |
|
get: |
|
tags: |
|
- list |
|
summary: Returns a list of parameter codes in the provided class. "ALL" is |
|
a valid class. |
|
description: | |
|
Returns a list of parameter codes in the provided class. "ALL" is a valid class that will return all AQS parameters. The parameter codes in AQS are specific to the system. We cannot use CAS or other schemes because they do not provide a direct mapping to measurements reported to AQS. |
|
operationId: listParametersByClass |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: pc |
|
in: query |
|
description: Parameter class |
|
required: true |
|
schema: |
|
type: string |
|
default: ALL |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/list/pqaos: |
|
get: |
|
tags: |
|
- list |
|
summary: Returns a list of primary quality assurance organization codes |
|
description: | |
|
Returns a list of primary quality assurance organization codes. |
|
operationId: listPqaos |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/list/mas: |
|
get: |
|
tags: |
|
- list |
|
summary: Returns a list of monitoring agency codes |
|
description: | |
|
Returns a list of monitoring agency codes. |
|
operationId: listMas |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaCollocatedAssessments/byState: |
|
get: |
|
tags: |
|
- qaCollocatedAssessments |
|
summary: Returns QA collocated assessment data by state |
|
operationId: qaCollocatedAssessmentsByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaCollocatedAssessments/byCounty: |
|
get: |
|
tags: |
|
- qaCollocatedAssessments |
|
summary: Returns QA collocated assessment data by county |
|
operationId: qaCollocatedAssessmentsByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaCollocatedAssessments/bySite: |
|
get: |
|
tags: |
|
- qaCollocatedAssessments |
|
summary: Returns QA collocated assessment data by site |
|
operationId: qaCollocatedAssessmentsBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaCollocatedAssessments/byPQAO: |
|
get: |
|
tags: |
|
- qaCollocatedAssessments |
|
summary: Returns QA collocated assessment data by primary quality assurance |
|
organization code |
|
operationId: qaCollocatedAssessmentsByPQAO |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 |
|
digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaCollocatedAssessments/byMA: |
|
get: |
|
tags: |
|
- qaCollocatedAssessments |
|
summary: Returns QA collocated assessment data by monitoring agency code |
|
operationId: qaCollocatedAssessmentsByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaPepAudits/byState: |
|
get: |
|
tags: |
|
- qaPepAudits |
|
summary: Returns QA PEP audit data by state |
|
operationId: qaPepAuditsByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaPepAudits/byCounty: |
|
get: |
|
tags: |
|
- qaPepAudits |
|
summary: Returns QA PEP audit data by county |
|
operationId: qaPepAuditsByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaPepAudits/bySite: |
|
get: |
|
tags: |
|
- qaPepAudits |
|
summary: Returns QA PEP audit data by site |
|
operationId: qaPepAuditsBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaPepAudits/byPQAO: |
|
get: |
|
tags: |
|
- qaPepAudits |
|
summary: Returns QA PEP audit data by primary quality assurance organization |
|
code |
|
operationId: qaPepAuditsByPQAO |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 |
|
digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaPepAudits/byMA: |
|
get: |
|
tags: |
|
- qaPepAudits |
|
summary: Returns QA PEP audit data by monitoring agency code |
|
operationId: qaPepAuditsByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateAudits/byState: |
|
get: |
|
tags: |
|
- qaFlowRateAudits |
|
summary: Returns QA flow rate audits data by state |
|
operationId: qaFlowRateAuditsByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateAudits/byCounty: |
|
get: |
|
tags: |
|
- qaFlowRateAudits |
|
summary: Returns QA flow rate audits data by county |
|
operationId: qaFlowRateAuditsByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateAudits/bySite: |
|
get: |
|
tags: |
|
- qaFlowRateAudits |
|
summary: Returns QA flow rate audits data by site |
|
operationId: qaFlowRateAuditsBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateAudits/byPQAO: |
|
get: |
|
tags: |
|
- qaFlowRateAudits |
|
summary: Returns QA flow rate audits data by primary quality assurance organization |
|
code |
|
operationId: qaFlowRateAuditsByPQAO |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 |
|
digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateAudits/byMA: |
|
get: |
|
tags: |
|
- qaFlowRateAudits |
|
summary: Returns QA flow rate audits data by monitoring agency code |
|
operationId: qaFlowRateAuditsByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateVerifications/byState: |
|
get: |
|
tags: |
|
- qaFlowRateVerifications |
|
summary: Returns QA flow rate verification data by state |
|
operationId: qaFlowRateVerificationsByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateVerifications/byCounty: |
|
get: |
|
tags: |
|
- qaFlowRateVerifications |
|
summary: Returns QA flow rate verification data by county |
|
operationId: qaFlowRateVerificationsByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateVerifications/bySite: |
|
get: |
|
tags: |
|
- qaFlowRateVerifications |
|
summary: Returns QA flow rate verification data by site |
|
operationId: qaFlowRateVerificationsBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateVerifications/byPQAO: |
|
get: |
|
tags: |
|
- qaFlowRateVerifications |
|
summary: Returns QA flow rate verification data by primary quality assurance |
|
organization code |
|
operationId: qaFlowRateVerificationsByPQAO |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 |
|
digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaFlowRateVerifications/byMA: |
|
get: |
|
tags: |
|
- qaFlowRateVerifications |
|
summary: Returns QA flow rate verification by monitoring agency code |
|
operationId: qaFlowRateVerificationsByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaBlanks/byState: |
|
get: |
|
tags: |
|
- qaBlanks |
|
summary: Returns QA blank data by state |
|
operationId: qaBlanksByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaBlanks/byCounty: |
|
get: |
|
tags: |
|
- qaBlanks |
|
summary: Returns QA blank data by county |
|
operationId: qaBlanksByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaBlanks/bySite: |
|
get: |
|
tags: |
|
- qaBlanks |
|
summary: Returns QA blank data by site |
|
operationId: qaBlanksBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaBlanks/byPQAO: |
|
get: |
|
tags: |
|
- qaBlanks |
|
summary: Returns QA blank data by primary quality assurance organization code |
|
operationId: qaBlanksByPQAO |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 |
|
digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaBlanks/byMA: |
|
get: |
|
tags: |
|
- qaBlanks |
|
summary: Returns QA blank data by monitoring agency code |
|
operationId: qaBlanksByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaOnePointQcRawData/byState: |
|
get: |
|
tags: |
|
- qaOnePointQcRawData |
|
summary: Returns QA one point QC raw data by state |
|
operationId: qaOnePointQcRawDataByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaOnePointQcRawData/byCounty: |
|
get: |
|
tags: |
|
- qaOnePointQcRawData |
|
summary: Returns QA one point QC raw data by county |
|
operationId: qaOnePointQcRawDataByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaOnePointQcRawData/bySite: |
|
get: |
|
tags: |
|
- qaOnePointQcRawData |
|
summary: Returns QA one point QC raw data by site |
|
operationId: qaOnePointQcRawDataBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaOnePointQcRawData/byPQAO: |
|
get: |
|
tags: |
|
- qaOnePointQcRawData |
|
summary: Returns QA one point QC raw data by primary quality assurance organization |
|
code |
|
operationId: qaOnePointQcRawData |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 |
|
digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/qaOnePointQcRawData/byMA: |
|
get: |
|
tags: |
|
- qaOnePointQcRawData |
|
summary: Returns QA one point QC raw data by monitoring agency code |
|
operationId: qaOnePointQcRawDataByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsSample/byState: |
|
get: |
|
tags: |
|
- transactionsSample |
|
summary: Returns AQS sample (raw data) input transactions |
|
description: | |
|
Returns RD transactions matching the provided filters. |
|
operationId: transactionsSampleByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: units |
|
in: query |
|
description: Units of measure |
|
schema: |
|
type: string |
|
default: standard |
|
enum: |
|
- standard |
|
- reported |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsSample/byCounty: |
|
get: |
|
tags: |
|
- transactionsSample |
|
summary: Returns AQS sample (raw data) input transactions |
|
description: | |
|
Returns RD transactions matching the provided filters. |
|
operationId: transactionsSampleByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: units |
|
in: query |
|
description: Units of measure |
|
schema: |
|
type: string |
|
default: standard |
|
enum: |
|
- standard |
|
- reported |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsSample/bySite: |
|
get: |
|
tags: |
|
- transactionsSample |
|
summary: Returns AQS sample (raw data) input transactions |
|
description: | |
|
Returns RD transactions matching the provided filters. |
|
operationId: transactionsSampleBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: units |
|
in: query |
|
description: Units of measure |
|
schema: |
|
type: string |
|
default: standard |
|
enum: |
|
- standard |
|
- reported |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsSample/byPOC: |
|
get: |
|
tags: |
|
- transactionsSample |
|
summary: Returns AQS sample (raw data) input transactions |
|
description: | |
|
Returns RD transactions matching the provided filters. |
|
operationId: transactionsSampleByPOC |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: units |
|
in: query |
|
description: Units of measure |
|
schema: |
|
type: string |
|
default: standard |
|
enum: |
|
- standard |
|
- reported |
|
- name: poc |
|
in: query |
|
description: Parameter Occurrence Code - the monitor number. |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 1 |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsSample/byMA: |
|
get: |
|
tags: |
|
- transactionsSample |
|
summary: Returns AQS sample (raw data) input transactions |
|
description: | |
|
Returns RD transactions matching the provided filters. |
|
operationId: transactionsSampleByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: units |
|
in: query |
|
description: Units of measure |
|
schema: |
|
type: string |
|
default: standard |
|
enum: |
|
- standard |
|
- reported |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsQaAnnualPerformanceEvaluations/bySite: |
|
get: |
|
tags: |
|
- transactionsQaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data in AQS transaction format |
|
for a single site |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided in AQS transaction format. |
|
operationId: transactionsQaAnnualPerformanceEvaluationsBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsQaAnnualPerformanceEvaluations/byCounty: |
|
get: |
|
tags: |
|
- transactionsQaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data in AQS transaction format |
|
for a single county |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided in AQS transaction format. |
|
operationId: transactionsQaAnnualPerformanceEvaluationsByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsQaAnnualPerformanceEvaluations/byState: |
|
get: |
|
tags: |
|
- transactionsQaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data in AQS transaction format |
|
for a single State |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided in AQS transaction format. |
|
operationId: transactionsQaAnnualPerformanceEvaluationsByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsQaAnnualPerformanceEvaluations/byPQAO: |
|
get: |
|
tags: |
|
- transactionsQaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data in AQS transaction format |
|
for a give Primary Quality Assurance Organization |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided in AQS transaction format. |
|
operationId: transactionsQaAnnualPerformanceEvaluationsByPQAO |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 |
|
digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/transactionsQaAnnualPerformanceEvaluations/byMA: |
|
get: |
|
tags: |
|
- transactionsQaAnnualPerformanceEvaluations |
|
summary: Returns QA Annual Performance Evaluation data in AQS transaction format |
|
for a single Monitoring Agency |
|
description: | |
|
Provides pairs of data (known and measured values) at several concentration levels matching the variables provided in AQS transaction format. |
|
operationId: transactionsQaAnnualPerformanceEvaluationsByMA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/monitors/byState: |
|
get: |
|
tags: |
|
- monitors |
|
summary: Returns monitor data by state |
|
operationId: monitorsByState |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/monitors/byCounty: |
|
get: |
|
tags: |
|
- monitors |
|
summary: Returns monitor data by county |
|
operationId: monitorsByCounty |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/monitors/bySite: |
|
get: |
|
tags: |
|
- monitors |
|
summary: Returns monitor data by site |
|
operationId: monitorsBySite |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
- name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
- name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/monitors/byCBSA: |
|
get: |
|
tags: |
|
- monitors |
|
summary: Returns monitor data by site |
|
operationId: monitorsByCBSA |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbsa |
|
in: query |
|
description: CBSA code - must be five digits including leading zeroes. Use |
|
list/cbsas to find the CSA codes. |
|
required: true |
|
schema: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/monitors/byBox: |
|
get: |
|
tags: |
|
- monitors |
|
summary: Returns monitor data within a latitude / longitude bounding box |
|
operationId: monitorsByBox |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
- name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
- name: minlat |
|
in: query |
|
description: Minimum Latitude - the southernmost extent of a bounding box |
|
query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: maxlat |
|
in: query |
|
description: Maximum Latitude - the northernmost extent of a bounding box |
|
query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: minlon |
|
in: query |
|
description: | |
|
Minimum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. And -70 is less than -60. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
- name: maxlon |
|
in: query |
|
description: | |
|
Maximum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/metaData/fieldsByService: |
|
get: |
|
tags: |
|
- metaData |
|
summary: Returns meta data for each service |
|
operationId: metaDataFields |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
- name: service |
|
in: query |
|
description: Service name |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/metaData/isAvailable: |
|
get: |
|
tags: |
|
- metaData |
|
summary: Ping to see if API service is working |
|
operationId: metaDataAvailable |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/metaData/revisionHistory: |
|
get: |
|
tags: |
|
- metaData |
|
summary: Returns notices to changes to services, documentation, web pages, historical |
|
data, etc. |
|
operationId: revisionHistory |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/metaData/issues: |
|
get: |
|
tags: |
|
- metaData |
|
summary: Returns known issues with the API |
|
operationId: issues |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
- name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/signup: |
|
get: |
|
tags: |
|
- register |
|
summary: Request an account by providing an email address |
|
description: Service will send an email to the provided address with verification |
|
link and password. |
|
operationId: requestAccount |
|
parameters: |
|
- name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
text/csv: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
security: |
|
- aqs_api_auth: [] |
|
/serviceAvailable: |
|
get: |
|
tags: |
|
- available |
|
summary: Ping to see if the service is working |
|
description: This service returns the timestamp if the system is available. |
|
operationId: serviceAvailable |
|
responses: |
|
200: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
400: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
422: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
500: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
503: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
components: |
|
schemas: |
|
Data: |
|
type: object |
|
properties: |
|
response: |
|
type: string |
|
example: SELECT * FROM table_name WHERE params=values |
|
List: |
|
required: |
|
- code |
|
- value |
|
type: object |
|
properties: |
|
code: |
|
type: string |
|
example: "01" |
|
value: |
|
type: string |
|
example: Alabama |
|
ApiResponse: |
|
type: object |
|
properties: |
|
transactionID: |
|
type: integer |
|
format: int32 |
|
responses: |
|
BadRequest: |
|
description: | |
|
Bad request. Some of the query criteria (variables or values) entered are invalid. A JSON object with a header array containing a specific error is returned. If you did not receive a specific error (some browsers trap 400 responses), things to check include: all required query parameters have been included; the date formats are correct (YYYYMMDD with no punctuation); codes have been used where expected (e.g., state code, duration code). |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
ServiceNotFound: |
|
description: | |
|
The requested service was not found. The endpoint is correct but there is likely a typo in the specific service name. A JSON object with a header array containing a specific error is returned. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
SuccessfulRequest: |
|
description: | |
|
Successful request. A JSON object is returned. There are two arrays in the returned object. First is a Header array that contains one object with a summary information about the request. Second is a Data array that will contain an object for each 'row' of returned data. Specific schemas for each data object can be viewed by using the _metaData/fieldsByService_ service. |
|
content: |
|
application/json: |
|
schema: |
|
type: object |
|
properties: |
|
Header: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
Data: |
|
type: array |
|
items: |
|
type: object |
|
properties: {} |
|
SystemDown: |
|
description: | |
|
Our API is down. We have weekly scheduled maintenance Sundays from 1800 - 2359 eastern standard time (GMT-5). If you are getting this message outside that time window, we are experiencing unexpected problems. You may check our news feed at http://www3.epa.gov/airquality/airdata/rssairdata.xml or email aqsdatamart@epa.gov for additional information. |
|
content: {} |
|
SystemError: |
|
description: | |
|
Internal error. We are experiencing unexpected problems. Please send an email to aqsdatamart@epa.gov to let us know about the problem. Provide as much information a you can. Particularly helpful are the request URL and the time of the request. |
|
content: {} |
|
parameters: |
|
userParam: |
|
name: email |
|
in: query |
|
description: User ID (email address) |
|
required: true |
|
schema: |
|
type: string |
|
example: test@aqs.api |
|
pwParam: |
|
name: key |
|
in: query |
|
description: Key |
|
required: true |
|
schema: |
|
type: string |
|
example: test |
|
paramParam: |
|
name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
required: true |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
example: 88101,44201 |
|
optionalParam: |
|
name: param |
|
in: query |
|
description: | |
|
Parameter code. Enter a 5-digit AQS parameter code (or multiple codes separated by commas). Example 44201,88101,88502. Use the list/parametersByClass service for valid parameter codes. (e.g., https://aqs.epa.gov/data/api/list/parametersByClass?email=test@aqs.api&key=test&pc=CRITERIA) |
|
style: form |
|
explode: false |
|
schema: |
|
type: array |
|
items: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
example: 88101,44201 |
|
stateParam: |
|
name: state |
|
in: query |
|
description: | |
|
State FIPS code - must be two digits including leading zero Use the list/states service for a list of state codes (e.g., https://aqs.epa.gov/data/api/list/states?email=test@aqs.api&key=test). |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 2 |
|
pattern: ^[0-9][0-9]$ |
|
type: string |
|
example: "16" |
|
countyParam: |
|
name: county |
|
in: query |
|
description: County FIPS code - must be three digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 3 |
|
minLength: 3 |
|
pattern: ^[0-9][0-9][0-9]$ |
|
type: string |
|
example: "001" |
|
siteParam: |
|
name: site |
|
in: query |
|
description: Site number - must be four digits including leading zeroes. |
|
required: true |
|
schema: |
|
maxLength: 4 |
|
minLength: 4 |
|
pattern: ^[0-9][0-9][0-9][0-9]$ |
|
type: string |
|
example: "0010" |
|
pocParam: |
|
name: poc |
|
in: query |
|
description: Parameter Occurrence Code - the monitor number. |
|
required: true |
|
schema: |
|
maxLength: 2 |
|
minLength: 1 |
|
type: string |
|
example: "1" |
|
unitsParam: |
|
name: units |
|
in: query |
|
description: Units of measure |
|
schema: |
|
type: string |
|
default: standard |
|
enum: |
|
- standard |
|
- reported |
|
example: standard |
|
CBSAParam: |
|
name: cbsa |
|
in: query |
|
description: CBSA code - must be five digits including leading zeroes. Use |
|
list/cbsas to find the CSA codes. |
|
required: true |
|
schema: |
|
maxLength: 5 |
|
minLength: 5 |
|
pattern: ^[0-9][0-9][0-9][0-9][0-9]$ |
|
type: string |
|
example: "14260" |
|
minlatParam: |
|
name: minlat |
|
in: query |
|
description: Minimum Latitude - the southernmost extent of a bounding box query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
example: 43.6 |
|
maxlatParam: |
|
name: maxlat |
|
in: query |
|
description: Maximum Latitude - the northernmost extent of a bounding box query. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
example: 43.7 |
|
minlonParam: |
|
name: minlon |
|
in: query |
|
description: | |
|
Minimum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. And -70 is less than -60. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
example: -116.5 |
|
maxlonParam: |
|
name: maxlon |
|
in: query |
|
description: | |
|
Maximum Longitude - the westernmost extent of a bounding box query. Use negative values for the western hemisphere. |
|
required: true |
|
schema: |
|
maximum: 180 |
|
minimum: -180 |
|
type: number |
|
example: -116 |
|
bdateParam: |
|
name: bdate |
|
in: query |
|
description: Begin date of data (YYYYMMDD). For example 20100101. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
example: 20180301 |
|
edateParam: |
|
name: edate |
|
in: query |
|
description: End date of data (YYYYMMDD). For example 20101231. |
|
required: true |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
example: 20180331 |
|
cbdateParam: |
|
name: cbdate |
|
in: query |
|
description: | |
|
Beginning of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
example: 20180101 |
|
cedateParam: |
|
name: cedate |
|
in: query |
|
description: | |
|
End of window to look for changed data (YYYYMMDD). For example, to get data for 2010 that last changed in March of 2011, use these parameters. bdate = 20100101, edate = 20101231, cbdate = 20110301, cedate = 20110331. |
|
schema: |
|
maximum: 21991231 |
|
minimum: 19000101 |
|
maxLength: 8 |
|
minLength: 8 |
|
pattern: ^(19|20|21)[0-9]{2}(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])$ |
|
type: integer |
|
example: 20190430 |
|
pqaoParam: |
|
name: pqao |
|
in: query |
|
description: Code for the primary quality assurance organization - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
example: "0511" |
|
agencyParam: |
|
name: agency |
|
in: query |
|
description: Code for the monitoring agency - up to 4 digits |
|
required: true |
|
schema: |
|
type: string |
|
example: "0511" |
|
serviceParam: |
|
name: service |
|
in: query |
|
description: Service name |
|
required: true |
|
schema: |
|
type: string |
|
example: sampleData |
|
securitySchemes: |
|
aqs_api_auth: |
|
type: apiKey |
|
name: key |
|
in: query |