pyaqsapi.bysite package

pyaqsapi.bysite.annualsummary(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a DataFrame of annual data aggregated at the site level.

Annual summary contains a DataFrame matching the input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame. Variables returned include mean value, maxima, percentiles, and etc.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): annual summary data for the

sitenum, countycode and stateFIPS requested for the time frame between

bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of annualsummary data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a table of annual summary ozone data for the Millbrook School site (#0014) in Wake County, NC for 2017 (Note, for annual data, only the year portion of the bdate and edate are used and only whole years of data are returned. For example, bdate = 2017-12-31 and edate = 2018-01-01 will return full data for 2017 and 2018 ):

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.annualsummary(parameter="44201",
                          bdate=date(year=2017,
                                     month=6,
                                     day=18),
                          edate=date(year=2017,
                                     month=6,
                                     day=18),
                          stateFIPS="37",
                          countycode="183",
                          sitenum="0014")

pyaqsapi.bysite.dailysummary(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → DataFrame | AQSAPI_V2

Return a DataFrame of data aggregated at the site level.

Daily summary contains a DataFrame matching the input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame. Variables returned include mean value, maxima, percentiles, and etc.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): daily summary data for the

sitenum, countycode and stateFIPS requested for the time frame between

bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

DataFrame | AQSAPI_V2

Notes

The AQS API only allows for a single year of dailysummary data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of daily summary ozone data for the Millbrook School site (#0014) in Wake County, NC for June 18, 2017:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.dailysummary(parameter="44201",
                        bdate=date(year=2017,
                                   month=6,
                                   day=18),
                        edate=date(year=2017,
                                   month=6,
                                   day=18),
                        stateFIPS="37",
                        countycode="183",
                        sitenum="0014")

pyaqsapi.bysite.monitors(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of monitors.

Return a table of monitors and related metadata at sites

with the provided parameter, stateFIPS, county_code, and sitenum for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): monitors from

the selected site.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

All monitors that operated between the bdate and edate will be returned

Examples

Return a table of all SO2 monitors at the Hawaii NP site (#0007) in Hawaii County, HI that were operating between May 1 2015-2019:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.monitors(parameter="42401",
                    bdate=date(year=2015,
                               month=5,
                               day=1,),
                    edate=date(year=2019,
                               month=5,
                               day=2),
                    stateFIPS="15",
                    countycode="001",
                    sitenum="0007")

pyaqsapi.bysite.qa_annualpeferomanceeval(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return quality assurance performance evaluation data - aggregated by site for a parameter code aggregated by matching input parameter, sitenum, countycode and stateFIPS provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

performance evaluation data. for single monitoring site for the

sitenum, countycode and stateFIPS requested for the time frame

between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of quality assurance Annual Performance Evaluation data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return an DataFrame containing annual performance evaluation data for ozone at the Fairhope site in Baldwin County, AL for 2017:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.annualpeferomanceeval(parameter="44201",
                                 bdate=date(year=2017,
                                            month=1,
                                            day=1),
                                 edate=date(year=2017,
                                            month=12,
                                            day=31),
                                 stateFIPS="01",
                                 countycode="003",
                                 sitenum="0010")

pyaqsapi.bysite.qa_annualperformanceevaltransaction(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return AQS submissions transaction format (RD) of the annual performance evaluation data (raw). Includes data pairs for QA - aggregated by site for a parameter code aggregated by matching input parameter, sitenum, countycode and stateFIPS provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

performance evaluation data. for single monitoring site for the

sitenum, countycode and stateFIPS requested for the time frame

between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of quality assurance Annual Performance Evaluation transaction data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame containing annual performance evaluation data (raw) for ozone at the Fairhope site in Baldwin County, AL for 2017 in RD format:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_annualperformanceevaltransaction(parameter = "44201",
                                               bdate = date(year=2017,
                                                            month=1,
                                                            day=1),
                                               edate = date(year=2017,
                                                            month=12,
                                                            day=31),
                                               stateFIPS = "01",
                                               countycode = "003",
                                               sitenum = "0010")

pyaqsapi.bysite.qa_blanks(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of blank quality assurance data. Blanks are unexposed sample collection devices (e.g., filters) that are transported with the exposed sample devices to assess if contamination is occurring during the transport or handling of the samples. Data is aggregated at the site level.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance blank

sample data for single monitoring site for the sitenum, countycode and

stateFIPS requested for the time frame between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of qa_blank data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a table of PM2.5 blank data for the Muscle Shoals site (#0014) in Colbert County, AL for January 2018:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_blanks(parameter="44201",
                     bdate=date(year=2018,
                                month=1,
                                day=1),
                     edate=date(year=2018,
                                month=1,
                                day=31),
                     stateFIPS="01",
                     countycode="033",
                     sitenum="1002")

pyaqsapi.bysite.qa_collocated_assessments(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of collocated assessment data aggregated by matching input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance collocated

assessment data for monitors within a site.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of collocated assessments data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of collocated assessment data for FRM PM2.5 at the Huntsville Old Airport site (#0014) in Madison County, AL for January 2013:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_collocated_assessments(parameter="88101",
                                     bdate=date(year=2013,
                                                month=1,
                                                day=1,
                                                ),
                                     edate=date(year=2013,
                                                month=1,
                                                day=31,
                                                ),
                                     stateFIPS="01",
                                     countycode="089",
                                     sitenum="0014")

pyaqsapi.bysite.qa_flowrateaudit(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return Quality assurance flowrate audit data.

Return a table containing flow rate audit data aggregated by parameter code, stateFIPS, countycode and site number for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): flow rate audit data

for the requested sitenum, countycode and stateFIPS for the time

period between bdate - edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of flow rate audit data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Returns a table of all SO2 monitors at the Hawaii NP site (#0007) in Hawaii County, HI that were operating on May 1, 2018:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_flowrateaudit(parameter="88101",
                            bdate=date(year=2018,
                                       month=1,
                                       day=1),
                            edate=date(year=2018,
                                       month=1,
                                       day=31),
                            stateFIPS="37",
                            countycode="183",
                            sitenum="0014")

pyaqsapi.bysite.qa_flowrateverification(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of containing flow rate verification data aggregated by matching input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance flow rate

verification data for monitors at a site.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of flow rate verifications data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of flow rate verification data for the Muscle Shoals site (#1002) in Colbert County, AL for January 2018:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_flowrateverification(parameter="88101",
                                   bdate=date(year=2018,
                                              month=1,
                                              day=1),
                                   edate=date(year=2018,
                                              month=1,
                                              day=31),
                                   stateFIPS="25",
                                   countycode="001",
                                   sitenum="0002")

pyaqsapi.bysite.qa_one_point_qc(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of one point QC raw data aggregated by parameter code, stateFIPS, countycode and site number.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): for the requested sitenum,

countycode and stateFIPS for the time period between bdate - edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of flow rate audit data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Returns a One Point QC data for ozone at the Truro National Seashore site (#0002) in Barnstable County, MA in January 2018:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_one_point_qc(parameter="44201",
                           bdate=date(year=2018,
                                      month=1,
                                      day=1),
                           edate=date(year=2018,
                                      month=1,
                                      day=31),
                           stateFIPS="25",
                           countycode="001",
                           sitenum="0002")

pyaqsapi.bysite.qa_pep_audit(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of Performance Evaluation Program (PEP) audit data aggregated by parameter code, stateFIPS, countycode and site number for the time frame between bdate and edate.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

PEP audit data within a stateFIPS, countycode and sitenum

for the time frame between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of pep audit data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of pep Audit data for FRM PM2.5 at the Huntsville Old Airport site (#0014) in Madison County, AL for 2017 - 2019:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_pep_audit(parameter="88101",
                        bdate=date(year=2017,
                                   month=1,
                                   day=1),
                        edate=date(year=2019,
                                   month=12,
                                   day=31),
                        stateFIPS="01",
                        countycode="089",
                        sitenum="0014")

pyaqsapi.bysite.quarterlysummary(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a DataFrame of quarterly data aggregated at the site level.

Quarterly summary contains a DataFrame matching the input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame. Variables returned include mean value, maxima, percentiles, and etc.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quarterly summary statistics for

the given parameter for a single countycode and stateFIPS combination.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of quarterly summary to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Also Note that for quarterly data, only the year portion of the bdate and edate are used and all 4 quarters in the year are returned.

Examples

Return DataFrame containing quarterly summaries for FRM/FEM PM2.5 data for Millbrook School in Wake County, NC for each quarter of 2016.:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.aqs_quarterlysummary(parameter="88101",
                                bdate=date(year=2016,
                                           month=1,
                                           day=1),
                                edate=date(year=2016,
                                           month=1,
                                           day=31),
                                stateFIPS="37",
                                countycode="183",
                                sitenum="0014")

pyaqsapi.bysite.sampledata(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, duration: str | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return sample data where the data is aggregated at the site level.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

durationan optional python character string that represents the

parameter duration code that limits returned data to a specific sample duration. The default value of None results in no filtering based on duration code.Valid durations include actual sample durations and not calculated durations such as 8 hour carbon monoxide or ozone rolling averages, 3/6 day PM averages or lead 3 month rolling averages. Use aqs_sampledurations() for a list of all available duration codes.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): sample data aggregated at the

site level matching the input stateFIPS, countycode and sitenum

for the time frame between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• duration (str | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of sampledata to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of ozone monitoring data for the Millbrook School site (/#0014) in Wake County, NC for June 18, 2017:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.sampledata(parameter="44201",
                      bdate=date(year=2017,
                                 month=6,
                                 day=18),
                      edate=date(year=2017,
                                 month=6,
                                 day=18),
                      stateFIPS="37",
                      countycode="183",
                      sitenum="0014")

pyaqsapi.bysite.transactionsample(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of Returns transactionsample data aggregated by site in the AQS Submission Transaction Format (RD) sample (raw) data aggregated by matching input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): transaction sample

(raw) data in the AQS submission transaction format (RD)

corresponding to the inputs provided.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of transaction data data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return all ozone transaction data for the Millbrook School site (#0014) in Wake County, NC for June 18, 2017:

from datetime import date
import pyaqsapi as aqs
...
aqs.bysite.transactionsample(parameter="44201",
                             bdate=date(year=2017,
                                        month=6,
                                        day=18),
                             edate=date(year=2017,
                                        month=6,
                                        day=18,),
                             stateFIPS="37",
                             countycode="183",
                             sitenum="0014")

Submodules

pyaqsapi.bysite.bysite module

pyaqsapi Functions that aggregate data by site.

pyaqsapi.bysite.bysite.annualsummary(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a DataFrame of annual data aggregated at the site level.

Annual summary contains a DataFrame matching the input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame. Variables returned include mean value, maxima, percentiles, and etc.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): annual summary data for the

sitenum, countycode and stateFIPS requested for the time frame between

bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of annualsummary data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a table of annual summary ozone data for the Millbrook School site (#0014) in Wake County, NC for 2017 (Note, for annual data, only the year portion of the bdate and edate are used and only whole years of data are returned. For example, bdate = 2017-12-31 and edate = 2018-01-01 will return full data for 2017 and 2018 ):

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.annualsummary(parameter="44201",
                          bdate=date(year=2017,
                                     month=6,
                                     day=18),
                          edate=date(year=2017,
                                     month=6,
                                     day=18),
                          stateFIPS="37",
                          countycode="183",
                          sitenum="0014")

pyaqsapi.bysite.bysite.dailysummary(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → DataFrame | AQSAPI_V2

Return a DataFrame of data aggregated at the site level.

Daily summary contains a DataFrame matching the input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame. Variables returned include mean value, maxima, percentiles, and etc.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): daily summary data for the

sitenum, countycode and stateFIPS requested for the time frame between

bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

DataFrame | AQSAPI_V2

Notes

The AQS API only allows for a single year of dailysummary data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of daily summary ozone data for the Millbrook School site (#0014) in Wake County, NC for June 18, 2017:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.dailysummary(parameter="44201",
                        bdate=date(year=2017,
                                   month=6,
                                   day=18),
                        edate=date(year=2017,
                                   month=6,
                                   day=18),
                        stateFIPS="37",
                        countycode="183",
                        sitenum="0014")

pyaqsapi.bysite.bysite.monitors(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of monitors.

Return a table of monitors and related metadata at sites

with the provided parameter, stateFIPS, county_code, and sitenum for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): monitors from

the selected site.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

All monitors that operated between the bdate and edate will be returned

Examples

Return a table of all SO2 monitors at the Hawaii NP site (#0007) in Hawaii County, HI that were operating between May 1 2015-2019:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.monitors(parameter="42401",
                    bdate=date(year=2015,
                               month=5,
                               day=1,),
                    edate=date(year=2019,
                               month=5,
                               day=2),
                    stateFIPS="15",
                    countycode="001",
                    sitenum="0007")

pyaqsapi.bysite.bysite.qa_annualpeferomanceeval(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return quality assurance performance evaluation data - aggregated by site for a parameter code aggregated by matching input parameter, sitenum, countycode and stateFIPS provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

performance evaluation data. for single monitoring site for the

sitenum, countycode and stateFIPS requested for the time frame

between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of quality assurance Annual Performance Evaluation data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return an DataFrame containing annual performance evaluation data for ozone at the Fairhope site in Baldwin County, AL for 2017:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.annualpeferomanceeval(parameter="44201",
                                 bdate=date(year=2017,
                                            month=1,
                                            day=1),
                                 edate=date(year=2017,
                                            month=12,
                                            day=31),
                                 stateFIPS="01",
                                 countycode="003",
                                 sitenum="0010")

pyaqsapi.bysite.bysite.qa_annualperformanceevaltransaction(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return AQS submissions transaction format (RD) of the annual performance evaluation data (raw). Includes data pairs for QA - aggregated by site for a parameter code aggregated by matching input parameter, sitenum, countycode and stateFIPS provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

performance evaluation data. for single monitoring site for the

sitenum, countycode and stateFIPS requested for the time frame

between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of quality assurance Annual Performance Evaluation transaction data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame containing annual performance evaluation data (raw) for ozone at the Fairhope site in Baldwin County, AL for 2017 in RD format:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_annualperformanceevaltransaction(parameter = "44201",
                                               bdate = date(year=2017,
                                                            month=1,
                                                            day=1),
                                               edate = date(year=2017,
                                                            month=12,
                                                            day=31),
                                               stateFIPS = "01",
                                               countycode = "003",
                                               sitenum = "0010")

pyaqsapi.bysite.bysite.qa_blanks(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of blank quality assurance data. Blanks are unexposed sample collection devices (e.g., filters) that are transported with the exposed sample devices to assess if contamination is occurring during the transport or handling of the samples. Data is aggregated at the site level.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance blank

sample data for single monitoring site for the sitenum, countycode and

stateFIPS requested for the time frame between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of qa_blank data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a table of PM2.5 blank data for the Muscle Shoals site (#0014) in Colbert County, AL for January 2018:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_blanks(parameter="44201",
                     bdate=date(year=2018,
                                month=1,
                                day=1),
                     edate=date(year=2018,
                                month=1,
                                day=31),
                     stateFIPS="01",
                     countycode="033",
                     sitenum="1002")

pyaqsapi.bysite.bysite.qa_collocated_assessments(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of collocated assessment data aggregated by matching input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance collocated

assessment data for monitors within a site.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of collocated assessments data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of collocated assessment data for FRM PM2.5 at the Huntsville Old Airport site (#0014) in Madison County, AL for January 2013:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_collocated_assessments(parameter="88101",
                                     bdate=date(year=2013,
                                                month=1,
                                                day=1,
                                                ),
                                     edate=date(year=2013,
                                                month=1,
                                                day=31,
                                                ),
                                     stateFIPS="01",
                                     countycode="089",
                                     sitenum="0014")

pyaqsapi.bysite.bysite.qa_flowrateaudit(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return Quality assurance flowrate audit data.

Return a table containing flow rate audit data aggregated by parameter code, stateFIPS, countycode and site number for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): flow rate audit data

for the requested sitenum, countycode and stateFIPS for the time

period between bdate - edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of flow rate audit data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Returns a table of all SO2 monitors at the Hawaii NP site (#0007) in Hawaii County, HI that were operating on May 1, 2018:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_flowrateaudit(parameter="88101",
                            bdate=date(year=2018,
                                       month=1,
                                       day=1),
                            edate=date(year=2018,
                                       month=1,
                                       day=31),
                            stateFIPS="37",
                            countycode="183",
                            sitenum="0014")

pyaqsapi.bysite.bysite.qa_flowrateverification(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of containing flow rate verification data aggregated by matching input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance flow rate

verification data for monitors at a site.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of flow rate verifications data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of flow rate verification data for the Muscle Shoals site (#1002) in Colbert County, AL for January 2018:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_flowrateverification(parameter="88101",
                                   bdate=date(year=2018,
                                              month=1,
                                              day=1),
                                   edate=date(year=2018,
                                              month=1,
                                              day=31),
                                   stateFIPS="25",
                                   countycode="001",
                                   sitenum="0002")

pyaqsapi.bysite.bysite.qa_one_point_qc(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of one point QC raw data aggregated by parameter code, stateFIPS, countycode and site number.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): for the requested sitenum,

countycode and stateFIPS for the time period between bdate - edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of flow rate audit data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Returns a One Point QC data for ozone at the Truro National Seashore site (#0002) in Barnstable County, MA in January 2018:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_one_point_qc(parameter="44201",
                           bdate=date(year=2018,
                                      month=1,
                                      day=1),
                           edate=date(year=2018,
                                      month=1,
                                      day=31),
                           stateFIPS="25",
                           countycode="001",
                           sitenum="0002")

pyaqsapi.bysite.bysite.qa_pep_audit(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of Performance Evaluation Program (PEP) audit data aggregated by parameter code, stateFIPS, countycode and site number for the time frame between bdate and edate.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quality assurance

PEP audit data within a stateFIPS, countycode and sitenum

for the time frame between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of pep audit data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of pep Audit data for FRM PM2.5 at the Huntsville Old Airport site (#0014) in Madison County, AL for 2017 - 2019:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.qa_pep_audit(parameter="88101",
                        bdate=date(year=2017,
                                   month=1,
                                   day=1),
                        edate=date(year=2019,
                                   month=12,
                                   day=31),
                        stateFIPS="01",
                        countycode="089",
                        sitenum="0014")

pyaqsapi.bysite.bysite.quarterlysummary(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a DataFrame of quarterly data aggregated at the site level.

Quarterly summary contains a DataFrame matching the input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame. Variables returned include mean value, maxima, percentiles, and etc.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): quarterly summary statistics for

the given parameter for a single countycode and stateFIPS combination.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of quarterly summary to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Also Note that for quarterly data, only the year portion of the bdate and edate are used and all 4 quarters in the year are returned.

Examples

Return DataFrame containing quarterly summaries for FRM/FEM PM2.5 data for Millbrook School in Wake County, NC for each quarter of 2016.:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.aqs_quarterlysummary(parameter="88101",
                                bdate=date(year=2016,
                                           month=1,
                                           day=1),
                                edate=date(year=2016,
                                           month=1,
                                           day=31),
                                stateFIPS="37",
                                countycode="183",
                                sitenum="0014")

pyaqsapi.bysite.bysite.sampledata(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, duration: str | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return sample data where the data is aggregated at the site level.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

durationan optional python character string that represents the

parameter duration code that limits returned data to a specific sample duration. The default value of None results in no filtering based on duration code.Valid durations include actual sample durations and not calculated durations such as 8 hour carbon monoxide or ozone rolling averages, 3/6 day PM averages or lead 3 month rolling averages. Use aqs_sampledurations() for a list of all available duration codes.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): sample data aggregated at the

site level matching the input stateFIPS, countycode and sitenum

for the time frame between bdate and edate.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• duration (str | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of sampledata to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return a DataFrame of ozone monitoring data for the Millbrook School site (/#0014) in Wake County, NC for June 18, 2017:

import pyaqsapi as aqs
from datetime import date
...
aqs.bysite.sampledata(parameter="44201",
                      bdate=date(year=2017,
                                 month=6,
                                 day=18),
                      edate=date(year=2017,
                                 month=6,
                                 day=18),
                      stateFIPS="37",
                      countycode="183",
                      sitenum="0014")

pyaqsapi.bysite.bysite.transactionsample(parameter: str, bdate: date, edate: date, stateFIPS: str, countycode: str, sitenum: str, cbdate: date | None = None, cedate: date | None = None, return_header: bool | None = False) → AQSAPI_V2 | DataFrame

Return a table of Returns transactionsample data aggregated by site in the AQS Submission Transaction Format (RD) sample (raw) data aggregated by matching input parameter, stateFIPS, county_code, and sitenum provided for bdate - edate time frame.

Parameters:

parametera character list or a single character string

which represents the parameter code of the air pollutant related to the data being requested.

bdatea python date object which represents that begin date of the data

selection. Only data on or after this date will be returned.

edatea python date object which represents that end date of the data

selection. Only data on or before this date will be returned.

stateFIPSa python character object which represents the 2 digit

state FIPS code (with leading zero) for the state being requested. Use aqs_states() for the list of available FIPS codes.

countycodea python character object which represents the 3 digit

state FIPS code for the county being requested (with leading zero(s)). Use aqs_counties_by_state() for the list of available county codes for each state.

sitenuma python character object which represents the 4 digit site

number (with leading zeros) within the county and state being requested.

cbdatea python date object which represents a “beginning date of

last change” that indicates when the data was last updated. cbdate is used to filter data based on the change date. Only data that changed on or after this date will be returned. This is an optional variable which defaults to None.

cedatea python date object which represents an “end date of last

change” that indicates when the data was last updated. cedate is used to filter data based on the change date. Only data that changed on or before this date will be returned. This is an optional variable which defaults to None.

return_headerIf FALSE (default) only returns data requested. If TRUE

returns a AQSAPI_v2 object.

Returns:

(pandas DataFrame or an AQSAPI_V2 object): transaction sample

(raw) data in the AQS submission transaction format (RD)

corresponding to the inputs provided.

Parameters:

• parameter (str)

• bdate (date)

• edate (date)

• stateFIPS (str)

• countycode (str)

• sitenum (str)

• cbdate (date | None)

• cedate (date | None)

• return_header (bool | None)

Return type:

AQSAPI_V2 | DataFrame

Notes

The AQS API only allows for a single year of transaction data data to be retrieved at a time. This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years of data will require multiple API calls. As the number of years of data being requested increases so does the length of time that it will take to retrieve results. There is also a 5 second wait time inserted between successive API calls to prevent overloading the API server. This operation has a linear run time of /(Big O notation: O/(n + 5 seconds/)/).

Examples

Return all ozone transaction data for the Millbrook School site (#0014) in Wake County, NC for June 18, 2017:

from datetime import date
import pyaqsapi as aqs
...
aqs.bysite.transactionsample(parameter="44201",
                             bdate=date(year=2017,
                                        month=6,
                                        day=18),
                             edate=date(year=2017,
                                        month=6,
                                        day=18,),
                             stateFIPS="37",
                             countycode="183",
                             sitenum="0014")