sensortoolkit.reference._ref_api_query.query_aqs
- query_aqs(param, data_period, aqs_id, username=None, key=None, query_type='sampleData', **kwargs)[source]
Construct an AQS API query request and parse response.
- Parameters
param (str or list of str values) – The evaluation parameter(s) for which to query data.
data_period (list) – List with two elements, the first is the start date and time for the query and the second is the end date and time for the query. The API is sequentially queried in monthly intervals, so the start date will usually be something like ‘20210101’ and the end date will follow as ‘20210131’.
aqs_id (str) – The AQS site ID for the air monitoring site from which reference measurements will be returned by the API.
username (str) – AQS API username assigned to the user during API registration.
key (str) – User key for API authentication.
query_type (str) –
The type of data query to request from AQS.
- Metadata and listings:
metadata
list
monitors
- Monitor Data:
sampleData
dailyData
quarterlyData
annualData
- Quality Assurance Assessments and Audits:
qaAnnualPerformanceEvaluations
qaBlanks
qaCollocatedAssessments
qaFlowRateVerifications
qaFlowRateAudits
qaOnePointQcRawData
qaPepAudits
Keyword Arguments:
- Parameters
get_monitor_info (bool) – If True, a secondary AQS query will be submitted for adding reference monitor and site metadata to the dataset returned by this method.
sample_duration (str) – The duration of recorded reference data the user wishes to retreive.
- Returns
Data returned by the API for the specified query parameter and time period.
- Return type
data (pandas DataFrame)