.. api_ref:

.. currentmodule:: openaq

API Reference
=============

.. _endpoints_api:

The OpenAQ API Wrapper
----------------------

.. rubric:: Classes

.. autosummary::
    :toctree: generated/

    openaq.OpenAQ

.. rubric:: Methods

.. autosummary::
    :toctree: generated/

    openaq.OpenAQ.cities
    openaq.OpenAQ.countries
    openaq.OpenAQ.latest
    openaq.OpenAQ.locations
    openaq.OpenAQ.measurements
    openaq.OpenAQ.fetches
    openaq.OpenAQ.parameters
    openaq.OpenAQ.sources


Utility Functions
-----------------

Helpers
~~~~~~~

.. autosummary::
    :toctree: generated/

    openaq.utils.mass_to_mix

Visualization
~~~~~~~~~~~~~

.. autosummary::
    :toctree: generated/

    openaq.viz.tsplot