Frequently Asked Questions

API Keys

• How do I get API keys?
• Which API keys can I use?
• My API keys show as invalid!
• AQI data isn't loading! (Blank or —)
• How do I share my API keys between devices?

Coordinates

• Does Breathable work outside the US?
• How do I choose coordinates?
• Is my location shared with Karbon?
• How do I change the location for my widget?
• Can I have widgets for multiple locations?

Widgets

• Can I create more than one widget?
• How do I add a widget to my device?
• I don't see the widget in the available widgets list!

Other

• Help me with something else...

We've provided detailed instructions for generating the free API key(s) Breathable uses. It's quick and simple.

To top ↩

Breathable can use Air quality Index (AQI) data from four services: IQAir.com, PurpleAir, World Air Quality Index, and AirNow.gov. All of these services offer free accounts and API access for personal use. Breathable requires at least one API key to fetch AQI data.

To top ↩

Most AQI services require you to validate your email address before API keys become active. For more information on API key setup, see our detailed instructions.

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.

If you've been using Breathable for a while, you've likely realized that after around 11 months, IQAir data may stop appearing in the app.

Depending on your widget configuration, this may lead to no data being shown on the widget. This is because free IQAir AQI keys expire after ~1 year.

Good news! You can just delete the old key, create a new one, and enter it into Breathable. After validation, you'll be back in business.

To top ↩

If you've been using Breathable for a while, you've likely realized that after around 11 months, IQAir data may stop appearing in the app.

Depending on your widget configuration, this may lead to no data being shown on the widget. This is because free IQAir AQI keys expire after ~1 year.

Good news! You can just delete the old key, create a new one, and enter it into Breathable. After validation, you'll be back in business.

To top ↩

If you are signed into an iCloud account on your devices, API keys will automatically be synced across all Breathable instances. This means you can set your API keys up once and have them automatically configured across iOS, iPadOS, watchOS, visionOS and macOS.

To top ↩

Yes! IQAir.com, PurpleAir and World Air Quality Index are worldwide sources.

To top ↩

Air Quality Index is based on latitude and longitude coordinates. Breathable makes it easy to find AQI for any location:

• Automatic: Breathable will always use your current location automatically.
• One-time current location: Grant one-time access to your device's current location.
• Choose location on a map: Drag a pin anywhere on a world map to set coordinates for that location.
• Search: Enter a postal code, place name, or partial or full address.

To top ↩

Coordinates are only used to request AQI data. This data is not tied in any way to your device, account, or even to your API keys. Location data is also not stored or sent to any third-party external service. Coordinates are sent as part of the API request to the four supported services only to fetch AQI data for those coordinates, but are not tied to you in any way. Additionally, there is no requirement to use your actual location at any time to get relevant data for your area—simply choose a zip code or region generally near the location you're interested in data from. Historical data is saved to your iCloud account.

To top ↩

You can have Breathable automatically use your current location when measuring AQI data. But if you want to manually manage coordinates, this location can be changed at any time by launching the Breathable app and modifying coordinates via one of the manual tools (search, global map, et cetera). The widget will immediately update its AQI data to the new location. This is particularly handy if you want to change your widget to a place you're not currently in but want to measure.

To top ↩

Not at this time. Breathable is meant to be an at-a-glance look at the AQI where it matters—near you. Being able to arbitrarily look at the AQI of many locations at once is better served by visiting one of the AQI services directly in a browser. Breathable is meant to be a monitor for the air around you.

To top ↩

You can create as many widgets as you want, but all widgets will share the same AQI reading. See Can I have widgets for multiple locations? for details.

To top ↩

The instructions differ depending on your device:

• For iOS: Apple: Use widgets on your iPhone and iPod touch
• For iPadOS: Apple: Use widgets on your iPad
• For macOS: Apple: Use widgets on macOS
• For visionOS: Apple: Use widgets on Apple Vision Pro

To top ↩

In some rare cases, apps will not immediately show in the list of available widgets on iOS or iPadOS. If you don't see Breathable in the list, try this:

1. Restart your device
2. Run the Breathable app once, visit the Widget UI tab and change one or two settings
3. Check the system list of available widgets again

If this doesn't work, please contact support@karbon.agency.

To top ↩

If you have additional questions when using Breathable, please send an email to support@karbon.agency.

To top ↩