2.1 Sample Data Retrieval by State

Action	sampleDataByState
Purpose	Retrieves sample-level air-quality measurements filtered by U.S. state. Used for collecting granular pollutant readings across all sites within a given state.
Configuration	Ensure environment variables AQS_ENV_BASE_URL and AQS_ENV_PORT are configured.
Parameters	Required: state: 2-character state FIPS code (string, e.g., 06 for California). bdate: Begin date (YYYYMMDD, e.g., 20240101). edate: End date (YYYYMMDD, e.g., 20240131). param: Pollutant parameter code (string, e.g., 88101 for PM2.5). Optional: format: Output format indicator (integer, e.g., 1). site, county, cbsa: Additional filters (string). callback: Callback function name for JSONP support (string).
Output	Successful: JSON object containing sample records for each monitoring site in the requested state. Failure: Returns error details from upstream EPA API.
Workflow Example	Execute the action: GET /sampleData/byState?state=06&bdate=20240101&edate=20240131¶m=88101 Review the response to obtain daily PM2.5 sample records for California. Use the data for visualization or compliance analysis.

2.2 Decode Vin Values Retrieval

Action	decodeVinValues
Purpose	Decodes a VIN in flat format for concise vehicle information retrieval.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_NHTSAVPIC_BASE_URL environment variable.
Parameters	Required: vin: The VIN to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]). modelyear: Model year (integer).
Output	Successful: Returns a JSON, XML, or CSV object with: Count: Number of results (integer). Message: Response message (string). SearchCriteria: Query details (string). Results: Array of flat key-value pairs for vehicle attributes. Failure: Returns error details (e.g., invalid VIN).
Workflow Example	Execute the decodeVinValues action with vin=5UXWX7C5*BA. Review the flat format response. Use the data for quick lookups.

2.3 Decode Vin Extended Retrieval

Action	decodeVinExtended
Purpose	Decodes a VIN with extended vehicle information for detailed analysis.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_NHTSAVPIC_BASE_URL environment variable.
Parameters	Required: vin: The VIN to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]). modelyear: Model year (integer).
Output	Successful: Returns a JSON, XML, or CSV object with: Count: Number of results (integer). Message: Response message (string). SearchCriteria: Query details (string). Results: Array of extended vehicle attribute objects. Failure: Returns error details (e.g., invalid VIN).
Workflow Example	Execute the decodeVinExtended action with vin=5UXWX7C5*BA. Process the extended details. Integrate into detailed reporting tools.

2.4 Decode Vin Values Extended Retrieval

Action	decodeVinValuesExtended
Purpose	Decodes a VIN in flat format with extended information for comprehensive yet concise data.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: vin: The VIN to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]). modelyear: Model year (integer).
Output	Successful: Count: Number of results (integer). Message: Response message (string). SearchCriteria: Query details (string). Results: Array of flat key-value pairs with extended attributes. Failure: Returns error details (e.g., invalid VIN).
Workflow Example	Execute decodeVinValuesExtended action with vin=5UXWX7C5*BA. Save the extended flat data. Use for data processing applications.

2.5 Decode Wmi Retrieval

Action	decodeWmi
Purpose	Decodes a World Manufacturer Identifier (WMI) to get manufacturer and country details.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: wmi: The WMI to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of WMI details (WMI, Manufacturer, Country). Failure: Returns error details (e.g., invalid WMI).
Workflow Example	Execute decodeWmi action with wmi=1G1. Review the manufacturer information. Use for supply chain analysis.

2.6 Get Wmis For Manufacturer Retrieval

Action	getWmisForManufacturer
Purpose	Retrieves WMIs associated with a manufacturer, optionally filtered by vehicle type.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: manufacturer: Manufacturer name or ID (string). Optional: vehicleType: Vehicle type (string). format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of WMI objects (WMI, Manufacturer, VehicleType). Failure: Returns error details (e.g., invalid manufacturer).
Workflow Example	Execute getWmisForManufacturer action with manufacturer=honda. List the WMIs. Use for manufacturer verification.

2.7 Get All Makes Retrieval

Action	getAllMakes
Purpose	Retrieves a list of all vehicle makes.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: None Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of make objects (Make_ID, Make_Name). Failure: Returns error details.
Workflow Example	Execute getAllMakes action with optional format=json. Populate a make selection dropdown. Use for vehicle search interfaces.

2.8 Get Parts Retrieval

Action	getParts
Purpose	Retrieves parts information filtered by type, date range, and manufacturer.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: None Optional: type: Part type (string). fromDate: Start date (string, format: date). toDate: End date (string, format: date). format: Response format (string, enum: [xml, json, csv]). page: Page number (integer). manufacturer: Manufacturer (string).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of part objects (PartId, PartName, Manufacturer, Date). Failure: Returns error details.
Workflow Example	Execute getParts action with type=565 and fromDate=1/1/2015. Analyze parts data. Use for safety recalls.

