- HTTP request
- Query parameters
- Request body
- Response body
- Authorization scopes
- LatLng
- DayInfo
- Date
- PollenTypeInfo
- PollenType
- IndexInfo
- Index
- Color
- PlantInfo
- Plant
- PlantDescription
- Try it!
Returns up to 5 days of daily pollen information in more than 65 countries, up to 1km resolution.
HTTP request
GET https://pollen.googleapis.com/v1/forecast:lookup
The URL uses gRPC Transcoding syntax.
Query parameters
Parameters | |
---|---|
location |
Required. The longitude and latitude from which the API searches for pollen forecast data. |
days |
Required. A number that indicates how many forecast days to request (minimum value 1, maximum value is 5). |
pageSize |
Optional. The maximum number of daily info records to return per page. The default and max value is 5, indicating 5 days of data. |
pageToken |
Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token, all other request parameters provided must match the previous call that provided the page token. |
languageCode |
Optional. Allows the client to choose the language for the response. If data cannot be provided for that language, the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. The default value is "en". |
plantsDescription |
Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. The default value is "true". |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"regionCode": string,
"dailyInfo": [
{
object ( |
Fields | |
---|---|
regionCode |
The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory. |
dailyInfo[] |
Required. This object contains the daily forecast information for each day requested. |
nextPageToken |
Optional. The token to retrieve the next page. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
LatLng
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
JSON representation |
---|
{ "latitude": number, "longitude": number } |
Fields | |
---|---|
latitude |
The latitude in degrees. It must be in the range [-90.0, +90.0]. |
longitude |
The longitude in degrees. It must be in the range [-180.0, +180.0]. |
DayInfo
This object contains the daily forecast information for each day requested.
JSON representation |
---|
{ "date": { object ( |
Fields | |
---|---|
date |
The date in UTC at which the pollen forecast data is represented. |
pollenTypeInfo[] |
This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request. |
plantInfo[] |
This list will include up to 15 pollen species affecting the location specified in the request. |
Date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
- A full date, with non-zero year, month, and day values.
- A month and day, with a zero year (for example, an anniversary).
- A year on its own, with a zero month and a zero day.
- A year and month, with a zero day (for example, a credit card expiration date).
Related types:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
JSON representation |
---|
{ "year": integer, "month": integer, "day": integer } |
Fields | |
---|---|
year |
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
month |
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
day |
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
PollenTypeInfo
This object contains the pollen type index and health recommendation information on specific pollen type.
JSON representation |
---|
{ "code": enum ( |
Fields | |
---|---|
code |
The pollen type's code name. For example: "GRASS" |
displayName |
A human readable representation of the pollen type name. Example: "Grass" |
indexInfo |
Contains the Universal Pollen Index (UPI) data for the pollen type. |
healthRecommendations[] |
Textual list of explanations, related to health insights based on the current pollen levels. |
inSeason |
Indication whether the plant is in season or not. |
PollenType
Pollen Type Code
Enums | |
---|---|
POLLEN_TYPE_UNSPECIFIED |
Unspecified plant type. |
GRASS |
Grass pollen type. |
TREE |
Tree pollen type. |
WEED |
Weed pollen type. |
IndexInfo
This object contains data representing specific pollen index value, category and description.
JSON representation |
---|
{ "code": enum ( |
Fields | |
---|---|
code |
The index's code. This field represents the index for programming purposes by using snake cases instead of spaces. Example: "UPI". |
displayName |
A human readable representation of the index name. Example: "Universal Pollen Index". |
category |
Text classification of index numerical score interpretation. The index consists of six categories:
|
indexDescription |
Textual explanation of current index level. |
color |
The color used to represent the Pollen Index numeric score. |
value |
The index's numeric score. Numeric range is between 0 and 5. |
Index
Index Code
Enums | |
---|---|
INDEX_UNSPECIFIED |
Unspecified index. |
UPI |
Universal Pollen Index. |
Color
Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of java.awt.Color
in Java; it can also be trivially provided to UIColor's +colorWithRed:green:blue:alpha
method in iOS; and, with just a little work, it can be easily formatted into a CSS rgba()
string in JavaScript.
This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space.
When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5
.
Example (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
Example (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
Example (JavaScript):
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
JSON representation |
---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
Fields | |
---|---|
red |
The amount of red in the color as a value in the interval [0, 1]. |
green |
The amount of green in the color as a value in the interval [0, 1]. |
blue |
The amount of blue in the color as a value in the interval [0, 1]. |
alpha |
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation:
This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). |
PlantInfo
This object contains the daily information on specific plant.
JSON representation |
---|
{ "code": enum ( |
Fields | |
---|---|
code |
The plant code name. For example: "COTTONWOOD". A list of all available codes could be found here. |
displayName |
A human readable representation of the plant name. Example: “Cottonwood". |
indexInfo |
This object contains data representing specific pollen index value, category and description. |
plantDescription |
Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. |
inSeason |
Indication of either the plant is in season or not. |
Plant
Lists available plants with varying availability across locations.
Enums | |
---|---|
PLANT_UNSPECIFIED |
Unspecified plant code. |
ALDER |
Alder is classified as a tree pollen type. |
ASH |
Ash is classified as a tree pollen type. |
BIRCH |
Birch is classified as a tree pollen type. |
COTTONWOOD |
Cottonwood is classified as a tree pollen type. |
ELM |
Elm is classified as a tree pollen type. |
MAPLE |
Maple is classified as a tree pollen type. |
OLIVE |
Olive is classified as a tree pollen type. |
JUNIPER |
Juniper is classified as a tree pollen type. |
OAK |
Oak is classified as a tree pollen type. |
PINE |
Pine is classified as a tree pollen type. |
CYPRESS_PINE |
Cypress pine is classified as a tree pollen type. |
HAZEL |
Hazel is classified as a tree pollen type. |
GRAMINALES |
Graminales is classified as a grass pollen type. |
RAGWEED |
Ragweed is classified as a weed pollen type. |
MUGWORT |
Mugwort is classified as a weed pollen type. |
PlantDescription
Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
The plant's pollen type. For example: "GRASS". A list of all available codes could be found here. |
family |
A human readable representation of the plant family name. Example: "Betulaceae (the Birch family)". |
season |
Textual list of explanations of seasons where the pollen is active. Example: "Late winter, spring". |
specialColors |
Textual description of the plants' colors of leaves, bark, flowers or seeds that helps identify the plant. |
specialShapes |
Textual description of the plants' shapes of leaves, bark, flowers or seeds that helps identify the plant. |
crossReaction |
Textual description of pollen cross reaction plants. Example: Alder, Hazel, Hornbeam, Beech, Willow, and Oak pollen. |
picture |
Link to the picture of the plant. |
pictureCloseup |
Link to a closeup picture of the plant. |