Pollen API v2

Last updated: Jul 29, 2021

The Pollen API lets you request pollen information including types, plants, and indexes for a specific location. The API provides endpoints that let you query:

• Daily Forecast

Daily Forecast

Last updated: Oct 20, 2022

Returns daily forecast pollen conditions for a specific location. Each daily forecast includes pollen index for types of plants for 1 to 5 days.

 

https://api.breezometer.com/pollen/v2/forecast/daily?lat={latitude}&lon={longitude}&key=YOUR_API_KEY&features={Features_List}&days={Number_of_Days}

 

Note: We provide a 5-day pollen forecast for all plant types in Canada and the U.S. For other countries, we provide a 5-day pollen forecast for these plants:

• Ash
• Cottonwood
• Oak
• Pine
• Hazel

For all other plants, we provide a 3-day pollen forecast.

Request Parameters

While making an API request, certain parameters are mandatory, while others are optional.

lat

float

Latitude (lat) specifies north-south position of a point in a range between -90 and 90

Required

lon

float

Longitude (lon) specifies east-west position of a point in a range between -180 to 180

Required

key

string

Your BreezoMeter API key

Required

days

int

A number from 1 to 5 that indicates how many days forecast to request
(1 for today, 2 for today and tomorrow, etc.)

Required

features

string

Sets the data fields returned by the response. Possible values:

• types_information(default)
• plants_information
• index_description
• health_recommendations
• plants description

For the list of the data fields returned with each feature, see Features List

Example: types_information,plants_information

Note: You must separate every two features with a comma, and use the exact naming convention as shown in the possible values.

Optional

default: types_information

metadata

boolean

Includes request metadata in the response

Optional

default: false

lang

string

Sets the response language to either:

• en for English (default)
• fr for French
• de for German
• es for Spanish
• nl for Dutch
• it for Italian
• ko for Korean
• ru for Russian
• hi for Hindi
• ja for Japanese
• ms-SG for Malay (Singapore)

Optional

default: en

Was this section helpful? Yes No

Examples

Last updated: Oct 20, 2022

Default Request Settings

This example shows a request to get the daily pollen conditions for central Paris (48.857456, 2.354611) using the default request parameters settings.

https://api.breezometer.com/pollen/v2/forecast/daily?lat=48.857456&lon=2.354611&days=3&key=YOUR_API_KEY

TIP

Note:

In this example only some of the available data fields returns, as it uses the default settings, which sets only the types_information feature. You can expect "today" as the first object in the array, followed by two more object, each one for the following day. The days are based on the local time at the requested location.

The request returns this response:

    "loading..."  

Customized Request

In the example, the request was customized to include additional features:

https://api.breezometer.com/pollen/v2/forecast/daily?lat=48.857456&lon=2.354611&days=3&key=YOUR_API_KEY&features=types_information,plants_information

TIP

Note:

Both request made with default and customized settings are counted the same, regardless of the number of features included in the original query. With pollen daily forecast, each day is counted as one object. If you requested 3 days, they will be counted as 3 objects.

    "loading..."  

Was this section helpful? Yes No

Response Data Fields

Last updated: Jul 11, 2019

The response data field is an array, where each of the objects include the following fields:

TIP

Note:

• The in_season and data_available fields can be true or false, as there are some cases when data will be available out of season and vice versa.

date

string

ISO 8601 UTC timestamp indicating the time the data refers to

index_id

string

Pollen index identifier. Currently the BreezoMeter Pollen Index (index_id: bpi) is the only one supported and will be returned by default.

Index_display_name

string

Pollen index name

types

object

Dictionary of all the available pollen types: For the list of types availability by region, see Pollen Availability

Show child fields

display_name

string

Type name

in_season

boolean

True/false indicating whether the pollen type is in season

data_available

boolean

True/false indicating whether the expected data is available

index

object

Dictionary containing BreezoMeter Pollen Index (bpi) data for each type

Show child fields

value

integer

Index numeric score

category

string

Textual interpretation of the index numeric score

color

string

Hexadecimal color code representing the index numeric score

plants

object

Dictionary of all the available pollen plants: For the list of plants availability by region, see Pollen Availability

Show child fields

display_name

string

Plant name

in_season

boolean

True/false indicating whether the pollen plant is in season

data_available

boolean

True/false indicating whether the expected data is available

index

object

Dictionary containing BreezoMeter Pollen Index (bpi) data for each plant

Show child fields

value

integer

Index numeric score

category

string

Textual interpretation of the index numeric score

color

string

Hexadecimal color code representing the index numeric score

Was this section helpful? Yes No

Customizing API Requests

Last updated: Jul 11, 2019

You can customize any API request to only include the data you need for your software. This allows you to save bandwidth and decrease response time by requesting less information. You customize request data returned using the features parameter to define the feature or list of features to include in the response.

