Search
K

Authentication

With this API documentation, you can explore and interact with all the endpoints of the AirQo API.
This documentation shares the RESTful api endpoints provided by AirQo for retrieving measurements and device metadata from the AirQo monitoring network.

The BASE URL

https://api.airqo.net/api/{VERSION_NUMBER}

Authentication

To access the AirQo Analytics API, you need to follow these steps:
  1. 1.
    Request Access: Obtain an AirQo Analytics Account by requesting for access: https://platform.airqo.net/request-access
  2. 2.
    Register a Client: Once you have an account, log in and navigate to your account settings. Register a new client application to generate client credentials.
  3. 3.
    Create an Access Token: With the client credentials, you can create an access token. This token will be used to authenticate your API requests.
  4. 4.
    Use the token: Copy the newly created access token and include it as a query parameter (token) in the API endpoints shared below.
Please note that the V1 endpoint for device measurements will be deprecated on 30th July 2023. After 30th July 2023, all requests to these endpoints will result in errors.
We recommend that you start the migration to Version 2 before this deprecation date.

Key Endpoints

Here are the key endpoints you can use to retrieve measurements:

Recent

Historical

Forecasts

Metadata

For support, please reach out to [email protected] to report bugs. We will also appreciate any feedback you would like to share with us!