AQS Data API documentation version 1.1

https://aqs.epa.gov/api

Introduction

Welcome to the AQS (Air Quality System) API. AQS contains the data that the US EPA has collected via the national ambient air monitoring program. It also includes the associated aggregate values calculated by EPA (8-hour, daily, annual, etc.). The intended users of the Data Mart are air quality data analysts in the regulatory, academic, and health research communities who are familiar with AQS data. This document only describes the API and not the nuances of the air quality data.

About Notify Services

You will see that each service is available in two forms. The basic service and the Notify service. The basic service is a synchronous service that requires the connection to remain open to complete. This is intended for users of the GUI. The Notify service is an asynchronous service that allows the connection to be ended and the data retrieved later. It is the nominal form to use if accessing the API and not the GUI and can be used in conjunction with the status and retrieve services. _The data from each service is exactly the same, the only difference is the delivery mechanism.

How to use this document

Each service is listed below. First the class of service and then the name of the service (in our case, these are identical). Click on the name of the service to get a brief description of the data it provides and an example URL. Clikc on the "get" button to see the list of all variables that can be used to query the data (on the "Rrequest" tab). Click the "Response" tab to see the description of possible responses and a description the contents of the returned data.

Registration

Registration is required to use this API. To register please visit https://aqs.epa.gov/signup.

Change Log

Verion 1.1

Profile service added.
Minor editorial changes.

/rawData

/rawData get

get

Returns raw data that match your query criteria. This is a synchronous query that returns data to your screen, so you must stay connected to the web page while the query runs.

Example. To select ozone data for Durham County, NC, for May 01, 2011, using a synchronous query and returning data in DMCSV format

(This URL will not work unless you replace the asterisks with your credentials)

https://aqs.epa.gov/api/rawData?user=*&pw=**&format=DMCSV&param=44201&bdate=20110501&edate=20110501&state=37&county=063

Returns raw data that match your query criteria. This is a synchronous query that returns data to your screen, so you must stay connected to the web page while the query runs.

Example. To select ozone data for Durham County, NC, for May 01, 2011, using a synchronous query and returning data in DMCSV format

(This URL will not work unless you replace the asterisks with your credentials)

https://aqs.epa.gov/api/rawData?user=*&pw=**&format=DMCSV&param=44201&bdate=20110501&edate=20110501&state=37&county=063

Request
Response

Query Parameters

user (User ID): required (string)
The user ID for the requesting account. Usually an email address.
Example:
```
api.user@example.com
```
pw (Password): required (string)
The password for the requesting account.
Example:
```
passwordtext
```
format (Output Format): (one of DMCSV, AQCSV, AQS - default: DMCSV)
The desired format for the output of the query.
Example:
```
DMCSV
```
pc (Parameter Class): (string)
The group of parameters you would like to filter the query results on.
Example:
```
CRITERIA
```
param (Parameter Code): (string - minLength: 5 - maxLength: 5)
The 5 digit AQS parameter code you would like to filter the query results on.
Example:
```
44201
```
bdate (Begin Date): required (string)
The begin date of data in YYYYMMDD format.
Example:
```
20140101
```
edate (End Date): required (string)
The end date of data in YYYYMMDD format.
Example:
```
20141231
```
cbdate (Change Begin Date of data): (string)
Filters data to return only values that changed after this date. YYYYMMDD format.
Example:
```
20150101
```
cedate (Change End Date of data): (string)
Filters data to return only values that changed before this date. YYYYMMDD format.
Example:
```
20151231
```
state (State Code): (string - minLength: 2 - maxLength: 2)
The 2 digit (leading zeroes required) FIPS code for the state you would like to filter the query results on.
Example:
```
1
```
county (County Code): (string - minLength: 3 - maxLength: 3)
The 3 digit (leading zeroes required) FIPS code for the county you would like to filter the query results on.
Example:
```
089
```
site (Site Number): (string - minLength: 4 - maxLength: 4)
The 4 digit (leading zeroes required) AQS ID number for the site within the county that you would like to filter the query results on.
Example:
```
12
```
cbsa (CBSA Code): (string - minLength: 5 - maxLength: 5)
The 5 digit (leading zeroes required) Census code for the Core Based Statistical Area you would like to filter the query results on.
Example:
```
26620
```
csa (CSA Code): (string - minLength: 3 - maxLength: 3)
The 3 digit (leading zeroes required) Census code for the Consolidated Statistical Area you would like to filter the query results on.
Example:
```
290
```
minlat (Minimum Latitude): (number)
The southernmost extent of a bounding box query.
Example:
```
34.66
```
maxlat (Maximum Latitude): (number)
The northernmost extent of a bounding box query.
Example:
```
34.7
```
minlon (Minimum Longitude): (number)
The westernmost extent of a bounding box query. Negative values represent the western hemisphere.
Example:
```
-86.6166
```
maxlon (Maximum Longitude): (number)
The easternmost extent of a bounding box query. Negative values represent the western hemisphere.
Example:
```
-86.5
```
dur (Duration Code): (string - minLength: 1 - maxLength: 1)
The AQS duration code that you would like to filter the query results on.
Example:
```
7
```
frmonly (FRM Only Indicator): (string - minLength: 1 - maxLength: 1)
Data from Federal Reference (and Equivalent) Methods only. Y will return only FRM/FEM data. N will return data that is not FRM/FEM. Leaving this option off will return all data.
Example:
```
Y
```

