Q: Can I set my PurpleAir sensor to private, and how do I view a private sensor on the map?

Setting Your Sensor to Private

When registering your PurpleAir sensor, you have the option to designate it as either public or private with the Visibility option.

  • Public Sensors: Visible to all users on the PurpleAir map.
  • Private Sensors: Only visible to the sensor’s owner and individuals with whom the owner shares specific access information. How Private is my Sensor

If you choose to set your sensor as private during registration, it will not appear on the public map. However, you can still access its data through specific methods.

Viewing a Private Sensor on the Map

There are two primary ways to view your private sensor:

1. Using the Registration Confirmation Email

After registering your sensor, you will receive a confirmation email sent to both the associated and owner’s email addresses provided during registration. This email contains direct links to view your sensor on the PurpleAir map.

  • Look for the link labeled “View on the PurpleAir map” under the “Useful Links” section.
  • Clicking this link will direct you to a map view displaying your private sensor.

2. Logging into the PurpleAir Map

You can log into the PurpleAir map to view your private sensors:

  • Navigate to map.purpleair.com.
  • Click on the “Login” button located at the top right corner of the page.
  • Sign in using the Google account that matches the Owner’s Email provided during sensor registration.
  • Once logged in, ensure the “Show My Sensors” option is enabled in the map’s configuration menu. Here is more information about those settings.

Please note: Currently, only Google-associated email addresses are supported for this login feature. If your Owner’s Email is not linked to a Google account, you won’t be able to use this method to view your private sensor.

Sharing Access to a Private Sensor

If you wish to share your private sensor’s data with others:

  • Provide them with the direct link from your registration confirmation email.
  • Alternatively, you can create a custom URL using your sensor’s Sensor Index and Read Key.

For example:

https://map.purpleair.com/?show=YOUR_SENSOR_INDEX&key=YOUR_READ_KEY

Replace YOUR_SENSOR_INDEX and YOUR_READ_KEY with your sensor’s specific information.

Changing a Sensor’s Privacy Setting

If you initially registered your sensor as public but wish to make it private (or vice versa):

  • Use the “Modify this registration” link found in your registration confirmation email.
  • This link will take you to a pre-filled registration form where you can adjust the privacy setting.
  • After making the desired changes, click “Register” to update your sensor’s settings.

Additional Considerations

  • Indoor vs. Outdoor Sensors: On the PurpleAir map, indoor sensors are indicated with a black outline, while outdoor sensors have no outline.
  • API Access: Private sensor data is not publicly accessible via the API. To access this data, you must provide the correct Sensor Index and Read Key.
  • Data Sharing with Third Parties: Even if your sensor is set to private, it may still report data to third-party services like Weather Underground if selected during registration.

For more detailed information, please refer to the following resources:

How can I view my private sensor in Home Assistant, e.g. allow my API key access to my private sensors, or a special API key for my private sensor?

Hi @ptr727

I’m not exactly sure how your home assistant integration is working. Normally through the API you can just provide a sensor’s read key to access private data.

PurpleAir has an official HA integration, that requires the use of API read keys, the sensor read key is not the same as the API keys (I tried it does not work).
So it seems I need to somehow have the develop API key configured to allow access to my hidden sensor.
Or is there another way?

Hi @ptr727

That is not an official PA and HA integration. Although it is widely used, we do not support any official integrations.

There is no way to enable a certain private sensor on an API read key, you need both your API read key and the sensor’s read key to retrieve private data. If there is not an option to input the sensor’s read key in the integration anywhere, then you’ll need to either make your sensor public or contact the creator of the integration and request that feature.

I understand it is not an “official” PA integration, but it does use the official PA developer API.

The reason I made my sensor private is because the map confuses people when indoor sensors show clean air mixed with dirty air sensors and no obvious way to show it is an indoor sensor.
E.g. during LA fires my neighbors asked me why my sensors says air is clean while it is all smokey outside. So I made my indoor sensor private as to not confuse people in distress looking at the map.

A way to solve the problem is to not show indoor sensors on the map, or not be default show indoor sensors on the map, or allow my developer API key access to my private sensors.

For me the right solution is to allow develop API keys access to private sensors, e.g. by verifying developer email is same as registered sensor email.

1 Like

Indoor sensors have a black outline while outdoor sensors do not, so that’s the best way to tell them apart.

Additionally, if you want to hide indoor sensors, and only display outdoor ones, you can uncheck the “indoor sensors” option in the Configuration Menu.

Take a look at our Map Guide for more information on the Configuration Menu and how to use the Map in the best way for you!

Not very obvious in my humble opinion, and by the confusion of my neighbors not obvious for them either.

Regardless, I’m still interested in finding out how to get access to my private sensors using the API key based API?

1 Like

Very fair. Would it be more clear if there were a legend? Perhaps down in the corner where the AQI legend is.

Regarding your API key, please send in a request to contact@purpleair.com. We’ll be happy to help!

I am not a UX expert, so can’t really comment on implementation details that require some user testing, but I do wonder what the use case is for seeing the indoor air quality in other peoples houses on the map, maybe indoor sensors could by default be disabled?