Pollen API v2

Last updated: Nov 1, 2018

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:

Current Conditions

Last updated: Nov 1, 2018

Returns current pollen conditions for a specific location

https://api.breezometer.com/pollen/v2/current-conditions?lat={latitude}&lon={longitude}&key={Your_API_Key}&features={Features_List}

Request Parameters

While making an API request, some parameters are required while some 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
features
string
Sets the data fields returned by the response. Possible values:
  • types_information(default)
  • plants_information
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)
Optional
default: en

Examples

Last updated: Nov 1, 2018

Default Request Settings

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

https://api.breezometer.com/pollen/v2/current-conditions?lat=48.857456&lon=2.354611&key={Your_API_Key}

TIP

Note:

In this example only some of the available data fields return, as it uses the default settings, which sets only the types_information feature.

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/current-conditions?lat=48.857456&lon=2.354611&key={Your_API_Key}&features=types_information,plants_information

TIP

Note:

Both request made with default and customized settings are counted as a single object, regardless of the number of features included in the original query.

    "loading..."  

Response Data Fields

Last updated: Nov 1, 2018

The response data field is an object that includes the following fields:

TIP

Note:

  • As in requests to the current conditions endpoint, the most recent data is returned. With pollen, 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.
datetime
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
plants
object
Dictionary of all the available pollen plants: For the list of plants availability by region, see Pollen Availability
Show child fields

Daily Forecast

Last updated: Nov 1, 2018

Returns daily forecast pollen conditions for a specific location. Each daily forecast includes daily pollen index for types and plants for a maximum of 3 days (current day and two following days).

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

Request Parameters

While making an API request, some parameters are required while some 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
Number from 1 to 3 that indicates how many days forecast to request
Required
features
string
Sets the data fields returned by the response. Possible values:
  • types_information(default)
  • plants_information
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)
Optional
default: en

Examples

Last updated: Nov 1, 2018

Default Request Settings

This example shows a request to get the daily pollen conditions in the USA (30.003362, -95.594209) using the default request parameters settings.

https://api.breezometer.com/pollen/v2/forecast/daily?lat=30.003362&lon=-95.594209&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 getting 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=30.003362&lon=-95.594209&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..."  

Response Data Fields

Last updated: Nov 1, 2018

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

TIP

Note:

  • As in requests to the current conditions endpoint, the most recent data is returned. With pollen, 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
plants
object
Dictionary of all the available pollen plants: For the list of plants availability by region, see Pollen Availability
Show child fields

Customizing API Requests

Last updated: Nov 1, 2018

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 current pollen conditions including the types_information and plants_information features:

https://api.breezometer.com/pollen/v2/current-conditions?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.

Features

Last updated: Nov 1, 2018

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, 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.

Metadata

Last updated: Nov 1, 2018

Request Metadata

Last updated: Nov 1, 2018

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 slightly different structure, depending on the request type.

Single Object

Requests for a specific date and time return a single object and a metadata object with a single timestamp. This example shows a request to the hourly forecast endpoint for a specific date and time that returns metadata:

https://api.breezometer.com/pollen/v2/current-conditions?lat=48.857456&lon=2.354611&key={Your_API_Key}&metadata=true

The request returns this metadata object as part of the response:

    "loading..."  

Array of Objects

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

https://api.breezometer.com/pollen/v2/forecast/daily/?&lat=30.003362&lon=-95.594209&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.

timestamp
string
OR
In Request for a Single Object - ISO 8601 UTC timestamp indicating the time the request was made
OR
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
types
object
Dictionary of up to three pollen types:
  • tree
  • grass
  • weed (coming soon)
Show child fields

Supported Plants

Last updated: Nov 1, 2018

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
jpn_cedar_cypress Japanese Cedar and Cypress Tree
oak Oak Tree
graminales Graminales Grass

Integrate BreezoMeter's data in your products today

Get API Key
Talk to an expert