HTTP status code 200

The output of the raw data query request that matches the selection criteria specified in the format requested.

Contents of returned file

The returned file will contain a header row and one row for each sample value we have.

The format of the returned data will depend on the output format you selected. (If you selected none, it will be DMCSV by default).

DMCSV

The Data Mart Comma Separated Values format is described here: https://aqs.epa.gov/aqsweb/documents/DMCSV_Format.html

AQCSV

The AirNow Air Quality Comma Separated Values format is described here: https://aqs.epa.gov/aqsweb/documents/AQCSV_Format.html

AQS

The AQS pipe delimited (transaction) format is described here: https://aqs.epa.gov/aqsweb/documents/AQS_Format.html

Body

Type: */*

HTTP status code 400

Bad request. Some of the query criteria entered are invalid.

There could be serveral reasons for this. We attempt to inform you if your credentials are invalid, if the other query parameters are invalid, or if the query exceeds the allowable size limits. However some browsers intercept HTTP 400 responses and remove the detailed message.

Things to check:

All required query parameters have been included
The query size limits have not been exceeded https://aqs.epa.gov/aqsweb/documents/gui_query.html#limits
The date formats are correct (YYYYMMDD with no punctuation)
Codes have been used where exptected (e.g., state code, duration code)

HTTP status code 500

Internal server error. 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.

HTTP status code 503

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.

/rawDataNotify

/rawDataNotify get

get

Returns raw data that match your query criteria. This is an asynchronous query that returns a Transaction ID number. The query is run on our servers and when it is complete, an email will be sent you with a link to your data (tied to the Transaction ID). After submitting this query, you may close your browser or end your session.

Example. To select ozone data for Durham County, NC, for May 01, 2011, using an asynchronous query and returning data in DMCSV format

(This URL will not work unless you replace the asterisks with your credentials)

https://aqs.epa.gov/api/rawDataNotify?user=*&pw=**&format=DMCSV&param=44201&bdate=20110501&edate=20110501&state=37&county=063

Example. To select ozone data for Durham County, NC, for May 01, 2011, using an asynchronous query and returning data in DMCSV format

(This URL will not work unless you replace the asterisks with your credentials)

https://aqs.epa.gov/api/rawDataNotify?user=*&pw=**&format=DMCSV&param=44201&bdate=20110501&edate=20110501&state=37&county=063

Request
Response

Query Parameters

user (User ID): required (string)
The user ID for the requesting account. Usually an email address.
Example:
```
api.user@example.com
```
pw (Password): required (string)
The password for the requesting account.
Example:
```
passwordtext
```
format (Output Format): (one of DMCSV, AQCSV, AQS - default: DMCSV)
The desired format for the output of the query.
Example:
```
DMCSV
```
pc (Parameter Class): (string)
The group of parameters you would like to filter the query results on.
Example:
```
CRITERIA
```
param (Parameter Code): (string - minLength: 5 - maxLength: 5)
The 5 digit AQS parameter code you would like to filter the query results on.
Example:
```
44201
```
bdate (Begin Date): required (string)
The begin date of data in YYYYMMDD format.
Example:
```
20140101
```
edate (End Date): required (string)
The end date of data in YYYYMMDD format.
Example:
```
20141231
```
cbdate (Change Begin Date of data): (string)
Filters data to return only values that changed after this date. YYYYMMDD format.
Example:
```
20150101
```
cedate (Change End Date of data): (string)
Filters data to return only values that changed before this date. YYYYMMDD format.
Example:
```
20151231
```
state (State Code): (string - minLength: 2 - maxLength: 2)
The 2 digit (leading zeroes required) FIPS code for the state you would like to filter the query results on.
Example:
```
1
```
county (County Code): (string - minLength: 3 - maxLength: 3)
The 3 digit (leading zeroes required) FIPS code for the county you would like to filter the query results on.
Example:
```
089
```
site (Site Number): (string - minLength: 4 - maxLength: 4)
The 4 digit (leading zeroes required) AQS ID number for the site within the county that you would like to filter the query results on.
Example:
```
12
```
cbsa (CBSA Code): (string - minLength: 5 - maxLength: 5)
The 5 digit (leading zeroes required) Census code for the Core Based Statistical Area you would like to filter the query results on.
Example:
```
26620
```
csa (CSA Code): (string - minLength: 3 - maxLength: 3)
The 3 digit (leading zeroes required) Census code for the Consolidated Statistical Area you would like to filter the query results on.
Example:
```
290
```
minlat (Minimum Latitude): (number)
The southernmost extent of a bounding box query.
Example:
```
34.66
```
maxlat (Maximum Latitude): (number)
The northernmost extent of a bounding box query.
Example:
```
34.7
```
minlon (Minimum Longitude): (number)
The westernmost extent of a bounding box query. Negative values represent the western hemisphere.
Example:
```
-86.6166
```
maxlon (Maximum Longitude): (number)
The easternmost extent of a bounding box query. Negative values represent the western hemisphere.
Example:
```
-86.5
```
dur (Duration Code): (string - minLength: 1 - maxLength: 1)
The AQS duration code that you would like to filter the query results on.
Example:
```
7
```
frmonly (FRM Only Indicator): (string - minLength: 1 - maxLength: 1)
Data from Federal Reference (and Equivalent) Methods only. Y will return only FRM/FEM data. N will return data that is not FRM/FEM. Leaving this option off will return all data.
Example:
```
Y
```

HTTP status code 200

The transaction ID of the request. The request will be processed in the backgroud and an email will be sent to the user when it is ready for retrieval.

The returned file contains the output of the raw data query request that matches the selection criteria specified in the format requested.

Contents of returned file

The returned file will contain a header row and one row for each sample value we have.

The format of the returned data will depend on the output format you selected. (If you selected none, it will be DMCSV by default).

DMCSV

The Data Mart Comma Separated Values format is described here: https://aqs.epa.gov/aqsweb/documents/DMCSV_Format.html

AQCSV

The AirNow Air Quality Comma Separated Values format is described here: https://aqs.epa.gov/aqsweb/documents/AQCSV_Format.html

AQS

The AQS pipe delimited (transaction) format is described here: https://aqs.epa.gov/aqsweb/documents/AQS_Format.html

Body

Type: */*

