tools.tools.openaq_tool

OpenAQ API Tool Module.

This module provides tools for accessing air quality data from the OpenAQ API. It currently supports retrieving detailed information about specific air quality monitoring locations by their ID.

The OpenAQ platform aggregates air quality data from public data sources worldwide, providing standardized access to air quality measurements including particulate matter, ozone, nitrogen dioxide, sulfur dioxide, and carbon monoxide.

Examples

>>> from haive.tools.tools.openaq_tool import get_openaq_location
>>> location_data = get_openaq_location(location_id=12345, api_key="your_api_key")
>>> print(location_data['name'])

Attributes

openaq_location_tool

Functions

get_openaq_location(→ dict)

Fetch detailed information about an air quality monitoring location from OpenAQ.

Module Contents

tools.tools.openaq_tool.get_openaq_location(location_id: int, api_key: str | None = None) → dict

Fetch detailed information about an air quality monitoring location from OpenAQ.

This function retrieves comprehensive metadata about a specific air quality monitoring station identified by its location ID, including its coordinates, available parameters, and other attributes.

Parameters:

  • location_id (int) – The OpenAQ location ID to fetch data for.

  • api_key (Optional[str]) – The OpenAQ API key. If not provided, will look for OPENAQ_API_KEY in environment variables.

Returns:

A dictionary containing detailed information about the location,

including geographical coordinates, available parameters, and metadata.

Return type:

dict

Raises:

  • ValueError – If no API key is provided or found in environment variables.

  • requests.RequestException – If the API request fails.

tools.tools.openaq_tool.openaq_location_tool