Welcome! These APIs are designed for use by those who have purchased an APS 400 or later sensor. To purchase a sensor, please visit https://pollensense.com

Overview

Sites

A site is a logical geospatial location consisting of a usage type (e.g. Outdoor Ambient, Indoor Discrete) and latitude/longitude. When a sensor is provisioned to a site, all data (frames, counts, etc) is associated with that site. This allows for sensors to be moved from one location (site) to another while leaving the allergen data associated with the geospatial site in which it was collected at. A site can have multiple sensors associated with it at once - called a cluster. Clustering provides increased data fidelity as well as increased redundnacy.

Metrics

Metrics is the catch-all term for data generated by sensors; generally, the output format will either be in a particulates per cubic meter (PPM^3) or the Pollen Sense Normalized Misery Index (NMI) format. For more information on the NMI, please read the description here. Some APIs may also return data in other units and will note the units as applicable.

Getting Started

Authentication

You must authorize using one of your api keys located here

API keys can be put in the key in a URL parameter ?key=<KEY> or in the header x-ps-key. This documentation uses the x-ps-key header method.

Using Swagger (OpenAPI) docs

1. Click the Authorize button to include your API key in the requests' ps-api-key header.
2. Select an API and click the Try it out button. This will unlock the form fields for use.
3. Follow the prompts to include the required parameters.
4. Click Execute to send the request.
5. Responses will be shown, along with: a curl command for terminal use, or a Request URL for use in a browser or other application (such as Postman).