HTTP status code 400

Bad request. Some of the query criteria entered are invalid.

Things to check:

All required query parameters have been included
The query size limits have not been exceeded https://aqs.epa.gov/aqsweb/documents/gui_query.html#limits
The date formats are correct (YYYYMMDD with no punctuation)
Codes have been used where exptected (e.g., state code, duration code)

HTTP status code 500

HTTP status code 503

/profile

/profile get

get

The purpose of this service is to give users a "profile" of the available data in the system before they construct other queries to retrieve the data.

Returns a list of monitors that match your selection criteria and a profile of the data available from those monitors. Any monitor that matches your selection criteria will be returned. Particular attention should be paid to the time window. If the monitor operated between the years of the begin date and end date (only full years are considered), the monitor will be included in the returned list. However, information about the entire operational history of the monitor will be included in the returned file.

This is a synchronous query that returns data to your screen, so you must stay connected to the web page while the query runs.

Example. To select ozone monitors for Durham County, NC that operated between 2010 and 2015, using a synchronous query and returning data in CSV format

(This URL will not work unless you replace the asterisks with your credentials)

https://aqs.epa.gov/api/profile?user=*&pw=**&format=CSV&param=44201&bdate=2010&edate=2015&state=37&county=063

The purpose of this service is to give users a "profile" of the available data in the system before they construct other queries to retrieve the data.

This is a synchronous query that returns data to your screen, so you must stay connected to the web page while the query runs.

