Help with API keys

Creating free API keys Breathable uses only takes a few minutes.

Breathable Breathable

All of these services offer free accounts and free API access for personal use. Breathable requires at least one API key, but you can add a key for as many services as you'd like. Once configured, if iCloud is enabled, your keys will automatically sync to your other devices.

Important notes:

IQAir.com
  1. Create an IQAir.com account, or sign into an existing account
    • Note: If you created a new account, you'll need to verify your email address before continuing.
  2. Once signed in, visit the Air Quality API dashboard
  3. If you've never created a key, skip to step 4, otherwise first delete your existing key:
    • Click the ••• button for the existing key in the list, then "Delete"
    • Confirm the deletion
  4. Click the "Get a plan" button
  5. Under "Community (Free)", click the "Subscribe now" button

Your API key should now be created and you'll be returned to the API dashboard. You can now copy the string labeled "Key" and paste it into Breathable.

The key should look something like: 11a2345k-453a-1n89-67h3-6z11wh9r21b7

To top ↩

PurpleAir
  1. Create a PurpleAir developer account using a Google account, or sign in to an existing account
  2. Optionally, confirm your time zone (this does not impact Breathable AQI data)
  3. View the API Keys tab, and click the "+ API Key" button
  4. For Project and User, the default values can be used. For Key Type, choose "Read", and for Status, choose "Enabled"
  5. Click "Create"

Your API key should now be created and you'll be returned to the API Keys tab. You can now copy the string labeled "Key" and paste it into Breathable.

The key should look something like: 1D6A4045-9C13-41D1-9F32-3463BF2CC148

To top ↩

World Air Quality Index
  1. Create an Air Quality Open Data Platform account
    • Note: Accounts generate a one-time token, but are otherwise not retained. If you need a new API token in the future, you can create another AQODP account with a different email address.
  2. Verify your email address
  3. Complete the CAPTCHA

Your API key will be displayed automatically after completing your account setup steps. You can now copy the key and paste it into Breathable.

The key should look something like: fnd535cf247da2ab1367gea12b5h967b1cc6fa3e

To top ↩

AirNow.gov
  1. Create an AirNow developer tools account, or sign into an existing account
    • Note: If you created a new account, you'll need to verify your email address before continuing.
  2. Once signed in, visit the AirNow API web services page

Your API key will be shown in the top-right corner of the page. You can now copy the key and paste it into Breathable.

The key should look something like: FG482957-1982-5999-0R12-1V77N5AZ2251

To top ↩