Pollen Index

Overview

  • Domain Portfolio: Forecast
  • Domain: Lifestyle - Indices
  • Usage Classification: Standard
  • Geography: Global
  • Attribution Required: n/a
  • Attribution Requirements: n/a

Your content licensing agreement with TWC® determines the number of days returned in the API response and is constrained by the API Key that is provided to your company.

The Forecast Indices API is sourced from the TWC Forecast system. The Pollen index provides forecast indices for Grass, Ragweed, and Tree pollen.

HTTP Headers and Data Lifetime - Caching and Expiration

For details on appropriate header values as well as caching and expiration definitions, please see The Weather Company® Data | API Common Usage Guide.

Translated Fields:

This TWC API handles the translation of phrases. However, when formatting a request URL a valid language must be passed along (see the language code table for the supported codes).
  • dayPartName
  • grassPollenCategory
  • ragweedPollenCategory
  • treePollenCategory

URL Construction

Atomic API URL Examples:
Pollen Index - Daypart API

Request by Geocode (Latitude & Longitude): Required Parameters: geocode, language, format

https://api.weather.com/v2/indices/pollen/daypart/<duration>?geocode=33.74,-84.39&language=en-US&format=<json>&apiKey=yourApiKey

Aggregate Product Name

https://api.weather.com/v2/indices/pollen/daypart/3day?geocode=33.74,-84.39&language=en-US&format=json&apiKey=yourApiKey

https://api.weather.com/v2/indices≈?geocode=33.74,-84.39&language=en-US&format=json&apiKey=yourApiKey

https://api.weather.com/v2/indices/pollen/daypart/7day?geocode=33.74,-84.39&language=en-US&format=json&apiKey=yourApiKey

https://api.weather.com/v2/indices/pollen/daypart/10day?geocode=33.74,-84.39&language=en-US&format=json&apiKey=yourApiKey

https://api.weather.com/v2/indices/pollen/daypart/15day?geocode=33.74,-84.39&language=en-US&format=json&apiKey=yourApiKey

v2idxPollenDaypart3

v2idxPollenDaypart5

v2idxPollenDaypart7

v2idxPollenDaypart10

v2idxPollenDaypart15

Request by Postal Code: Required Parameters: postalCode, countryCode, language, format

https://api.weather.com/v2/indices/pollen/daypart/<duration>?postalCode=94608&countryCode=US&format=<json>&language=en-US&apiKey=yourApiKey

Aggregate Product Name
https://api.weather.com/v2/indices/pollen/daypart/3day?postalCode=94608&countryCode=US&format=json&language=en-US&apiKey=yourApiKey v2idxPollenDaypart3

Data Elements & Definitions

API Name Field Name Description Type Range Sample Nulls Allowed Usage
Repeating Elements: Unique to Forecast              
fcstValid Time forecast is valid ... start of the forecast period, always 7am local time.   [epoch]   1369306800 N Display As Provided
fcstValidLocal Time forecast is valid ... start of the forecast period, always 7am local time.   [ISO]   2013-05-23T07:00:00-0400 N Display As Provided
Repeating Elements: Common Per Time Segment              
num Daypart Segment (12hour) - Sequential daypart number, where 1 = daytime of Day 0   [integer]   21 N Display As Provided
dayInd Day / Night Indicator   [string] D,N D N Display As Provided
daypartName Name of 12hr daypart, not including day names in first 48hrs   [string]   Tomorrow N Display As Provided
Atomic Indices              
Pollen Index grassPollenCategory Descriptive text of Grass Pollen Index [string]   Low N Display As Provided
grassPollenIndex

Forecast Grass Pollen Index.

0=none / out of season, 1=low, 2=moderate, 3=high, 4=very high

  [integer] 0-4 1 N Display As Provided
ragweedPollenCategory Descriptive text of Ragweed Pollen Index   [string]   Low N Display As Provided
ragweedPollenIndex

Forecast Ragweed Pollen Index.

0=none / out of season, 1=low, 2=moderate, 3=high, 4=very high

  [integer] 0-4 1 N Display As Provided
treePollenCategory Descriptive text of Tree Pollen Index   [string]   Low N Display As Provided
treePollenIndex

Forecast Tree Pollen Index.

0=none / out of season, 1=low, 2=moderate, 3=high, 4=very high

  [integer] 0-4 1 N Display As Provided

JSON Sample

JSON Sample - Daypart

{"metadata": {},

"pollenForecast12hour": {

"fcstValid": [],

"fcstValidLocal": [],

"dayInd": [],

"num": [],

"daypartName": [],

"grassPollenIndex": [],

"grassPollenCategory": [],

"treePollenIndex": [],

"treePollenCategory": [],

"ragweedPollenIndex": [],

"ragweedPollenCategory": []

}}

{//JSON payload},

{//JSON payload},

{//JSON payload},

{//JSON payload},

{//JSON payload},

{//JSON payload},

{//JSON payload},

{//JSON payload},

{//JSON payload},

{//JSON payload},

{//JSON payload},