Example. To select ozone monitors for Durham County, NC that operated between 2010 and 2015, using a synchronous query and returning data in CSV format

(This URL will not work unless you replace the asterisks with your credentials)

https://aqs.epa.gov/api/profile?user=*&pw=**&format=CSV&param=44201&bdate=2010&edate=2015&state=37&county=063

Request
Response

Query Parameters

user (User ID): required (string)
The user ID for the requesting account. Usually an email address.
Example:
```
api.user@example.com
```
pw (Password): required (string)
The password for the requesting account.
Example:
```
passwordtext
```
format (Output Format): (one of CSV - default: CSV)
The desired format for the output of the query.
Example:
```
CSV
```
pc (Parameter Class): (string)
The group of parameters you would like to filter the query results on.
Example:
```
CRITERIA
```
param (Parameter Code): (string - minLength: 5 - maxLength: 5)
The 5 digit AQS parameter code you would like to filter the query results on.
Example:
```
44201
```
bdate (Begin Date): required (string)
The begin date of data in YYYYMMDD format. The system will use full years when extracting data (the month and day will be ignored).
Example:
```
20140101
```
edate (End Date): required (string)
The end date of data in YYYYMMDD format. The system will use full years when extracting data (the month and day will be ignored).
Example:
```
20141231
```
state (State Code): (string - minLength: 2 - maxLength: 2)
The 2 digit (leading zeroes required) FIPS code for the state you would like to filter the query results on.
Example:
```
1
```
county (County Code): (string - minLength: 3 - maxLength: 3)
The 3 digit (leading zeroes required) FIPS code for the county you would like to filter the query results on.
Example:
```
089
```
site (Site Number): (string - minLength: 4 - maxLength: 4)
The 4 digit (leading zeroes required) AQS ID number for the site within the county that you would like to filter the query results on.
Example:
```
12
```
cbsa (CBSA Code): (string - minLength: 5 - maxLength: 5)
The 5 digit (leading zeroes required) Census code for the Core Based Statistical Area you would like to filter the query results on.
Example:
```
26620
```
csa (CSA Code): (string - minLength: 3 - maxLength: 3)
The 3 digit (leading zeroes required) Census code for the Consolidated Statistical Area you would like to filter the query results on.
Example:
```
290
```
minlat (Minimum Latitude): (number)
The southernmost extent of a bounding box query.
Example:
```
34.66
```
maxlat (Maximum Latitude): (number)
The northernmost extent of a bounding box query.
Example:
```
34.7
```
minlon (Minimum Longitude): (number)
The westernmost extent of a bounding box query. Negative values represent the western hemisphere.
Example:
```
-86.6166
```
maxlon (Maximum Longitude): (number)
The easternmost extent of a bounding box query. Negative values represent the western hemisphere.
Example:
```
-86.5
```

HTTP status code 200

The output of the raw profile query request that matches the selection criteria specified in the format requested.

Contents of returned file

The returned file will contain a header row and one row for each monitor.

Field Position	Field Name	Description
1	State Code	The FIPS code of the state in which the monitor resides.
2	County Code	The FIPS code of the county in which the monitor resides.
3	Site Number	A unique number within the county identifying the site.
4	Parameter Code	The AQS code corresponding to the parameter measured by the monitor.
5	Parameter Name	The name or description assigned in AQS to the parameter measured by the monitor. Parameters may be pollutants or non-pollutants.
6	POC	This is the “Parameter Occurrence Code” used to distinguish different instruments that measure the same parameter at the same site.
7	Sample Duration	The length of time that air passes through the monitoring device before it is analyzed (measured). So, it represents an averaging period in the atmosphere (for example, a 24-hour sample duration draws ambient air over a collection filter for 24 straight hours). For continuous monitors, it can represent an averaging time of many samples (for example, a 1-hour value may be the average of four one-minute samples collected during each quarter of the hour).
8	First Year of Data	The year in which the monitor first collected data.
9	Last Sample Date	The last date for which data has been reported for the monitor.
10	Total Samples	The total number of sample values reported for the monitor.
11	Null Samples	The number of null samples (missing values) reported for the monitor.
12	Qualified Samples	The number of samples with a qualifier code.
13	Sample Frequency	List all unique sample frequencies during the time window listed; seperated by a semicolon.
14	Methods(Federal MDL)	List all method codes this monitor used to collect data and the federal (default) method detection limit for each method (in parentheses); each separated by a semicolon.
15	Network Affiliations	List all networks this monitor was affiliated with during operation; seperated by a semicolon.
16	Primary Indicator	Set to "Y" if the monitor is a NAAQS primary or QA primary monitor.
17	Monitor Close Date	The date on which the monitor ceased operating.
18	Latitude	The monitoring site's angular distance north of the equator measured in decimal degrees.
19	Longitude	The monitoring site's angular distance east of the prime meridian measured in decimal degrees.
20	Datum	The Datum associated with the Latitude and Longitude measures.
21	Elevation	The elevation of the ground at the site in meters above mean sea level.
22	State Name	The name of the state where the monitoring site is located.
23	County Name	The name of the county where the monitoring site is located.
24	City Name	The name of the city where the monitoring site is located. This represents the legal incorporated boundaries of cities and not urban areas.
25	CSBA Name	The name of the core based statistical area (metropolitan area) where the monitoring site is located.
26	Local Site Name	The name of the site (if any) given by the State, local, or tribal air pollution control agency that operates it.
27	Reporting Agency	The name of the air pollution control agency responsible for reporting data from this monitor to the US EPA.
28	PQAO	The name of the primary quality assurance organization responsible for the data quality at this monitor.
29	As of Date	The date this data was extracted from the AQS Data Mart database.