Example

The following returns daily forecast pollen conditions including the types_information and plants_information features:

https://api.breezometer.com/pollen/v2/forecast/daily?lat=48.857456&lon=2.354611&key=YOUR_API_KEY&features=types_information,plants_information

TIP

Note:

Unless you have specified the features parameter in the request, the response returns only the pollen types information.

Was this section helpful? Yes No

Features

Last updated: Oct 20, 2022

Here are the various supported features and details on each of them.

Feature

Description

types_information

All the available pollen types at the requested location, among: tree, grass, weed for each including their BreezoMeter Pollen Index, color, category and seasonality.

This data is located in the data > types object

The response includes these fields for each pollen type: display_name, in_season, data_available, and index

Note:
BreezoMeter Pollen Index (BPI), is a globally unified index that uses a scale of 0 (None) to 5 (Very High). BPI simplifies comparing pollen in different areas.

plants_information

All the available pollen plants at the requested location (you can find the full list of supported plants in Metadata section), for each including their BreezoMeter Pollen Index, color, category and seasonality.

This data is located in the data > plants object

The response includes these fields for each pollen type: display_name, in_season, data_available, and index

Note:
BreezoMeter Pollen Index (BPI), is a globally unified index that uses a scale of 0 (None) to 5 (Very High). BPI simplifies comparing pollen in different areas.

index_description
(available only as part of the
‘health insights & alerts’ service)

A one-sentence description to help users understand the current index level. It will be applied both to the different types and species levels.

health_recommendations
(available only as part of the
‘health insights & alerts’ service)

Actionable insights depending on the current pollen levels.
The health recommendations will be implemented at the type level, while a changing suitable recommendation will be applied according to the index level.

plants_description
(available only as part of the
‘health insights & alerts’ service)

Allow users to identify the plants that affect their allergies and learn more about them. The description includes the following information:

Type	Tree, Weed, Grass
Family	Birch family, Olive Family, etc.
Pollen season	The period when pollen levels are high, e.x Late winter, early spring
Special shapes	Shapes of leaves, bark, flowers or seeds that help identify the plant
Special colors	Colors of leaves, bark, flowers or seeds that help identify the plant
Cross reaction	People with allergy to a certain plant might also have a reaction with other specific plants

The description will also include 2 pictures of each plant, one for the plant full overview and one a close-up for its fruits or leaves.

Was this section helpful? Yes No

Metadata

Last updated: Oct 20, 2022

Request Metadata

Last updated: Oct 20, 2022

Any request to an API endpoint can return metadata that describes the original request. You request metadata by including the metadata parameter in your request with the value true. When excluding the metadata parameter, or setting it to false, the metadata field returns null.

When requested, it has a slightly different structure, depending on the request type.

Array of Objects

Requests for the current day, or the next number of days return an array with a single object or multiple objects, and a metadata object with a range of dates. This example shows a request to the daily forecast endpoint for today that returns metadata:

https://api.breezometer.com/pollen/v2/forecast/daily?&lat=48.857456&lon=2.354611&features=types_information&key=YOUR_API_KEY&days=2&metadata=true

The request’s JSON response includes the following metadata object:

    "loading..."  

Metadata Fields

Metadata objects can include these fields.

start_date

end_date

string

In Request for an Array of Objects - Two dates ISO 8601 local (time at lat/lon) dates:

• start_date - indicates from when the daily data was requested
• end_date - indicates until when the daily data was requested (including)

location

object

Object containing information describing the requested location

Show child fields

country

string

Country for which the data was requested

types

object

Dictionary of up to three pollen types:

• tree
• grass
• weed

Show child fields

plants

array [string]

List of plants available for each type

symptoms

object

Includes potential symptoms for allergy conditions, each in the following structure:
id: {name, severity}
Only available when the “health_recommendations” feature is required

Was this section helpful? Yes No

Supported Plants

Last updated: Jul 11, 2019

The BreezoMeter Pollen API supports various plants, which are made accessible through the different pollen endpoints. Plants’ availability is subject to actual measurements and reports available for BreezoMeter to use, and is changing between different locations.

Here are the various plants’ codes and their metadata we might return:

Code	Display Name	Type
alder	Alder	Tree
ash	Ash	Tree
birch	Birch	Tree
cottonwood	Cottonwood	Tree
elm	Elm	Tree
maple	Maple	Tree
olive	Olive	Tree
juniper	Juniper	Tree
oak	Oak	Tree
pine	Pine	Tree
cypress_pine	Cypress Pine	Tree
hazel	Hazel	Tree
graminales	Graminales	Grass
ragweed	Ragweed	Weed
mugwort	Mugwort	Weed