Index
Weather
(interface)AirPressure
(message)CardinalDirection
(enum)ForecastDay
(message)ForecastDayPart
(message)ForecastHour
(message)HistoryHour
(message)IceThickness
(message)IceThickness.Unit
(enum)LookupCurrentConditionsRequest
(message)LookupCurrentConditionsResponse
(message)LookupCurrentConditionsResponse.CurrentConditionsHistory
(message)LookupForecastDaysRequest
(message)LookupForecastDaysResponse
(message)LookupForecastHoursRequest
(message)LookupForecastHoursResponse
(message)LookupHistoryHoursRequest
(message)LookupHistoryHoursResponse
(message)MoonEvents
(message)MoonPhase
(enum)Precipitation
(message)PrecipitationProbability
(message)PrecipitationType
(enum)QuantitativePrecipitationForecast
(message)QuantitativePrecipitationForecast.Unit
(enum)SpeedUnit
(enum)SunEvents
(message)Temperature
(message)TemperatureUnit
(enum)UnitsSystem
(enum)Visibility
(message)Visibility.Unit
(enum)WeatherCondition
(message)WeatherCondition.Type
(enum)Wind
(message)WindDirection
(message)WindSpeed
(message)
Weather
Service definition for the Weather API.
LookupCurrentConditions |
---|
Returns the current weather conditions at a given location.
|
LookupForecastDays |
---|
Returns up to 10 days of daily forecasts at a given location, starting from the current day.
|
LookupForecastHours |
---|
Returns up to 240 hours of hourly forecasts at a given location, starting from the current hour.
|
LookupHistoryHours |
---|
Returns up to 24 hours of hourly historical weather data at a given location, starting from the last hour.
|
AirPressure
Represents the atmospheric air pressure conditions.
Fields | |
---|---|
mean_ |
The mean sea level air pressure in millibars. |
CardinalDirection
Represents a cardinal direction (including ordinal directions).
Enums | |
---|---|
CARDINAL_DIRECTION_UNSPECIFIED |
The cardinal direction is unspecified. |
NORTH |
The north cardinal direction. |
NORTH_NORTHEAST |
The north-northeast secondary intercardinal direction. |
NORTHEAST |
The northeast intercardinal direction. |
EAST_NORTHEAST |
The east-northeast secondary intercardinal direction. |
EAST |
The east cardinal direction. |
EAST_SOUTHEAST |
The east-southeast secondary intercardinal direction. |
SOUTHEAST |
The southeast intercardinal direction. |
SOUTH_SOUTHEAST |
The south-southeast secondary intercardinal direction. |
SOUTH |
The south cardinal direction. |
SOUTH_SOUTHWEST |
The south-southwest secondary intercardinal direction. |
SOUTHWEST |
The southwest intercardinal direction. |
WEST_SOUTHWEST |
The west-southwest secondary intercardinal direction. |
WEST |
The west cardinal direction. |
WEST_NORTHWEST |
The west-northwest secondary intercardinal direction. |
NORTHWEST |
The northwest intercardinal direction. |
NORTH_NORTHWEST |
The north-northwest secondary intercardinal direction. |
ForecastDay
Represents a daily forecast record at a given location.
Fields | |
---|---|
interval |
The UTC time interval when this forecasted day is starts (inclusive) and ends (exclusive). Note: a day starts at 7am and ends at 7am next day, local time. For example: If the local time zone is UTC-7, then the interval will start at the time |
display_ |
The local date in the time zone of the location (civil time) which this daily forecast is calculated for. This field may be used for display purposes on the client. |
daytime_ |
The forecasted weather conditions for the daytime part of the day (7am to 7pm local time). |
nighttime_ |
The forecasted weather conditions for the nighttime part of the day (7pm to 7am next day, local time). |
max_ |
The maximum (high) temperature throughout the day. |
min_ |
The minimum (low) temperature throughout the day. |
feels_ |
The maximum (high) feels-like temperature throughout the day. |
feels_ |
The minimum (low) feels-like temperature throughout the day. |
max_ |
The maximum heat index temperature throughout the day. |
sun_ |
The events related to the sun (e.g. sunrise, sunset). |
moon_ |
The events related to the moon (e.g. moonrise, moonset). |
ice_ |
The accumulated amount of ice throughout entire the day. |
ForecastDayPart
Represents a forecast record for a part of the day.
Fields | |
---|---|
interval |
The UTC date and time when this part of the day starts (inclusive) and ends (exclusive). Note: a part of a day starts at 7am and ends at 7pm the same day, local time. For example: If the local time zone is UTC-7, then the daytime interval will start at the time |
weather_ |
The forecasted weather condition. |
precipitation |
The forecasted precipitation. |
wind |
The average wind direction and maximum speed and gust. |
relative_ |
The forecasted percent of relative humidity (values from 0 to 100). |
uv_ |
The maximum forecasted ultraviolet (UV) index. |
thunderstorm_ |
The average thunderstorm probability. |
cloud_ |
Average cloud cover percent. |
ForecastHour
Represents an hourly forecast record at a given location.
Fields | |
---|---|
interval |
The one hour interval (in UTC time) this forecast data is valid for (the timestamps are rounded down to the closest hour). |
display_ |
The local date and time in the time zone of the location (civil time) which this hourly forecast is calculated for. This field may be used for display purposes on the client. Note: this date will consist of the year, month, day, hour and offset from UTC. |
weather_ |
The foreacasted weather condition. |
temperature |
The forecasted temperature. |
feels_ |
The measure of how the temperature will feel like at the requested location. |
dew_ |
The forecasted dew point temperature. |
heat_ |
The forecasted heat index temperature. |
wind_ |
The forecasted wind chill, air temperature exposed on the skin. |
wet_ |
The forecasted wet bulb temperature, lowest temperature achievable by evaporating water. |
precipitation |
The forecasted precipitation probability and amount of precipitation accumulated over the last hour. |
air_ |
The forecasted air pressure conditions. |
wind |
The forecasted wind conditions. |
visibility |
The forecasted visibility. |
ice_ |
The forecasted ice thickness. |
is_ |
True if this hour is between the local sunrise (inclusive) and sunset (exclusive) times. Otherwise, it is nighttime (between the sunset and the next sunrise). Note: this hour will be considered as daytime or nighttime if the interval intersects with the local sunrise and sunset times respectively (e.g.: if the interval is from 5am to 6am and sunrise is at 5:59am, then is_daytime will be true). |
relative_ |
The forecasted percent of relative humidity (values from 0 to 100). |
uv_ |
The forecasted ultraviolet (UV) index. |
thunderstorm_ |
The forecasted thunderstorm probability (values from 0 to 100). |
cloud_ |
The forecasted percentage of the sky covered by clouds (values from 0 to 100). |
HistoryHour
Represents an hourly history record at a given location.
Fields | |
---|---|
interval |
The one hour interval (in UTC time) this historical data is valid for (the timestamps are rounded down to the closest hour). |
display_ |
The local date and time in the time zone of the location (civil time) which this hourly record is calculated for. This field may be used for display purposes on the client. Note: this date will consist of the year, month, day, hour and offset from UTC. |
weather_ |
The historical weather condition. |
temperature |
The historical temperature. |
feels_ |
The measure of how the temperature felt like at the requested location. |
dew_ |
The historical dew point temperature. |
heat_ |
The historical heat index temperature. |
wind_ |
The historical wind chill, air temperature exposed on the skin. |
wet_ |
The historical wet bulb temperature, lowest temperature achievable by evaporating water. |
precipitation |
The historical precipitation probability and amount of precipitation accumulated over the last hour. |
air_ |
The historical air pressure conditions. |
wind |
The historical wind conditions. |
visibility |
The historical visibility. |
ice_ |
The historical ice thickness. |
is_ |
True if this hour is between the local sunrise (inclusive) and sunset (exclusive) times. Otherwise, it is nighttime (between the sunset and the next sunrise). Note: this hour will be considered as daytime or nighttime if the interval intersects with the local sunrise and sunset times respectively (e.g.: if the interval is from 5am to 6am and sunrise is at 5:59am, then is_daytime will be true). |
relative_ |
The historical percent of relative humidity (values from 0 to 100). |
uv_ |
The historical ultraviolet (UV) index. |
thunderstorm_ |
The historical thunderstorm probability (values from 0 to 100). |
cloud_ |
The historical percentage of the sky covered by clouds (values from 0 to 100). |
IceThickness
Represents ice thickness conditions.
Fields | |
---|---|
unit |
The code that represents the unit used to measure the ice thickness. |
thickness |
The ice thickness value. |
Unit
Represents the unit used to measure the ice thickness.
Enums | |
---|---|
UNIT_UNSPECIFIED |
The unit is not specified. |
MILLIMETERS |
The thickness is measured in millimeters. |
INCHES |
The thickness is measured in inches. |
LookupCurrentConditionsRequest
Request for the LookupCurrentConditions RPC.
Fields | |
---|---|
location |
Required. The location to get the current weather conditions for. |
units_ |
Optional. The units system to use for the returned weather conditions. If not provided, the returned weather conditions will be in the metric system (default = METRIC). |
language_ |
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". |
LookupCurrentConditionsResponse
Response for the LookupCurrentConditions RPC - represents the current weather conditions at the requested location.
Fields | |
---|---|
current_ |
Current time (UTC) associated with the returned data. |
time_ |
The time zone at the requested location. |
weather_ |
The current weather condition. |
temperature |
The current temperature. |
feels_ |
The measure of how the temperature currently feels like at the requested location. |
dew_ |
The current dew point temperature. |
heat_ |
The current heat index temperature. |
wind_ |
The current wind chill, air temperature exposed on the skin. |
precipitation |
The current precipitation probability and amount of precipitation accumulated over the last hour. |
air_ |
The current air pressure conditions. |
wind |
The current wind conditions. |
visibility |
The current visibility. |
current_ |
The changes in the current conditions over the last 24 hours. |
is_ |
True if the current time at the requested location is between the local sunrise (inclusive) and the sunset (exclusive) times. Otherwise, it is nighttime (between the sunset and the next sunrise). |
relative_ |
The current percent of relative humidity (values from 0 to 100). |
uv_ |
The current ultraviolet (UV) index. |
thunderstorm_ |
The current thunderstorm probability (values from 0 to 100). |
cloud_ |
The current percentage of the sky covered by clouds (values from 0 to 100). |
CurrentConditionsHistory
Represents a set of changes in the current conditions over the last 24 hours.
Fields | |
---|---|
temperature_ |
The current temperature minus the temperature 24 hours ago. |
max_ |
The maximum (high) temperature in the past 24 hours. |
min_ |
The minimum (low) temperature in the past 24 hours. |
qpf |
The amount of precipitation (rain or snow), measured as liquid water equivalent, that has accumulated over the last 24 hours. Note: QPF is an abbreviation for Quantitative Precipitation Forecast (please see the QuantitativePrecipitationForecast definition for more details). |
LookupForecastDaysRequest
Request for the LookupForecastDays RPC.
Fields | |
---|---|
location |
Required. The location to get the daily forecast for. |
units_ |
Optional. The units system to use for the returned weather conditions. If not provided, the returned weather conditions will be in the metric system (default = METRIC). |
page_ |
Optional. The maximum number of daily forecast records to return per page - a value from 1 to 10 (inclusive). The default value is 5. |
page_ |
Optional. A page token received from a previous request. It is used to retrieve the subsequent page. |
days |
Optional. Limits the amount of total days to fetch starting from the current day - a value from 1 to 10 (inclusive). The default value is the maximum allowed value of 10. |
language_ |
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". |
LookupForecastDaysResponse
Response for the LookupForecastDays RPC.
Fields | |
---|---|
forecast_ |
The daily forecast records, according to the number of days and page size specified in the request. |
time_ |
The time zone at the requested location. |
next_ |
The token to retrieve the next page. |
LookupForecastHoursRequest
Request for the LookupForecastHours RPC.
Fields | |
---|---|
location |
Required. The location to get the hourly forecast for. |
units_ |
Optional. The units system to use for the returned weather conditions. If not provided, the returned weather conditions will be in the metric system (default = METRIC). |
page_ |
Optional. The maximum number of hourly forecast records to return per page - a value from 1 to 24 (inclusive). The default is the maximum allowed value of 24. |
page_ |
Optional. A page token received from a previous request. It is used to retrieve the subsequent page. |
hours |
Optional. Limits the amount of total hours to fetch starting from the current hour - a value from 1 to 240 (inclusive). The default is the maximum allowed value of 240. |
language_ |
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". |
LookupForecastHoursResponse
Response for the LookupForecastHours RPC.
Fields | |
---|---|
forecast_ |
The hourly forecast records, according to the number of hours and page size specified in the request. |
time_ |
The time zone at the requested location. |
next_ |
The token to retrieve the next page. |
LookupHistoryHoursRequest
Request for the LookupHistoryHours RPC.
Fields | |
---|---|
location |
Required. The location to get the hourly historical data for. |
units_ |
Optional. The units system to use for the returned weather conditions. If not provided, the returned weather conditions will be in the metric system (default = METRIC). |
page_ |
Optional. The maximum number of hourly historical records to return per page - a value from 1 to 24 (inclusive). The default is the maximum allowed value of 24. |
page_ |
Optional. A page token received from a previous request. It is used to retrieve the subsequent page. |
hours |
Optional. Limits the amount of total hours to fetch starting from the last hour - a from 1 to 24 (inclusive). The default is the maximum allowed value of 24. |
language_ |
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". |
LookupHistoryHoursResponse
Response for the LookupHistoryHours RPC.
Fields | |
---|---|
history_ |
The hourly historical records, according to the number of hours and page size specified in the request. |
time_ |
The time zone at the requested location. |
next_ |
The token to retrieve the next page. |
MoonEvents
Represents the events related to the moon (e.g. moonrise, moonset).
Fields | |
---|---|
moonrise_ |
The time when the upper limb of the moon appears above the horizon (see https://en.wikipedia.org/wiki/Moonrise_and_moonset). NOTE: For most cases, there'll be a single moon rise time per day. In other cases, the list might be empty (e.g. when the moon rises after next day midnight). However, in unique cases (e.g. in polar regions), the list may contain more than one value. In these cases, the values are sorted in ascending order. |
moonset_ |
The time when the upper limb of the moon disappears below the horizon (see https://en.wikipedia.org/wiki/Moonrise_and_moonset). NOTE: For most cases, there'll be a single moon set time per day. In other cases, the list might be empty (e.g. when the moon sets after next day midnight). However, in unique cases (e.g. in polar regions), the list may contain more than one value. In these cases, the values are sorted in ascending order. |
moon_ |
The moon phase (a.k.a. lunar phase). |
MoonPhase
Marks the moon phase (a.k.a. lunar phase).
Enums | |
---|---|
MOON_PHASE_UNSPECIFIED |
Unspecified moon phase. |
NEW_MOON |
The moon is not illuminated by the sun. |
WAXING_CRESCENT |
The moon is lit by 0%-50% on its right side in the northern hemisphere 🌒 and on its left side in the southern hemisphere 🌘. |
FIRST_QUARTER |
The moon is lit by 50.1% on its right side in the northern hemisphere 🌓 and on its left side in the southern hemisphere 🌗. |
WAXING_GIBBOUS |
The moon is lit by 50%-100% on its right side in the northern hemisphere 🌔 and on its left side in the southern hemisphere 🌖. |
FULL_MOON |
The moon is fully illuminated. |
WANING_GIBBOUS |
The moon is lit by 50%-100% on its left side in the northern hemisphere 🌖 and on its right side in the southern hemisphere 🌔. |
LAST_QUARTER |
The moon is lit by 50.1% on its left side in the northern hemisphere 🌗 and on its right side in the southern hemisphere 🌓. |
WANING_CRESCENT |
The moon is lit by 0%-50% on its left side in the northern hemisphere 🌘 and on its right side in the southern hemisphere 🌒. |
Precipitation
Represents a set of precipitation values at a given location.
Fields | |
---|---|
probability |
The probability of precipitation (values from 0 to 100). |
qpf |
The amount of precipitation (rain or snow), measured as liquid water equivalent, that has accumulated over a period of time. Note: QPF is an abbreviation for Quantitative Precipitation Forecast (please see the QuantitativePrecipitationForecast definition for more details). |
PrecipitationProbability
Represents the probability of precipitation at a given location.
Fields | |
---|---|
type |
A code that indicates the type of precipitation. |
percent |
A percentage from 0 to 100 that indicates the chances of precipitation. |
PrecipitationType
Represents the type of precipitation at a given location.
Enums | |
---|---|
PRECIPITATION_TYPE_UNSPECIFIED |
Unspecified precipitation type. |
NONE |
No precipitation. |
SNOW |
Snow precipitation. |
RAIN |
Rain precipitation. |
LIGHT_RAIN |
Light rain precipitation. |
HEAVY_RAIN |
Heavy rain precipitation. |
RAIN_AND_SNOW |
Both rain and snow precipitations. |
SLEET |
Sleet precipitation. |
FREEZING_RAIN |
Freezing rain precipitation. |
QuantitativePrecipitationForecast
Represents the expected amount of melted precipitation accumulated over a specified time period over a specified area (reference: https://en.wikipedia.org/wiki/Quantitative_precipitation_forecast) - usually abbreviated QPF for short.
Fields | |
---|---|
unit |
The code of the unit used to measure the amount of accumulated precipitation. |
quantity |
The amount of precipitation, measured as liquid water equivalent, that has accumulated over a period of time. |
Unit
Represents the unit used to measure the amount of accumulated precipitation.
Enums | |
---|---|
UNIT_UNSPECIFIED |
Unspecified precipitation unit. |
MILLIMETERS |
The amount of precipitation is measured in millimeters. |
INCHES |
The amount of precipitation is measured in inches. |
SpeedUnit
Represents the unit used to measure speed.
Enums | |
---|---|
SPEED_UNIT_UNSPECIFIED |
The speed unit is unspecified. |
KILOMETERS_PER_HOUR |
The speed is measured in kilometers per hour. |
MILES_PER_HOUR |
The speed is measured in miles per hour. |
SunEvents
Represents the events related to the sun (e.g. sunrise, sunset).
Fields | |
---|---|
sunrise_ |
The time when the sun rises. NOTE: In some unique cases (e.g. north of the artic circle) there may be no sunrise time for a day. In these cases, this field will be unset. |
sunset_ |
The time when the sun sets. NOTE: In some unique cases (e.g. north of the artic circle) there may be no sunset time for a day. In these cases, this field will be unset. |
Temperature
Represents a temperature value.
Fields | |
---|---|
unit |
The code for the unit used to measure the temperature value. |
degrees |
The temperature value (in degrees) in the specified unit. |
TemperatureUnit
Represents a unit used to measure temperatures.
Enums | |
---|---|
TEMPERATURE_UNIT_UNSPECIFIED |
The temperature unit is unspecified. |
CELSIUS |
The temperature is measured in Celsius. |
FAHRENHEIT |
The temperature is measured in Fahrenheit. |
UnitsSystem
Represents the units system used to measure values.
Enums | |
---|---|
UNITS_SYSTEM_UNSPECIFIED |
The units system is unspecified. |
IMPERIAL |
The imperial units system (e.g. Fahrenheit, miles, etc). |
METRIC |
The metric units system (e.g. Celsius, kilometers, etc). |
Visibility
Represents visibility conditions, the distance at which objects can be discerned.
Fields | |
---|---|
unit |
The code that represents the unit used to measure the distance. |
distance |
The visibility distance in the specified unit. |
Unit
Represents the unit used to measure the visibility distance.
Enums | |
---|---|
UNIT_UNSPECIFIED |
The visibility unit is unspecified. |
KILOMETERS |
The visibility is measured in kilometers. |
MILES |
The visibility is measured in miles. |
WeatherCondition
Represents a weather condition for a given location at a given period of time.
Disclaimer: Weather icons and condition codes are subject to change. Google may introduce new codes and icons or update existing ones as needed. We encourage you to refer to this documentation regularly for the most up-to-date information.
Fields | |
---|---|
icon_ |
The base URI for the icon not including the file type extension. To display the icon, append a theme if desired and the file type extension ( |
description |
The textual description for this weather condition (localized). |
type |
The type of weather condition. |
Type
Marks the weather condition type in a forecast element's context.
Enums | |
---|---|
TYPE_UNSPECIFIED |
The weather condition is unspecified. |
CLEAR |
No clouds. |
MOSTLY_CLEAR |
Periodic clouds. |
PARTLY_CLOUDY |
Party cloudy (some clouds). |
MOSTLY_CLOUDY |
Mostly cloudy (more clouds than sun). |
CLOUDY |
Cloudy (all clouds, no sun). |
WINDY |
High wind. |
WIND_AND_RAIN |
High wind with precipitation. |
LIGHT_RAIN_SHOWERS |
Light intermittent rain. |
CHANCE_OF_SHOWERS |
Chance of intermittent rain. |
SCATTERED_SHOWERS |
Intermittent rain. |
RAIN_SHOWERS |
Showers are considered to be rainfall that has a shorter duration than rain, and is characterized by suddenness in terms of start and stop times, and rapid changes in intensity. |
HEAVY_RAIN_SHOWERS |
Intense showers. |
LIGHT_TO_MODERATE_RAIN |
Rain (light to moderate in quantity). |
MODERATE_TO_HEAVY_RAIN |
Rain (moderate to heavy in quantity). |
RAIN |
Moderate rain. |
LIGHT_RAIN |
Light rain. |
HEAVY_RAIN |
Heavy rain. |
RAIN_PERIODICALLY_HEAVY |
Rain periodically heavy. |
LIGHT_SNOW_SHOWERS |
Light snow that is falling at varying intensities for brief periods of time. |
CHANCE_OF_SNOW_SHOWERS |
Chance of snow showers. |
SCATTERED_SNOW_SHOWERS |
Snow that is falling at varying intensities for brief periods of time. |
SNOW_SHOWERS |
Snow showers. |
HEAVY_SNOW_SHOWERS |
Heavy snow showers. |
LIGHT_TO_MODERATE_SNOW |
Light to moderate snow. |
MODERATE_TO_HEAVY_SNOW |
Moderate to heavy snow. |
SNOW |
Moderate snow. |
LIGHT_SNOW |
Light snow. |
HEAVY_SNOW |
Heavy snow. |
SNOWSTORM |
Snow with possible thunder and lightning. |
SNOW_PERIODICALLY_HEAVY |
Snow, at times heavy. |
HEAVY_SNOW_STORM |
Heavy snow with possible thunder and lightning. |
BLOWING_SNOW |
Snow with intense wind. |
RAIN_AND_SNOW |
Rain and snow mix. |
HAIL |
Hail. |
HAIL_SHOWERS |
Hail that is falling at varying intensities for brief periods of time. |
THUNDERSTORM |
Thunderstorm. |
THUNDERSHOWER |
A shower of rain accompanied by thunder and lightning. |
LIGHT_THUNDERSTORM_RAIN |
Light thunderstorm rain. |
SCATTERED_THUNDERSTORMS |
Thunderstorms that has rain in various intensities for brief periods of time. |
HEAVY_THUNDERSTORM |
Heavy thunderstorm. |
Wind
Represents a set of wind properties.
Fields | |
---|---|
direction |
The direction of the wind, the angle it is coming from. |
speed |
The speed of the wind. |
gust |
The wind gust (sudden increase in the wind speed). |
WindDirection
Represents the direction from which the wind originates.
Fields | |
---|---|
cardinal |
The code that represents the cardinal direction from which the wind is blowing. |
degrees |
The direction of the wind in degrees (values from 0 to 360). |
WindSpeed
Represents the speed of the wind.
Fields | |
---|---|
unit |
The code that represents the unit used to measure the wind speed. |
value |
The value of the wind speed. |