Body

Type: */*

HTTP status code 400

Bad request. Some of the query criteria entered are invalid.

Things to check:

All required query parameters have been included
The query size limits have not been exceeded https://aqs.epa.gov/aqsweb/documents/gui_query.html#limits
The date formats are correct (YYYYMMDD with no punctuation)
Codes have been used where exptected (e.g., state code, duration code)

HTTP status code 500

HTTP status code 503

/profileNotify

/profileNotify get

get

This is an asynchronous query that returns a Transaction ID number. The query is run on our servers and when it is complete, an email will be sent you with a link to your data (tied to the Transaction ID). After submitting this query, you may close your browser or end your session.

Example. To select ozone monitors for Durham County, NC that operated between 2010 and 2015, using a synchronous query and returning data in CSV format

(This URL will not work unless you replace the asterisks with your credentials)

https://aqs.epa.gov/api/profileNotify?user=*&pw=**&format=CSV&param=44201&bdate=2010&edate=2015&state=37&county=063

Example. To select ozone monitors for Durham County, NC that operated between 2010 and 2015, using a synchronous query and returning data in CSV format

(This URL will not work unless you replace the asterisks with your credentials)

https://aqs.epa.gov/api/profileNotify?user=*&pw=**&format=CSV&param=44201&bdate=2010&edate=2015&state=37&county=063

Request
Response

Query Parameters

user (User ID): required (string)
The user ID for the requesting account. Usually an email address.
Example:
```
api.user@example.com
```
pw (Password): required (string)
The password for the requesting account.
Example:
```
passwordtext
```
format (Output Format): (one of CSV - default: CSV)
The desired format for the output of the query.
Example:
```
CSV
```
pc (Parameter Class): (string)
The group of parameters you would like to filter the query results on.
Example:
```
CRITERIA
```
param (Parameter Code): (string - minLength: 5 - maxLength: 5)
The 5 digit AQS parameter code you would like to filter the query results on.
Example:
```
44201
```
bdate (Begin Date): required (string)
The begin date of data in YYYYMMDD format. The system will use full years when extracting data (the month and day will be ignored).
Example:
```
20140101
```
edate (End Date): required (string)
The end date of data in YYYYMMDD format. The system will use full years when extracting data (the month and day will be ignored).
Example:
```
20141231
```
state (State Code): (string - minLength: 2 - maxLength: 2)
The 2 digit (leading zeroes required) FIPS code for the state you would like to filter the query results on.
Example:
```
1
```
county (County Code): (string - minLength: 3 - maxLength: 3)
The 3 digit (leading zeroes required) FIPS code for the county you would like to filter the query results on.
Example:
```
089
```
site (Site Number): (string - minLength: 4 - maxLength: 4)
The 4 digit (leading zeroes required) AQS ID number for the site within the county that you would like to filter the query results on.
Example:
```
12
```
cbsa (CBSA Code): (string - minLength: 5 - maxLength: 5)
The 5 digit (leading zeroes required) Census code for the Core Based Statistical Area you would like to filter the query results on.
Example:
```
26620
```
csa (CSA Code): (string - minLength: 3 - maxLength: 3)
The 3 digit (leading zeroes required) Census code for the Consolidated Statistical Area you would like to filter the query results on.
Example:
```
290
```
minlat (Minimum Latitude): (number)
The southernmost extent of a bounding box query.
Example:
```
34.66
```
maxlat (Maximum Latitude): (number)
The northernmost extent of a bounding box query.
Example:
```
34.7
```
minlon (Minimum Longitude): (number)
The westernmost extent of a bounding box query. Negative values represent the western hemisphere.
Example:
```
-86.6166
```
maxlon (Maximum Longitude): (number)
The easternmost extent of a bounding box query. Negative values represent the western hemisphere.
Example:
```
-86.5
```

HTTP status code 200

The transaction ID of the request. The request will be processed in the backgroud and an email will be sent to the user when it is ready for retrieval.

The output of the raw profile query request that matches the selection criteria specified in the format requested.

Contents of returned file

The returned file will contain a header row and one row for each monitor.

Field Position	Field Name	Description
1	State Code	The FIPS code of the state in which the monitor resides.
2	County Code	The FIPS code of the county in which the monitor resides.
3	Site Number	A unique number within the county identifying the site.
4	Parameter Code	The AQS code corresponding to the parameter measured by the monitor.
5	Parameter Name	The name or description assigned in AQS to the parameter measured by the monitor. Parameters may be pollutants or non-pollutants.
6	POC	This is the “Parameter Occurrence Code” used to distinguish different instruments that measure the same parameter at the same site.
7	Sample Duration	The length of time that air passes through the monitoring device before it is analyzed (measured). So, it represents an averaging period in the atmosphere (for example, a 24-hour sample duration draws ambient air over a collection filter for 24 straight hours). For continuous monitors, it can represent an averaging time of many samples (for example, a 1-hour value may be the average of four one-minute samples collected during each quarter of the hour).
8	First Year of Data	The year in which the monitor first collected data.
9	Last Sample Date	The last date for which data has been reported for the monitor.
10	Total Samples	The total number of sample values reported for the monitor.
11	Null Samples	The number of null samples (missing values) reported for the monitor.
12	Qualified Samples	The number of samples with a qualifier code.
13	Sample Frequency	List all unique sample frequencies during the time window listed; seperated by a semicolon.
14	Methods(Federal MDL)	List all method codes this monitor used to collect data and the federal (default) method detection limit for each method (in parentheses); each separated by a semicolon.
15	Network Affiliations	List all networks this monitor was affiliated with during operation; seperated by a semicolon.
16	Primary Indicator	Set to "Y" if the monitor is a NAAQS primary or QA primary monitor.
17	Monitor Close Date	The date on which the monitor ceased operating.
18	Latitude	The monitoring site's angular distance north of the equator measured in decimal degrees.
19	Longitude	The monitoring site's angular distance east of the prime meridian measured in decimal degrees.
20	Datum	The Datum associated with the Latitude and Longitude measures.
21	Elevation	The elevation of the ground at the site in meters above mean sea level.
22	State Name	The name of the state where the monitoring site is located.
23	County Name	The name of the county where the monitoring site is located.
24	City Name	The name of the city where the monitoring site is located. This represents the legal incorporated boundaries of cities and not urban areas.
25	CSBA Name	The name of the core based statistical area (metropolitan area) where the monitoring site is located.
26	Local Site Name	The name of the site (if any) given by the State, local, or tribal air pollution control agency that operates it.
27	Reporting Agency	The name of the air pollution control agency responsible for reporting data from this monitor to the US EPA.
28	PQAO	The name of the primary quality assurance organization responsible for the data quality at this monitor.
29	As of Date	The date this data was extracted from the AQS Data Mart database.

Body

Type: */*

