purple_air_api (PAA)

This is a wrapper for the PurpleAirAPI (PAA) with a C++ backend and SWIG bindings for Python, JavaScript, C#, and Go. Details of the API can be found using this link: https://api.purpleair.com/#api-welcome

To use the PurpleAirAPI (PAA), API keys are required. You can get API keys by sending an email to [email protected] with a first and last name to assign them to.

New in CalSemVer: The library now uses a high-performance C++ backend with SWIG bindings, providing native performance while maintaining full backward compatibility with existing Python code.

.. image:: https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_pypi.yml/badge.svg :target: https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_pypi.yml :alt: PyPI Distributions

.. image:: https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_test_pypi.yml/badge.svg :target: https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_test_pypi.yml :alt: TestPyPI Distributions

.. image:: https://github.com/carlkidcrypto/purpleair_api/actions/workflows/black.yml/badge.svg :target: https://github.com/carlkidcrypto/purpleair_api/actions/workflows/black.yml :alt: Black

.. image:: https://github.com/carlkidcrypto/purpleair_api/actions/workflows/tests.yml/badge.svg?branch=main :target: https://github.com/carlkidcrypto/purpleair_api/actions/workflows/tests.yml :alt: Tests

.. image:: https://img.shields.io/github/downloads/carlkidcrypto/purpleair_api/total.svg?style=flat-square&label=all%20downloads :target: https://github.com/carlkidcrypto/purpleair_api/releases :alt: Total download count

.. image:: https://img.shields.io/github/downloads/carlkidcrypto/purpleair_api/v2026.11.11a2/total.svg?style=flat-square :target: https://github.com/carlkidcrypto/purpleair_api/releases/tag/v2026.11.11a2 :alt: Latest release download count

How to Support This Project

.. image:: https://cdn.buymeacoffee.com/buttons/default-orange.png :target: https://www.buymeacoffee.com/carlkidcrypto :alt: Buy Me A Coffee :height: 41 :width: 174

Purpose

This package is designed to be used for making tools around the PurpleAir API.

For example, PAA data loggers - https://github.com/carlkidcrypto/purpleair_data_logger

Requirements

• Python 3.10 or higher (supports Python 3.10, 3.11, 3.12, 3.13, and 3.14)
• requests library

Installation

Prerequisites

The C++ backend requires:

- **Linux/Ubuntu**: ``sudo apt-get install build-essential libcurl4-openssl-dev swig meson ninja-build``
- **macOS**: ``brew install curl swig meson ninja``
- **Windows**: Visual Studio C++, SWIG, curl library, Meson, and Ninja

Installation via pip

You can install the PurpleAir API via pip:

.. code-block:: bash

python3 -m pip install purpleair_api

This is the beginning of the README. Read the rest at the original. Read the full README ↗