2.9 Get All Manufacturers Retrieval

Action	getAllManufacturers
Purpose	Retrieves a list of all manufacturers, optionally filtered by type and paginated.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: None Optional: ManufacturerType: Manufacturer type (string). format: Response format (string, enum: [xml, json, csv]). page: Page number (integer).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of manufacturer objects (ManufacturerId, ManufacturerName, ManufacturerType). Failure: Returns error details.
Workflow Example	Execute getAllManufacturers action with ManufacturerType=Intermediate. List manufacturers. Use for industry overviews.

2.10 Get Manufacturer Details Retrieval

Action	getManufacturerDetails
Purpose	Retrieves detailed information for a specific manufacturer.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: manufacturer: Manufacturer name or ID (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of manufacturer details (ManufacturerId, ManufacturerName, Country, Address). Failure: Returns error details (e.g., invalid manufacturer).
Workflow Example	Execute getManufacturerDetails action with manufacturer=honda. Review details. Use for compliance checks.

2.11 Get Vehicle Types For Make Retrieval

Action	getVehicleTypesForMake
Purpose	Retrieves vehicle types for a specific make.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: make: Make name (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of vehicle type objects (VehicleTypeId, VehicleTypeName). Failure: Returns error details (e.g., invalid make).
Workflow Example	Execute getVehicleTypesForMake action with make=honda. List types. Use for categorization.

2.12 Get Vehicle Types For Make Id Retrieval

Action	getVehicleTypesForMakeId
Purpose	Retrieves vehicle types for a specific make ID.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: makeId: Make ID (integer). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of vehicle type objects (VehicleTypeId, VehicleTypeName). Failure: Returns error details (e.g., invalid make ID).
Workflow Example	Execute getVehicleTypesForMakeId action with makeId=474. Process types. Integrate into search filters.

2.13 Get Equipment Plant Codes Retrieval

Action	getEquipmentPlantCodes
Purpose	Retrieves equipment plant codes for a given year, type, and report type.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: year: Year (integer). equipmentType: Equipment type (integer). reportType: Report type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of plant code objects (PlantCode, PlantName, Year). Failure: Returns error details.
Workflow Example	Execute getEquipmentPlantCodes action with year=2015, equipmentType=1, reportType=all. Analyze codes. Use for manufacturing tracking.

2.14 Get Makes For Manufacturer Retrieval

Action	getMakesForManufacturer
Purpose	Retrieves makes associated with a manufacturer.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: manufacturer: Manufacturer name or ID (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of make objects (Make_ID, Make_Name). Failure: Returns error details (e.g., invalid manufacturer).
Workflow Example	Execute getMakesForManufacturer action with manufacturer=honda. List makes. Use for brand analysis.

2.15 Get Makes For Manufacturer And Year Retrieval

Action	getMakesForManufacturerAndYear
Purpose	Retrieves makes for a manufacturer and specific year.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: manufacturer: Manufacturer name or ID (string). Optional: year: Year (integer). vehicleType: Vehicle type (string). format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of make objects (Make_ID, Make_Name). Failure: Returns error details.
Workflow Example	Execute getMakesForManufacturerAndYear action with manufacturer=honda and year=2015. Review yearly makes. Use for historical data.

2.16 Get Makes For Vehicle Type Retrieval

Action	getMakesForVehicleType
Purpose	Retrieves makes for a specific vehicle type.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: vehicleType: Vehicle type name (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of make objects (Make_ID, Make_Name). Failure: Returns error details (e.g., invalid vehicle type).
Workflow Example	Execute getMakesForVehicleType action with vehicleType=car. List makes. Use for type-specific searches.

2.17 Get Models For Make Retrieval

Action	getModelsForMake
Purpose	Retrieves models for a specific make.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: make: Make name (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name, Make_ID). Failure: Returns error details (e.g., invalid make).
Workflow Example	Execute getModelsForMake action with make=honda. List models. Use for model selection.

2.18 Get Models For Make Id Retrieval

Action	getModelsForMakeId
Purpose	Retrieves models for a specific make ID.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: makeId: Make ID (integer). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name, Make_ID). Failure: Returns error details (e.g., invalid make ID).
Workflow Example	Execute getModelsForMakeId action with makeId=474. Process models. Integrate into databases.

2.19 Get Models For Make Year Make Model Year Retrieval

Action	getModelsForMakeYearMakeModelYear
Purpose	Retrieves models for a make and model year.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: make: Make name (string). year: Model year (integer). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute getModelsForMakeYearMakeModelYear action with make=honda and year=2015. List models. Use for year-specific queries.

2.20 Get Models For Make Year Make Vehicle Type Retrieval

Action	getModelsForMakeYearMakeVehicleType
Purpose	Retrieves models for a make and vehicle type.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: make: Make name (string). vehicleType: Vehicle type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute getModelsForMakeYearMakeVehicleType with make=honda and vehicleType=car. Review models. Use for type filtering.

2.21 Get Models For Make Year Model Year Vehicle Type Retrieval

Action	getModelsForMakeYearModelYearVehicleType
Purpose	Retrieves models for a model year and vehicle type.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: year: Model year (integer). vehicleType: Vehicle type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute getModelsForMakeYearModelYearVehicleType with year=2015 and vehicleType=car. List models. Use for broad searches.

2.22 Get Models For Make Id Year Make Id Model Year Retrieval

Action	getModelsForMakeIdYearMakeIdModelYear
Purpose	Retrieves models for a make ID and model year.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: makeId: Make ID (integer). year: Model year (integer). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute getModelsForMakeIdYearMakeIdModelYear with makeId=474 and year=2015. Process models. Use for ID-based queries.

2.23 Get Models For Make Id Year Make Id Vehicle Type Retrieval

Action	getModelsForMakeIdYearMakeIdVehicleType
Purpose	Retrieves models for a make ID and vehicle type.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: makeId: Make ID (integer). vehicleType: Vehicle type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute getModelsForMakeIdYearMakeIdVehicleType with makeId=474 and vehicleType=car. List models. Use for type-specific ID queries.

2.24 Get Models For Make Id Year Model Year Vehicle Type Retrieval

Action	getModelsForMakeIdYearModelYearVehicleType
Purpose	Retrieves models for a model year and vehicle type.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: year: Model year (integer). vehicleType: Vehicle type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute getModelsForMakeIdYearModelYearVehicleType with year=2015 and vehicleType=car. Review models. Use for year-type combinations.

2.25 Get Vehicle Variable List Retrieval

Action	getVehicleVariableList
Purpose	Retrieves a list of vehicle variables.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: None Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer) Message: Response message (string) Results: Array of variable objects (VariableId, VariableName) Failure: Returns error details.
Workflow Example	Execute the getVehicleVariableList action. List variables. Use for data mapping.

2.26 Get Vehicle Variable Values List Retrieval

Action	getVehicleVariableValuesList
Purpose	Retrieves values for a specific vehicle variable.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: variable: Variable name or ID (string) Optional: format: Response format (string, enum: [xml, json, csv])
Output	Successful: Count: Number of results (integer) Message: Response message (string) Results: Array of value objects (VariableId, Value) Failure: Returns error details (e.g., invalid variable)
Workflow Example	Execute the getVehicleVariableValuesList action with variable=BodyClass. List values. Use for variable exploration.

2.27 Decode Vin Values Batch Retrieval

Action	decodeVinValuesBatch
Purpose	Decodes multiple VINs in batch for efficient processing.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: None (POST body with VINs) Optional: format: Response format (string, enum: [xml, json, csv])
Output	Successful: Count: Number of results (integer) Message: Response message (string) Results: Array of flat key-value pairs for each VIN Failure: Returns error details
Workflow Example	Execute the decodeVinValuesBatch action with batch VIN data. Process multiple decodes. Use for bulk operations.

2.28 Get Canadian Vehicle Specifications Retrieval

Action	getCanadianVehicleSpecifications
Purpose	Retrieves Canadian vehicle specifications filtered by year, make, model, and units.
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_NHTSAVPIC_BASE_URL.
Parameters	Required: None Optional: year: Year (integer) make: Make (string) model: Model (string) units: Units (string) format: Response format (string, enum: [xml, json, csv])
Output	Successful: Count: Number of results (integer) Message: Response message (string) Results: Array of specification objects (Make, Model, ModelYear, Specifications) Failure: Returns error details
Workflow Example	Execute the getCanadianVehicleSpecifications action with year=2015 and make=honda. Review specs. Use for Canadian market analysis.

2.2 Sample Data Retrieval by County

Action	sampleDataByCounty
Purpose	Retrieves air-quality sample data for a specific county within a state.
Parameters	Required: state: 2-character state FIPS code (string, e.g., 06). county: County code (string, e.g., 001). param: Pollutant parameter code (string, e.g., 44201). bdate, edate: Begin and end date (YYYYMMDD). Optional: format: Output format indicator (integer, e.g., 1). callback: Callback function name for JSONP support (string).
Output	Successful: JSON object with sample entries for the county. Failure: Error object from AQS API.
Workflow Example	Execute the action with parameters: GET /sampleData/byCounty?state=06&county=001¶m=44201&bdate=20240101&edate=20240131 Process the response to analyze ozone readings for county 001 in California.

2.3 Sample Data Retrieval by Site

Action	sampleDataBySite
Purpose	Fetches sample-level measurements for a specific monitoring site.
Parameters	Required: state, county, site, param, bdate, edate Optional: format, callback
Output	Successful: JSON array of samples for the specified site. Failure: Error object with status and details.
Workflow Example	GET /sampleData/bySite?state=06&county=001&site=0001¶m=88101&bdate=20240101&edate=20240131

2.4 Sample Data Retrieval by CBSA

Action	sampleDataByCBSA
Purpose	Retrieves sample data aggregated by Core-Based Statistical Area (CBSA).
Parameters	Required: cbsa: CBSA code (string, e.g., 41860). Optional: param, bdate, edate, format
Output	JSON object containing aggregated sample data for the CBSA.
Workflow Example	GET /sampleData/byCBSA?cbsa=41860¶m=88101&bdate=20240101&edate=20240131

2.5 Sample Data Retrieval by Box

Action	sampleDataByBox
Purpose	Retrieves sample data for sites within a geographic bounding box (latitude/longitude).
Parameters	Required: minlat, maxlat: Minimum and maximum latitude (float). minlon, maxlon: Minimum and maximum longitude (float). param, bdate, edate Optional: format, callback
Workflow Example	GET /sampleData/byBox?minlat=33.7&maxlat=34.5&minlon=-118.5&maxlon=-117.8¶m=88101&bdate=20240101&edate=20240131

2.6 Daily Data Retrieval by State

Action	dailyDataByState
Purpose	Retrieves daily average air-quality data for all sites within a state.
Parameters	Required: state, param, bdate, edate Optional: format, callback
Workflow Example	GET /dailyData/byState?state=06¶m=44201&bdate=20240101&edate=20240131

2.7 Daily Data Retrieval by County

Action	dailyDataByCounty
Purpose	Retrieves daily aggregated data for a specific county.
Parameters	Required: state, county, param, bdate, edate Optional: format
Workflow Example	GET /dailyData/byCounty?state=06&county=001¶m=88101&bdate=20240101&edate=20240131

2.8 Daily Data Retrieval by Site

Action	dailyDataBySite
Purpose	Retrieves daily mean pollutant values for a specific monitoring site.
Parameters	Required: state, county, site, param, bdate, edate Optional: format
Workflow Example	GET /dailyData/bySite?state=06&county=001&site=0001¶m=44201&bdate=20240101&edate=20240131

2.9 Daily Data Retrieval by CBSA

Action	dailyDataByCBSA
Purpose	Fetches daily aggregated data for a CBSA region.
Parameters	Required: cbsa, param, bdate, edate Optional: format
Workflow Example	GET /dailyData/byCBSA?cbsa=41860¶m=88101&bdate=20240101&edate=20240131

2.10 Daily Data Retrieval by Box

Action	dailyDataByBox
Purpose	Retrieves daily averages for all sites inside a geographic box.
Parameters	Required: minlat, maxlat, minlon, maxlon, param, bdate, edate Optional: format
Workflow Example	GET /dailyData/byBox?minlat=33.7&maxlat=34.5&minlon=-118.5&maxlon=-117.8¶m=44201&bdate=20240101&edate=20240131

2.11 Annual Data Retrieval by State

Action	annualDataByState
Purpose	Retrieves annual aggregate statistics for air-quality parameters within a state.
Parameters	Required: state, param, year Optional: format
Workflow Example	GET /annualData/byState?state=06¶m=88101&year=2024

2.12 Annual Data Retrieval by County

Action	annualDataByCounty
Purpose	Retrieves annual data summaries for a specified county.
Parameters	Required: state, county, param, year Optional: format
Workflow Example	GET /annualData/byCounty?state=06&county=001¶m=44201&year=2024

2.13 Annual Data Retrieval by Site

Action	annualDataBySite
Purpose	Retrieves annual aggregated statistics for a specific monitoring site.
Parameters	Required: state, county, site, param, year Optional: format
Workflow Example	GET /annualData/bySite?state=06&county=001&site=0001¶m=88101&year=2024

2.14 Annual Data Retrieval by CBSA

Action	annualDataByCBSA
Purpose	Retrieves annual aggregates for a Core Based Statistical Area (CBSA).
Parameters	Required: cbsa, param, year Optional: format
Workflow Example	GET /annualData/byCBSA?cbsa=41860¶m=88101&year=2024

2.15 Annual Data Retrieval by Box

Action	annualDataByBox
Purpose	Retrieves annual aggregated data for monitoring sites within a defined latitude/longitude box.
Parameters	Required: minlat, maxlat, minlon, maxlon, param, year Optional: format
Workflow Example	GET /annualData/byBox?minlat=33.7&maxlat=34.5&minlon=-118.5&maxlon=-117.8¶m=44201&year=2024

2.16 QA Annual Performance Evaluations by Site

Action	qaAnnualPerformanceEvaluationsBySite
Purpose	Retrieves QA Annual Performance Evaluation results for a specific site, useful for assessing instrument accuracy and data quality.
Configuration	Ensure environment variables AQS_ENV_BASE_URL and AQS_ENV_PORT are configured.
Parameters	Required: state, county, site, param, year Optional: format, callback
Output	Successful: JSON object with evaluation metrics per site. Failure: Error details from upstream AQS API.
Workflow Example	GET /qaAnnualPerformanceEvaluations/bySite?state=06&county=001&site=0001¶m=88101&year=2024

2.17 QA Annual Performance Evaluations by County

Action	qaAnnualPerformanceEvaluationsByCounty
Purpose	Fetches QA annual performance data for all sites in a specific county.
Parameters	Required: state, county, param, year Optional: format
Workflow Example	GET /qaAnnualPerformanceEvaluations/byCounty?state=06&county=001¶m=44201&year=2024

2.18 QA Annual Performance Evaluations by State

Action	qaAnnualPerformanceEvaluationsByState
Purpose	Retrieves state-level QA annual performance evaluation records.
Parameters	Required: state, param, year Optional: format
Workflow Example	GET /qaAnnualPerformanceEvaluations/byState?state=06¶m=88101&year=2024

2.19 QA Annual Performance Evaluations by MA

Action	qaAnnualPerformanceEvaluationsByMA
Purpose	Retrieves QA performance evaluations for Monitoring Agencies (MA) within the AQS network.
Parameters	Required: ma, year Optional: param, format
Workflow Example	GET /qaAnnualPerformanceEvaluations/byMA?ma=CA001¶m=44201&year=2024

2.20 List of States

Action	listStates
Purpose	Retrieves a list of U.S. states available in the AQS dataset.
Parameters	Required: None Optional: format
Workflow Example	GET /list/states

2.21 List of Counties by State

Action	listCountiesByState
Purpose	Returns counties for a specified state FIPS code.
Parameters	Required: state (e.g., 06) Optional: format
Workflow Example	GET /list/countiesByState?state=06

2.22 List of Sites by County

Action	listSitesByCounty
Purpose	Retrieves site information for a specific county and state.
Parameters	Required: state, county Optional: format
Workflow Example	GET /list/sitesByCounty?state=06&county=001

2.23 List of CBSAs

Action	listCbsas
Purpose	Returns Core Based Statistical Areas (CBSAs) available in AQS.
Parameters	Required: None Optional: format
Workflow Example	GET /list/cbsas

2.24 List of Classes

Action	listClasses
Purpose	Retrieves parameter classifications used within AQS.
Parameters	Required: None Optional: format
Workflow Example	GET /list/classes

2.25 List of Parameters by Class

Action	listParametersByClass
Purpose	Retrieves parameters belonging to a specific class of pollutants.
Parameters	Required: class (e.g., CRITERIA) Optional: format
Workflow Example	GET /list/parametersByClass?class=CRITERIA

2.26 List of PQAOs

Action	listPqaos
Purpose	Returns Primary Quality Assurance Organizations (PQAOs) from the AQS dataset.
Parameters	Required: None Optional: format
Workflow Example	GET /list/pqaos

2.27 List of MAs

Action	listMas
Purpose	Retrieves Monitoring Agencies (MAs) registered with the AQS system.
Parameters	Required: None Optional: format
Workflow Example	GET /list/mas

2.28 QA Collocated Assessments by State

Action	qaCollocatedAssessmentsByState
Purpose	Retrieves collocated assessment records for sites within a state used to compare instrument consistency.
Parameters	Required: state param year Optional: format
Workflow Example	GET /qaCollocatedAssessments/byState?state=06¶m=88101&year=2024

2.29 QA Collocated Assessments by County

Action	qaCollocatedAssessmentsByCounty
Purpose	Fetches collocated assessments for all sites within a county.
Parameters	Required: state county param year Optional: format
Workflow Example	GET /qaCollocatedAssessments/byCounty?state=06&county=001¶m=44201&year=2024

2.30 QA Collocated Assessments by Site

Action	qaCollocatedAssessmentsBySite
Purpose	Retrieves collocated assessment data for a specific monitoring site.
Parameters	Required: state county site param year Optional: format
Workflow Example	GET /qaCollocatedAssessments/bySite?state=06&county=001&site=0001¶m=88101&year=2024

2.31 QA Collocated Assessments by PQAO

Action	qaCollocatedAssessmentsByPQAO
Purpose	Retrieves collocated assessment data for a specific PQAO.
Parameters	Required: pqao (e.g., CA01) year Optional: param format
Workflow Example	GET /qaCollocatedAssessments/byPQAO?pqao=CA01¶m=44201&year=2024

2.32 QA Collocated Assessments by MA

Action	qaCollocatedAssessmentsByMA
Purpose	Retrieves collocated assessment records for a specific Monitoring Agency.
Parameters	Required: ma (e.g., CA001) year Optional: param format
Workflow Example	GET /qaCollocatedAssessments/byMA?ma=CA001¶m=88101&year=2024

2.33 QA PEP Audits by State

Action	qaPepAuditsByState
Purpose	Retrieves Performance Evaluation Program (PEP) audit data by state.
Parameters	Required: state param year Optional: format
Workflow Example	GET /qaPepAudits/byState?state=06¶m=88101&year=2024

2.34 QA PEP Audits by County

Action	qaPepAuditsByCounty
Purpose	Retrieves PEP audit records for all sites within a county.
Parameters	Required: state county param year Optional: format
Workflow Example	GET /qaPepAudits/byCounty?state=06&county=001¶m=44201&year=2024

2.35 QA PEP Audits by Site

Action	qaPepAuditsBySite
Purpose	Retrieves PEP audit data for a specific site.
Parameters	Required: state county site param year Optional: format
Workflow Example	GET /qaPepAudits/bySite?state=06&county=001&site=0001¶m=88101&year=2024

2.36 QA PEP Audits by PQAO

Action	qaPepAuditsByPQAO
Purpose	Retrieves PEP audit records for a given Primary QA Organization.
Parameters	Required: pqao year Optional: param format
Workflow Example	GET /qaPepAudits/byPQAO?pqao=CA01¶m=44201&year=2024

2.37 QA PEP Audits by MA

Action	qaPepAuditsByMA
Purpose	Retrieves PEP audit records grouped by Monitoring Agency.
Parameters	Required: ma year Optional: param format
Workflow Example	GET /qaPepAudits/byMA?ma=CA001¶m=88101&year=2024

2.38 QA Flow Rate Audits by State

Action	qaFlowRateAuditsByState
Purpose	Retrieves QA flow rate audit data for monitors within a state.
Parameters	Required: state year Optional: param format
Workflow Example	GET /qaFlowRateAudits/byState?state=06¶m=44201&year=2024

2.39 QA Flow Rate Audits by County

Action	qaFlowRateAuditsByCounty
Purpose	Retrieves QA flow rate audit data for all sites in a county.
Parameters	Required: state county year Optional: param format
Workflow Example	GET /qaFlowRateAudits/byCounty?state=06&county=001¶m=88101&year=2024

2.40 QA Flow Rate Audits by Site

Action	qaFlowRateAuditsBySite
Purpose	Retrieves QA flow rate audit records for a specific site.
Parameters	Required: state county site year Optional: param format
Workflow Example	GET /qaFlowRateAudits/bySite?state=06&county=001&site=0001¶m=44201&year=2024

2.41 QA Flow Rate Audits by PQAO

Action	qaFlowRateAuditsByPQAO
Purpose	Retrieves QA flow rate audit data grouped by PQAO.
Parameters	Required: pqao year Optional: param format
Workflow Example	GET /qaFlowRateAudits/byPQAO?pqao=CA01¶m=88101&year=2024

2.42 QA Flow Rate Audits by MA

Action	qaFlowRateAuditsByMA
Purpose	Retrieves QA flow rate audit data for Monitoring Agencies.
Parameters	Required: ma year Optional: param format
Workflow Example	GET /qaFlowRateAudits/byMA?ma=CA001¶m=44201&year=2024

2.43 QA Flow Rate Verifications by State

Action	qaFlowRateVerificationsByState
Purpose	Retrieves QA Flow Rate Verification data for monitoring stations across a specific state, used to ensure that flow rate measurement instruments remain within calibration standards.
Configuration	Ensure environment variables AQS_ENV_BASE_URL and AQS_ENV_PORT are correctly configured.
Parameters	Required: state (string, e.g., 06) year (integer, e.g., 2024) Optional: param (string, e.g., 88101) format (integer, e.g., 1)
Workflow Example	GET /qaFlowRateVerifications/byState?state=06¶m=88101&year=2024

2.44 QA Flow Rate Verifications by County

Action	qaFlowRateVerificationsByCounty
Purpose	Retrieves QA Flow Rate Verifications for all sites within a county.
Parameters	Required: state county year Optional: param format
Workflow Example	GET /qaFlowRateVerifications/byCounty?state=06&county=001¶m=44201&year=2024

2.45 QA Flow Rate Verifications by Site

Action	qaFlowRateVerificationsBySite
Purpose	Retrieves flow rate verification results for a specific site to validate individual monitor consistency.
Parameters	Required: state county site year Optional: param format
Workflow Example	GET /qaFlowRateVerifications/bySite?state=06&county=001&site=0001¶m=88101&year=2024

2.46 QA Flow Rate Verifications by PQAO

Action	qaFlowRateVerificationsByPQAO
Purpose	Retrieves verification results for a Primary Quality Assurance Organization.
Parameters	Required: pqao year Optional: param format
Workflow Example	GET /qaFlowRateVerifications/byPQAO?pqao=CA01¶m=44201&year=2024

2.47 QA Flow Rate Verifications by MA

Action	qaFlowRateVerificationsByMA
Purpose	Retrieves QA Flow Rate Verifications grouped by Monitoring Agency.
Parameters	Required: ma year Optional: param format
Workflow Example	GET /qaFlowRateVerifications/byMA?ma=CA001¶m=88101&year=2024

2.48 QA Blanks by State

Action	qaBlanksByState
Purpose	Retrieves QA blank sample records by state, used to measure baseline readings and contamination control.
Parameters	Required: state year Optional: param format
Workflow Example	GET /qaBlanks/byState?state=06¶m=44201&year=2024

2.49 QA Blanks by County

Action	qaBlanksByCounty
Purpose	Retrieves blank sample records for all sites in a given county.
Parameters	Required: state county year Optional: param format
Workflow Example	GET /qaBlanks/byCounty?state=06&county=001¶m=88101&year=2024

2.50 QA Blanks by Site

Action	qaBlanksBySite
Purpose	Retrieves blank QA data for a single monitoring site.
Parameters	Required: state county site year Optional: param format
Workflow Example	GET /qaBlanks/bySite?state=06&county=001&site=0001¶m=44201&year=2024

2.51 QA Blanks by PQAO

Action	qaBlanksByPQAO
Purpose	Retrieves blank sample results grouped by PQAO.
Parameters	Required: pqao year Optional: param format
Workflow Example	GET /qaBlanks/byPQAO?pqao=CA01¶m=88101&year=2024

2.52 QA Blanks by MA

Action	qaBlanksByMA
Purpose	Retrieves QA blank samples for a Monitoring Agency.
Parameters	Required: ma year Optional: param format
Workflow Example	GET /qaBlanks/byMA?ma=CA001¶m=44201&year=2024

2.53 QA One Point QC Raw Data by State

Action	qaOnePointQcRawDataByState
Purpose	Retrieves one-point quality control raw data for a given state, used for verifying monitor calibration accuracy.
Parameters	Required: state year Optional: param format
Workflow Example	GET /qaOnePointQcRawData/byState?state=06¶m=88101&year=2024

2.54 QA One Point QC Raw Data by County

Action	qaOnePointQcRawDataByCounty
Purpose	Retrieves QC raw data for all sites in a county.
Parameters	Required: state county year Optional: param format
Workflow Example	GET /qaOnePointQcRawData/byCounty?state=06&county=001¶m=44201&year=2024

2.55 QA One Point QC Raw Data by Site

Action	qaOnePointQcRawDataBySite
Purpose	Retrieves single-site one-point QC data.
Parameters	Required: state county site year Optional: param format
Workflow Example	GET /qaOnePointQcRawData/bySite?state=06&county=001&site=0001¶m=88101&year=2024

2.56 QA One Point QC Raw Data by PQAO

Action	qaOnePointQcRawDataByPQAO
Purpose	Retrieves QC raw data for all sites under a PQAO.
Parameters	Required: pqao year Optional: param format
Workflow Example	GET /qaOnePointQcRawData/byPQAO?pqao=CA01¶m=44201&year=2024

2.57 QA One Point QC Raw Data by MA

Action	qaOnePointQcRawDataByMA
Purpose	Retrieves QC raw data grouped by Monitoring Agency.
Parameters	Required: ma year Optional: param format
Workflow Example	GET /qaOnePointQcRawData/byMA?ma=CA001¶m=88101&year=2024

2.58 Transactions Sample by State

Action	transactionsSampleByState
Purpose	Retrieves transactional-level sample records for all monitoring sites in a state.
Parameters	Required: state param bdate edate Optional: format
Workflow Example	GET /transactionsSample/byState?state=06¶m=44201&bdate=20240101&edate=20240131

2.59 Transactions Sample by County

Action	transactionsSampleByCounty
Purpose	Retrieves sample-level transactional data for a specific county.
Parameters	Required: state county param bdate edate Optional: format
Workflow Example	GET /transactionsSample/byCounty?state=06&county=001¶m=88101&bdate=20240101&edate=20240131

2.60 Transactions Sample by Site

Action	transactionsSampleBySite
Purpose	Retrieves site-level transactional sample records.
Parameters	Required: state county site param bdate edate Optional: format
Workflow Example	GET /transactionsSample/bySite?state=06&county=001&site=0001¶m=44201&bdate=20240101&edate=20240131

2.61 Transactions Sample by POC

Action	transactionsSampleByPOC
Purpose	Retrieves sample transactions by parameter occurrence code (POC).
Parameters	Required: state county site poc bdate edate Optional: format
Workflow Example	GET /transactionsSample/byPOC?state=06&county=001&site=0001&poc=1&bdate=20240101&edate=20240131

2.62 Transactions Sample by MA

Action	transactionsSampleByMA
Purpose	Retrieves transactional sample records grouped by Monitoring Agency.
Parameters	Required: ma param bdate edate Optional: format
Workflow Example	GET /transactionsSample/byMA?ma=CA001¶m=88101&bdate=20240101&edate=20240131

2.63 Transactions QA Annual Performance Evaluations by Site

Action	transactionsQaAnnualPerformanceEvaluationsBySite
Purpose	Retrieves transactional QA annual performance evaluations for a specific site.
Parameters	Required: state county site param year Optional: format
Workflow Example	GET /transactionsQaAnnualPerformanceEvaluations/bySite?state=06&county=001&site=0001¶m=44201&year=2024

2.64 Transactions QA Annual Performance Evaluations by County

Action	transactionsQaAnnualPerformanceEvaluationsByCounty
Purpose	Retrieves QA annual performance transaction data for a specific county.
Parameters	Required: state county param year Optional: format
Workflow Example	GET /transactionsQaAnnualPerformanceEvaluations/byCounty?state=06&county=001¶m=88101&year=2024

2.65 Transactions QA Annual Performance Evaluations by State

Action	transactionsQaAnnualPerformanceEvaluationsByState
Purpose	Retrieves QA annual performance data at the state level.
Parameters	Required: state param year Optional: format
Workflow Example	GET /transactionsQaAnnualPerformanceEvaluations/byState?state=06¶m=44201&year=2024

2.66 Transactions QA Annual Performance Evaluations by PQAO

Action	transactionsQaAnnualPerformanceEvaluationsByPQAO
Purpose	Retrieves QA annual performance evaluation data by PQAO.
Parameters	Required: pqao year Optional: param format
Workflow Example	GET /transactionsQaAnnualPerformanceEvaluations/byPQAO?pqao=CA01¶m=88101&year=2024

2.67 Transactions QA Annual Performance Evaluations by MA

Action	transactionsQaAnnualPerformanceEvaluationsByMA
Purpose	Retrieves QA annual performance evaluations for a Monitoring Agency.
Parameters	Required: ma year Optional: param format
Workflow Example	GET /transactionsQaAnnualPerformanceEvaluations/byMA?ma=CA001¶m=44201&year=2024

2.68 Monitors by State

Action	monitorsByState
Purpose	Retrieves information about all air-quality monitors within a specific state, including site identifiers, coordinates, parameter codes, and operational details.
Configuration	Ensure environment variables AQS_ENV_BASE_URL and AQS_ENV_PORT are set.
Parameters	Required: state Optional: param format
Output	Successful: JSON list of monitoring stations within the selected state. Failure: Returns an error response from the AQS API.
Workflow Example	GET /monitors/byState?state=06¶m=44201

2.69 Monitors by County

Action	monitorsByCounty
Purpose	Retrieves monitor metadata for a specified county within a state.
Parameters	Required: state county Optional: param format
Workflow Example	GET /monitors/byCounty?state=06&county=001¶m=88101

2.70 Monitors by Site

Action	monitorsBySite
Purpose	Retrieves metadata for a specific monitoring site including location, site type, and parameters measured.
Parameters	Required: state county site Optional: format
Workflow Example	GET /monitors/bySite?state=06&county=001&site=0001

2.71 Monitors by CBSA

Action	monitorsByCBSA
Purpose	Retrieves a list of all monitors located within a Core Based Statistical Area (CBSA).
Parameters	Required: cbsa Optional: format
Workflow Example	GET /monitors/byCBSA?cbsa=41860

2.72 Monitors by Box

Action	monitorsByBox
Purpose	Retrieves monitoring stations located inside a geographic bounding box defined by latitude and longitude coordinates.
Parameters	Required: minlat maxlat minlon maxlon Optional: param format
Workflow Example	GET /monitors/byBox?minlat=33.7&maxlat=34.5&minlon=-118.5&maxlon=-117.8

2.73 Meta Data: Fields by Service

Action	metaDataFieldsByService
Purpose	Retrieves metadata about available fields for each AQS service endpoint, providing field names, types, and descriptions.
Parameters	Required: service Optional: format
Workflow Example	GET /metaData/fieldsByService?service=dailyData

2.74 Meta Data: Service Availability

Action	metaDataIsAvailable
Purpose	Checks if a specific AQS service or dataset is currently available.
Parameters	Required: service Optional: format
Workflow Example	GET /metaData/isAvailable?service=sampleData

2.75 Meta Data: Revision History

Action	metaDataRevisionHistory
Purpose	Retrieves revision history and version notes for AQS datasets and endpoints.
Parameters	Required: None Optional: service format
Workflow Example	GET /metaData/revisionHistory?service=annualData

2.76 Meta Data: Issues

Action	metaDataIssues
Purpose	Retrieves reported data or service issues documented by the AQS system.
Parameters	Required: None Optional: format
Workflow Example	GET /metaData/issues

2.77 Signup

Action	signup
Purpose	Retrieves registration or signup information for the EPA AQS API system, enabling clients to obtain necessary credentials for authenticated access.
Parameters	Required: None Optional: format
Workflow Example	GET /signup

2.78 Service Availability

Action	serviceAvailable
Purpose	Checks the current availability of the AQS service. Used as a simple heartbeat or health-check endpoint.
Parameters	Required: None Optional: format
Workflow Example	GET /serviceAvailable

Retrieve Daily Data

Use /dailyData/bySite to fetch daily measurements for a selected pollutant and time range. Example: GET /dailyData/bySite?state=06&county=001&site=0001¶m=88101&bdate=20240101&edate=20240131