HTTP status code 400

Bad request. Some of the query criteria entered are invalid.

Things to check:

All required query parameters have been included
The query size limits have not been exceeded https://aqs.epa.gov/aqsweb/documents/gui_query.html#limits
The date formats are correct (YYYYMMDD with no punctuation)
Codes have been used where exptected (e.g., state code, duration code)

HTTP status code 500

HTTP status code 503

/status

/status get

get

Returns the status of a previously submitted job.

Example. To get the status of Transaction ID = 123456789

https://aqs.epa.gov/api/status?id=123456789.

Returns the status of a previously submitted job.

Example. To get the status of Transaction ID = 123456789

https://aqs.epa.gov/api/status?id=123456789.

Request
Response

Query Parameters

id (Transaction ID): required (integer)
The transaction ID of the previously submitted request for data.
Example:
```
123456789
```
user (User ID): (string)
The user ID for the requesting account. Usually an email address.
Example:
```
api.user@example.com
```
pw (Password): (string)
The password for the requesting account.
Example:
```
passwordtext
```

HTTP status code 200

The current status of the previously submitted job. Possible values and their meanings are:

Completed: The service request has completed successfully.

Deleted: the output from the service request has been deleted.

Error: An error occurred while processing the service request.

Processing: The service request is still being processed.

