Creating API Keys

This article will go over how to create API keys and navigate the API portal.

You will need a Gmail or Google-associated account to sign in. You can learn more information here: Sign in to your Google Account with another email address - Computer - Google Account Help

The PurpleAir API uses two different API keys, a read key and a write key, which need to be used to make specific API calls. If you want to use the PurpleAir API, you can create your own API keys here:

API keys are issued per user, not per sensor.

Please review our article about the API Online Dashboard.

Create API Keys

  • After signing in, click “API Keys” on the top bar.
    Screenshot 2024-04-01 at 4.14.42 PM
  • Then click the “+ API Key” button in the top right corner of the screen.
    Screenshot 2024-04-01 at 4.21.42 PM
  • You will see an auto-populated project name, which you can rename anytime. You can have several projects and API keys. If you already have multiple projects, be sure to select the appropriate project.
  • Select “Read” for the “Type,” select “Enabled” under “Status,” and leave the fields “Label,” “Host restrictions,” and “Referer restrictions” blank.
    Screenshot 2024-04-01 at 4.18.15 PM
  • Click “Create.”
  • To create a “Write” key, repeat the process but select “Write” under “Type.”

Manage Projects

  • On the top bar, click on “Projects.” Here you can edit and add projects, view each project’s usage, and archive projects.
  • To add a project, click “+ Project” in the top right-hand corner of the page. Choose a project name, and click “Create.”
  • To edit a project name, click the three dots to the right of the project name and select “Edit Project.”
  • To archive a project, do the same as above and select “archive.”
  • To check usage, click on the project name.

Manage Users

  • Select “Users” on the top bar. Here you can edit the name of a user.

Manage Organizations

  • Select “Organization” on the top bar. Here you can edit the organization’s name and view the organization’s usage.
  • The “Purchase Points” button will allow you to add points to your account. Points are used to make API calls.

Learn More

Learn more about our API Guidelines.
Learn more about Making calls with the PurpleAir API
Learn more about the PurpleAir API.

1 Like