Help with API keys
All of these services offer free accounts and free API access for personal use. Breathable requires an IQAir.com API key, but an AirNow.gov API key is optional. Once configured, if iCloud is enabled on your devices, these keys will automatically sync to your other devices.
Important notes:
- IQAir.com API keys expire after ~1 year. But you can delete the old key and create a new free key, re-enter it into Breathable, and you're good to go.
- Users have reported a minor delay between creating an API key and it actually being valid and usable. This is especially true for IQAir.com keys, where the site might tell you the key is ready, but with a very small warning that it could take up to 5 minutes to activate. If you create a new key and it immediately shows as invalid in Breathable, wait a few minutes and try again.
IQAir.com
-
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 with IQAir before continuing.
- Once signed in, visit the Air Quality API dashboard.
- 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
- Click the "Get a plan" button
- 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
AirNow.gov
-
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 with AirNow before continuing.
- 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