Welcome! These APIs are designed to provide access to Pollen Sense's modelled data (hereafter called Grid Data).

Data Source

Observed values as well as forecasted values are available. The data are generated from Pollen Sense's network of monitoring sites consisting of proprietary Automated Particulate Sensors (APS 400 sensors). To interpolate/inference the data between monitoring sites, weather factors - such as solar irradiance and wind speed - are factored in.

We periodically improve both the recognition of the raw counts obtained by APS 400 sensors as well as the the inferencing algorithsm; thus, these data (including historical data) may change on occasion, without prior notice.

Data Generation

Interpolations of yesterday's historical observed data and the 3-day forecasting are done on a daily basis. Processing begins at Midnight (12AM) UTC and typically is finished by 4AM UTC. Yesterday's observations are completed first; followed by the present day's forecast; then the next two days' forecasts in order. As the underlying data for a given day are completed, the underlying map is generated (replacing a previous forecast with an updated forecast or observations where applicable).) Thus, any API calls to the /region API between 12AM UTC - 4AM UTC cannot be considered stable; for example, querying for yesterday may still return the forecast if the observed map has not been generated yet.

Outdated forecasts are not retained and are not accessible; once a new forecast or observations are available, the previous forecasts are replaced with the new data.

Data Format

Some APIs return .geotiff files. These are essentially raster images where each pixel represents a point in geospace as well as value metadata (e.g. particulate concentrations). There are a number of free and/or open source software tools available to view these files.

Grid Regions

Each region has a fixed time zone. For larger regions that span multiple Time Zones (such as North America), the offset is selected by a centrally located Time Zone Offset to represent the start of a 'day' for the entirety of the region. Note: these offsets are used for Grid Region and Airthority APIs. Currently our regions are (listed here in format of RegionName:TimeZone):

• NA:UTC-6

Getting Started

Obtaining a License

Most APIs listed below require a license to be assigned to your Organization's account by a Pollen Sense Account Executive. If you are receiving authorization errors, please contact support or your Pollen Sense Account Executive. Some APIs - such as the /region API - have concepts such as 'Levels' and 'Aggregations', of which are restricted to certain license levels. APIs with various levels of access will return error messages as applicable if your current license does not have access to the requested level of data.

Trial Data Access

Some APIs have trial data access, including forecasts or historical data for analysis. For access to these trial grid datasets (including the latest available date ranges), please contact support or your Pollen Sense Account Executive to get a trial license assigned to your Organization's account.

Historical Trial Grid Data

Select weeks in 2024 can be made available for evaluating Pollen Sense observed grid data. Exact weeks available will be provided by your Pollen Sense Account Executive at the time of license assignment

Forecast Trial Grid Data

Limited-time access to a combination of forecasts plus recent historical days are available for evaluation. Please contact your Pollen Sense Account Executive for more information.

Authentication

You must authorize using one of your api keys located here.

Using API Keys

Two options exist for including your API key in the request: in a URL parameter as ?key=<KEY> or as a header x-ps-key. This documentation uses the ?key=<KEY> query parameter 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).