Scheduled: The service request has been scheduled for aysnchronous processing at a later time.

Submitted: the service request has been accepted for processing, which has not begun yet.

Body

Type: */*

HTTP status code 500

HTTP status code 503

/retrieve

/retrieve get

get

Returns the data created with a previsously submitted request.

Example. To get the data created with Transaction ID = 123456789

https://aqs.epa.gov/api/retrieve?id=123456789.

Returns the data created with a previsously submitted request.

Example. To get the data created with Transaction ID = 123456789

https://aqs.epa.gov/api/retrieve?id=123456789.

Request
Response

Query Parameters

id (Transaction ID): required (integer)
The transaction ID of the previously submitted request for data.
Example:
```
123456789
```

HTTP status code 200

The mime encoded file containing the data resulting from the query request in the format requested.

Body

Type: */*

HTTP status code 500

HTTP status code 503

/list

/list get

get

Returns a list of valid values for a variable. Requesting a list takes three parts. The list name, the qualifier (what to filter the list on), and the resource - only one of which is currently available. To get a list of parameters (the list name) that belong to the Criteria parameter class (the qualifier) https://aqs.epa.gov/api/list?name=param&pc=CRITERIA

Request
Response

Query Parameters

name (List Name): required (one of state, county, site, pc, param, format, cbsa, csa, duration, agency)
The variable for which to show a list of valid values.
Example:
```
param
```
qualifier (Qualifier): (one of state, county, pc, agency_code)
The name of another variable to filter the list on.
Example:
```
pc
```
resource (Resource/Service Name): (one of rawData)
The name of the service to use as a reference for this list. There is currently only one valid value, so this is not required.
Example:
```
rawData
```
user (User ID): (string)
The user ID for the requesting account. Usually an email address.
Example:
```
api.user@example.com
```
pw (Password): (string)
The password for the requesting account.
Example:
```
passwordtext
```

HTTP status code 200

A tab delimeted list of values and meanings.

Body

Type: */*

HTTP status code 400

Bad request. Some of the query criteria entered are invalid.

Things to check:

All required query parameters have been included
The query size limits have not been exceeded https://aqs.epa.gov/aqsweb/documents/gui_query.html#limits
The date formats are correct (YYYYMMDD with no punctuation)
Codes have been used where exptected (e.g., state code, duration code)

HTTP status code 500

HTTP status code 503

/serviceAvailable

/serviceAvailable get

get

Returns a response if our services are working. Example https://aqs.epa.gov/api/serviceAvailable

AQS Data API documentation version 1.1

/rawData

get /rawData

Query Parameters

HTTP status code 200

Contents of returned file

DMCSV

AQCSV

AQS

Body

HTTP status code 400

HTTP status code 500

HTTP status code 503

/rawDataNotify

get /rawDataNotify

Query Parameters

HTTP status code 200

Contents of returned file

DMCSV

AQCSV

AQS

Body

HTTP status code 400

HTTP status code 500

HTTP status code 503

/profile

get /profile

Query Parameters

HTTP status code 200

Contents of returned file

Body

HTTP status code 400

HTTP status code 500

HTTP status code 503

/profileNotify

get /profileNotify

Query Parameters

HTTP status code 200

Contents of returned file

Body

HTTP status code 400

HTTP status code 500

HTTP status code 503

/status

get /status

Query Parameters

HTTP status code 200

Body

HTTP status code 500

HTTP status code 503

/retrieve

get /retrieve

Query Parameters

HTTP status code 200

Body

HTTP status code 500

HTTP status code 503

/list

get /list

Query Parameters

HTTP status code 200

Body

HTTP status code 400

HTTP status code 500

HTTP status code 503

/serviceAvailable

get /serviceAvailable

HTTP status code 200

Body

HTTP status code 500

HTTP status code 503