AccuWeather (Independent Publisher) (Preview)
AccuWeather provides commercial weather forecasting services worldwide.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Troy Taylor |
URL | https://www.hitachisolutions.com |
ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
Publisher | Ahmad Najjar, Troy Taylor |
Website | https://www.accuweather.com/ |
Privacy policy | https://www.accuweather.com/en/privacy |
Categories | Data |
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
AccuWeather API Key | securestring | The app/subscription API key issued by AccuWeather | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Autocomplete search (Cities) |
Returns basic information about locations matching an autocomplete of the search text. |
Geoposition Search (Latitude and Longitude) |
Returns information about a specific location, by GeoPosition (Latitude and Longitude). |
Get 5 days of weather alarms |
Returns 5 days of weather alarms for a specific location. |
Get Admin Area List |
Returns basic information about administrative areas in the specified country. |
Get alerts by location key |
Returns alert data for a specific location. Alert searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the alert data is returned. The full object can be obtained by passing details=true. |
Get Country List |
Returns basic information about all countries within a specified region. |
Get Current Conditions |
Returns current conditions data for a specific location. Current conditions searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the current conditions data is returned. The full object can be obtained by passing "details=true" into the url string. |
Get Current Conditions for Top Cities |
Returns current conditions data for the top 50, 100, or 150 cities worldwide, based on rank. |
Get Daily Forecasts |
Returns daily forecast data for a specific location. |
Get Daily Index Values for a Group of Indices |
Returns daily index data for a specific group of indices, by location key. |
Get Daily Index Values for a Specific Index |
Returns daily index data for a specific index, by location key. Not all daily indices data are available for retrieval, check (https://developer.accuweather.com/list-available-daily-indices) |
Get Daily Index Values for for All Indices |
Returns daily index data for all indices, by location key. |
Get fifteen day of weather alarms |
Returns 15 days of weather alarms for a specific location. |
Get Historical Current Conditions (past 24 hours) |
Returns historical current conditions data for a specific location. Current conditions searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the current conditions data is returned. The full object can be obtained by passing "details=true" into the url string. |
Get Historical Current Conditions (past 6 hours) |
Returns historical current conditions data for a specific location. Current conditions searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the current conditions data is returned. The full object can be obtained by passing "details=true" into the url string. |
Get Hourly Forecasts |
Returns forecast data for the next hour(s) for a specific location. |
Get List of Daily Indices |
Returns metadata for all daily indices. |
Get List of Index Groups |
Returns metadata for all index groups. |
Get List of Indices in a Specific Group |
Returns metadata for all indices in a specified group. |
Get one day of weather alarms |
Returns 1 day of weather alarms for a specific location. |
Get radar and satellite imagery |
Returns links to radar and satellite images by location key. Imagery searches require a location key. Please use the Locations API to obtain a location key for your desired location. Radar images are not available for all locations worldwide at this time. If radar is not available for your desired location, satellite images are still provided. |
Get Region List |
Returns basic information about all regions. |
Get ten days of weather alarms |
Returns 10 days of weather alarms for a specific location. |
Get Top Cities List |
Returns information for the top 50, 100, or 150 cities, worldwide. |
List all languages |
Returns metadata for all languages. |
List the available translation groups |
Lists groups of phrases that are available for translation. |
List the translations for a specific group |
Returns all translated phrases for a specific group, in the desired language. |
Search by location key |
Returns information about a specific location, by location key. You must know the location key to perform this query. |
Search location by IP address |
Returns information about a specific location, by IP Address. |
Autocomplete search (Cities)
Returns basic information about locations matching an autocomplete of the search text.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
q | True | string |
Text to use for Autocomplete search. |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Version
|
Version | integer |
The version. |
Key
|
Key | string |
The key. |
Type
|
Type | string |
The type. |
Rank
|
Rank | integer |
The rank. |
Localized Name
|
LocalizedName | string |
The localized name. |
ID
|
Country.ID | string |
The identifier. |
Localized Name
|
Country.LocalizedName | string |
The localized name. |
ID
|
AdministrativeArea.ID | string |
The identifier. |
Localized Name
|
AdministrativeArea.LocalizedName | string |
The localized name. |
Geoposition Search (Latitude and Longitude)
Returns information about a specific location, by GeoPosition (Latitude and Longitude).
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Latitude,Longitude
|
q | True | string |
A comma-separated lat/long pair (lat,long). |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
|
Top Level
|
toplevel | boolean |
When toplevel=true, the city with the highest rank will be returned. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.) |
Returns
Name | Path | Type | Description |
---|---|---|---|
Version
|
Version | integer |
The version. |
Key
|
Key | string |
The key. |
Type
|
Type | string |
The type. |
Rank
|
Rank | integer |
The rank. |
Localized Name
|
LocalizedName | string |
The localized name. |
English Name
|
EnglishName | string |
The English name. |
Primary Postal Code
|
PrimaryPostalCode | string |
The primary postal code. |
ID
|
Region.ID | string |
The identifier. |
Localized Name
|
Region.LocalizedName | string |
The localized name. |
English Name
|
Region.EnglishName | string |
The English name. |
ID
|
Country.ID | string |
The identifier. |
Localized Name
|
Country.LocalizedName | string |
The localized name. |
English Name
|
Country.EnglishName | string |
The English name. |
ID
|
AdministrativeArea.ID | string |
The identifier. |
Localized Name
|
AdministrativeArea.LocalizedName | string |
The localized name. |
English Name
|
AdministrativeArea.EnglishName | string |
The English name. |
Level
|
AdministrativeArea.Level | integer |
The level. |
Localized Type
|
AdministrativeArea.LocalizedType | string |
The localized type. |
English Type
|
AdministrativeArea.EnglishType | string |
The English type. |
Country ID
|
AdministrativeArea.CountryID | string |
The country identifier. |
Code
|
TimeZone.Code | string |
The code. |
Name
|
TimeZone.Name | string |
The name. |
GMT Offset
|
TimeZone.GmtOffset | float |
The GMT offset. |
Is Daylight Saving
|
TimeZone.IsDaylightSaving | boolean |
Whether is daylight saving. |
Next Offset Change
|
TimeZone.NextOffsetChange | string |
The next offset change. |
Latitude
|
GeoPosition.Latitude | float |
The latitude. |
Longitude
|
GeoPosition.Longitude | float |
The longitude. |
Value
|
GeoPosition.Elevation.Metric.Value | float |
The value. |
Unit
|
GeoPosition.Elevation.Metric.Unit | string |
The unit. |
Unit Type
|
GeoPosition.Elevation.Metric.UnitType | integer |
The unit type. |
Value
|
GeoPosition.Elevation.Imperial.Value | float |
The value. |
Unit
|
GeoPosition.Elevation.Imperial.Unit | string |
The unit. |
Unit Type
|
GeoPosition.Elevation.Imperial.UnitType | integer |
The unit type. |
Is Alias
|
IsAlias | boolean |
Whether is alias. |
Key
|
ParentCity.Key | string |
The key. |
Localized Name
|
ParentCity.LocalizedName | string |
The localized name. |
English Name
|
ParentCity.EnglishName | string |
The English name. |
Supplemental Admin Areas
|
SupplementalAdminAreas | array of object | |
Level
|
SupplementalAdminAreas.Level | integer |
The level. |
Localized Name
|
SupplementalAdminAreas.LocalizedName | string |
The localized name. |
English Name
|
SupplementalAdminAreas.EnglishName | string |
The English name. |
Data Sets
|
DataSets | array of string |
The data sets. |
Key
|
Details.Key | string |
The key. |
Station Code
|
Details.StationCode | string |
The station code. |
Station GMT Offset
|
Details.StationGmtOffset | float |
The station GMT offset. |
Band Map
|
Details.BandMap | string |
The band map. |
Climo
|
Details.Climo | string |
The climo. |
Local Radar
|
Details.LocalRadar | string |
The local radar. |
Media Region
|
Details.MediaRegion | string |
The media region. |
Metar
|
Details.Metar | string |
The metar. |
NX Metro
|
Details.NXMetro | string |
The NX metro. |
NX State
|
Details.NXState | string |
The NX state. |
Population
|
Details.Population | integer |
The population. |
Primary Warning County Code
|
Details.PrimaryWarningCountyCode | string |
The primary warning county code. |
Primary Warning Zone Code
|
Details.PrimaryWarningZoneCode | string |
The primary warning zone code. |
Satellite
|
Details.Satellite | string |
The satellite. |
Synoptic
|
Details.Synoptic | string |
The synoptic. |
Marine Station
|
Details.MarineStation | string |
The marine station. |
Marine Station GMT Offset
|
Details.MarineStationGMTOffset | float |
The marine station GMT offset. |
Video Code
|
Details.VideoCode | string |
The video code. |
Location Stem
|
Details.LocationStem | string |
The location stem. |
ID
|
Details.DMA.ID | string |
The identifier. |
English Name
|
Details.DMA.EnglishName | string |
The English name. |
Partner ID
|
Details.PartnerID | string |
The partner identifier. |
Sources
|
Details.Sources | array of object | |
Data Type
|
Details.Sources.DataType | string |
The data type. |
Source
|
Details.Sources.Source | string |
The source. |
Source ID
|
Details.Sources.SourceId | integer |
The source identifier. |
Canonical Postal Code
|
Details.CanonicalPostalCode | string |
The canonical postal code. |
Canonical Location Key
|
Details.CanonicalLocationKey | string |
The canonical location key. |
Get 5 days of weather alarms
Returns 5 days of weather alarms for a specific location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | string |
The unique ID used to search for a specific location. |
Language
|
language | string |
The string indicating the language in which to return the resource. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Date
|
Date | string |
The date for which the alarm exists, displayed in ISO8601 format. |
Epoch Date
|
EpochDate | integer |
Date of the forecast, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT). |
Alarms
|
Alarms | array of object | |
Alarm Type
|
Alarms.AlarmType | string |
Type of alarm in effect: Rain, Ice, Snow, Wind, WindGust, or Thunderstorm. |
Value
|
Alarms.Value.Metric.Value | float |
The value. |
Unit
|
Alarms.Value.Metric.Unit | string |
The unit. |
Unit Type
|
Alarms.Value.Metric.UnitType | integer |
The unit type. |
Value
|
Alarms.Value.Imperial.Value | float |
The value. |
Unit
|
Alarms.Value.Imperial.Unit | string |
The unit. |
Unit Type
|
Alarms.Value.Imperial.UnitType | integer |
The unit type. |
Value
|
Alarms.Day.Metric.Value | float |
The value. |
Unit
|
Alarms.Day.Metric.Unit | string |
The unit. |
Unit Type
|
Alarms.Day.Metric.UnitType | integer |
The unit type. |
Value
|
Alarms.Day.Imperial.Value | float |
The value. |
Unit
|
Alarms.Day.Imperial.Unit | string |
The unit. |
Unit Type
|
Alarms.Day.Imperial.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
Link to the daily forecast for the requested location on AccuWeather`s mobile site. |
Link
|
Link | string |
Link to the daily forecast for the requested location on AccuWeather`s web site. |
Get Admin Area List
Returns basic information about administrative areas in the specified country.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Country Code
|
countryCode | True | string |
The country code to return administrative areas for |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Offset
|
offset | integer |
Integer, along with the limit (25) that determines the first resource to be returned. If no offset is provided, the max number (100) of results will be returned. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
ID
|
ID | string |
The identifier. |
Localized Name
|
LocalizedName | string |
The localized name. |
English Name
|
EnglishName | string |
The English name. |
Level
|
Level | integer |
The level. |
Localized Type
|
LocalizedType | string |
The localized type. |
English Type
|
EnglishType | string |
The English type. |
Country ID
|
CountryID | string |
The country identifier. |
Get alerts by location key
Returns alert data for a specific location. Alert searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the alert data is returned. The full object can be obtained by passing details=true.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | string |
The unique ID used to search for a specific location. |
Language
|
language | string |
The string indicating the language in which to return the resource. |
|
Details
|
details | boolean |
Boolean value specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Country Code
|
CountryCode | string |
Unique country code ID. |
Alert ID
|
AlertID | integer |
Unique numeric id that identifies an alert for a particular country. |
Localized
|
Description.Localized | string |
Description of the alert in the local dialect set with language code in URL. Default is US English (en-us). |
English
|
Description.English | string |
Description of the alert in US English. |
Category
|
Category | string |
Category of the alert. |
Priority
|
Priority | integer |
Number signifying the importance or ranking order of the given alert within the country in which it has originated. A lower number signifies a higher priority. For example, 1 is the highest priority. |
Type
|
Type | string |
Abbreviated form of the alert description. |
Type ID
|
TypeId | string |
ID associated with the alert description. |
Class
|
Class | string |
Classification of the alert. Not available for all countries. |
Level
|
Level | string |
Severity identifier for the alert. Not available for all countries. |
Name
|
Color.Name | string |
Descriptive name of the color. |
Red
|
Color.Red | integer |
The red RGB component of the color. |
Green
|
Color.Green | integer |
The green RGB component of the color. |
Blue
|
Color.Blue | integer |
The blue RGB component of the color. |
Hex
|
Color.Hex | string |
The hexadecimal number that describes the color. |
Source
|
Source | string |
Provider of the alert data. |
Source ID
|
SourceId | integer |
ID associated with the provider of the alert data. |
Disclaimer
|
Disclaimer | string |
Disclaimer that must be displayed with the alert data. |
Name
|
Area.Name | string |
Name of the area that encompasses the location that was requested and falls under the current alert. |
Start Time
|
Area.StartTime | string |
Start time of the alert, displayed in ISO8601 format. |
Epoch Start Time
|
Area.EpochStartTime | integer |
Start time of the alert, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT). May be NULL. |
End Time
|
Area.EndTime | string |
End time of the alert, displayed in ISO8601 format. |
Epoch End Time
|
Area.EpochEndTime | integer |
End time of the alert, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT). May be NULL. |
Localized
|
Area.LastAction.Localized | string |
Status of the alert in the local dialect set with language code in URL. Default is US English (en-us). |
English
|
Area.LastAction.English | string |
Status of the alert in US English. |
Text
|
Area.Text | string |
Full text associated with the alert. |
Language Code
|
Area.LanguageCode | string |
Language of the alert text. |
Summary
|
Area.Summary | string |
Alert summary, in English. |
Mobile Link
|
MobileLink | string |
Link to the daily forecast for the requested location on AccuWeather`s mobile site. |
Link
|
Link | string |
Link to the daily forecast for the requested location on AccuWeather`s web site. |
Get Country List
Returns basic information about all countries within a specified region.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Region Code
|
regionCode | True | string |
The region code to return country list for |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
ID
|
ID | string |
The identifier. |
Localized Name
|
LocalizedName | string |
The localized name. |
English Name
|
EnglishName | string |
The English name. |
Get Current Conditions
Returns current conditions data for a specific location. Current conditions searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the current conditions data is returned. The full object can be obtained by passing "details=true" into the url string.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | string |
Unique ID used to search for a specific location. |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Local Observation Date Time
|
LocalObservationDateTime | string |
The local observation date time. |
Epoch Time
|
EpochTime | integer |
The epoch time. |
Weather Text
|
WeatherText | string |
The weather text. |
Weather Icon
|
WeatherIcon | integer |
The weather icon. |
Has Precipitation
|
HasPrecipitation | boolean |
Whether has precipitation. |
Precipitation Type
|
PrecipitationType | string |
The precipitation type. |
Is Day Time
|
IsDayTime | boolean |
Whether is day time. |
Value
|
Temperature.Metric.Value | float |
The value. |
Unit
|
Temperature.Metric.Unit | string |
The unit. |
Unit Type
|
Temperature.Metric.UnitType | integer |
The unit type. |
Value
|
Temperature.Imperial.Value | float |
The value. |
Unit
|
Temperature.Imperial.Unit | string |
The unit. |
Unit Type
|
Temperature.Imperial.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperature.Metric.Value | float |
The value. |
Unit
|
RealFeelTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperature.Imperial.Value | float |
The value. |
Unit
|
RealFeelTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperatureShade.Metric.Value | float |
The value. |
Unit
|
RealFeelTemperatureShade.Metric.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperatureShade.Metric.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperatureShade.Imperial.Value | float |
The value. |
Unit
|
RealFeelTemperatureShade.Imperial.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperatureShade.Imperial.UnitType | integer |
The unit type. |
Relative Humidity
|
RelativeHumidity | integer |
The relative humidity. |
Indoor Relative Humidity
|
IndoorRelativeHumidity | integer |
The indoor relative humidity. |
Value
|
DewPoint.Metric.Value | float |
The value. |
Unit
|
DewPoint.Metric.Unit | string |
The unit. |
Unit Type
|
DewPoint.Metric.UnitType | integer |
The unit type. |
Value
|
DewPoint.Imperial.Value | float |
The value. |
Unit
|
DewPoint.Imperial.Unit | string |
The unit. |
Unit Type
|
DewPoint.Imperial.UnitType | integer |
The unit type. |
Degrees
|
Wind.Direction.Degrees | integer |
The degrees. |
Localized
|
Wind.Direction.Localized | string |
The localized. |
English
|
Wind.Direction.English | string |
The English. |
Value
|
Wind.Speed.Metric.Value | float |
The value. |
Unit
|
Wind.Speed.Metric.Unit | string |
The unit. |
Unit Type
|
Wind.Speed.Metric.UnitType | integer |
The unit type. |
Value
|
Wind.Speed.Imperial.Value | float |
The value. |
Unit
|
Wind.Speed.Imperial.Unit | string |
The unit. |
Unit Type
|
Wind.Speed.Imperial.UnitType | integer |
The unit type. |
Value
|
WindGust.Speed.Metric.Value | float |
The value. |
Unit
|
WindGust.Speed.Metric.Unit | string |
The unit. |
Unit Type
|
WindGust.Speed.Metric.UnitType | integer |
The unit type. |
Value
|
WindGust.Speed.Imperial.Value | float |
The value. |
Unit
|
WindGust.Speed.Imperial.Unit | string |
The unit. |
Unit Type
|
WindGust.Speed.Imperial.UnitType | integer |
The unit type. |
UV Index
|
UVIndex | integer |
The UV index. |
UV IndexText
|
UVIndexText | string |
The UV index text. |
Value
|
Visibility.Metric.Value | float |
The value. |
Unit
|
Visibility.Metric.Unit | string |
The unit. |
Unit Type
|
Visibility.Metric.UnitType | integer |
The unit type. |
Value
|
Visibility.Imperial.Value | float |
The value. |
Unit
|
Visibility.Imperial.Unit | string |
The unit. |
Unit Type
|
Visibility.Imperial.UnitType | integer |
The unit type. |
Obstructions To Visibility
|
ObstructionsToVisibility | string |
The obstructions to visibility. |
Cloud Cover
|
CloudCover | integer |
The cloud cover. |
Value
|
Ceiling.Metric.Value | float |
The value. |
Unit
|
Ceiling.Metric.Unit | string |
The unit. |
Unit Type
|
Ceiling.Metric.UnitType | integer |
The unit type. |
Value
|
Ceiling.Imperial.Value | float |
The value. |
Unit
|
Ceiling.Imperial.Unit | string |
The unit. |
Unit Type
|
Ceiling.Imperial.UnitType | integer |
The unit type. |
Value
|
Pressure.Metric.Value | float |
The value. |
Unit
|
Pressure.Metric.Unit | string |
The unit. |
Unit Type
|
Pressure.Metric.UnitType | integer |
The unit type. |
Value
|
Pressure.Imperial.Value | float |
The value. |
Unit
|
Pressure.Imperial.Unit | string |
The unit. |
Unit Type
|
Pressure.Imperial.UnitType | integer |
The unit type. |
Localized Text
|
PressureTendency.LocalizedText | string |
The localized text. |
Code
|
PressureTendency.Code | string |
The code. |
Value
|
Past24HourTemperatureDeparture.Metric.Value | float |
The value. |
Unit
|
Past24HourTemperatureDeparture.Metric.Unit | string |
The unit. |
Unit Type
|
Past24HourTemperatureDeparture.Metric.UnitType | integer |
The unit type. |
Value
|
Past24HourTemperatureDeparture.Imperial.Value | float |
The value. |
Unit
|
Past24HourTemperatureDeparture.Imperial.Unit | string |
The unit. |
Unit Type
|
Past24HourTemperatureDeparture.Imperial.UnitType | integer |
The unit type. |
Value
|
ApparentTemperature.Metric.Value | float |
The value. |
Unit
|
ApparentTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
ApparentTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
ApparentTemperature.Imperial.Value | float |
The value. |
Unit
|
ApparentTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
ApparentTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
WindChillTemperature.Metric.Value | float |
The value. |
Unit
|
WindChillTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
WindChillTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
WindChillTemperature.Imperial.Value | float |
The value. |
Unit
|
WindChillTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
WindChillTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
WetBulbTemperature.Metric.Value | float |
The value. |
Unit
|
WetBulbTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
WetBulbTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
WetBulbTemperature.Imperial.Value | float |
The value. |
Unit
|
WetBulbTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
WetBulbTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
Precip1hr.Metric.Value | float |
The value. |
Unit
|
Precip1hr.Metric.Unit | string |
The unit. |
Unit Type
|
Precip1hr.Metric.UnitType | integer |
The unit type. |
Value
|
Precip1hr.Imperial.Value | float |
The value. |
Unit
|
Precip1hr.Imperial.Unit | string |
The unit. |
Unit Type
|
Precip1hr.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Precipitation.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Precipitation.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Precipitation.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Precipitation.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Precipitation.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Precipitation.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.PastHour.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.PastHour.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.PastHour.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.PastHour.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.PastHour.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.PastHour.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past3Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past3Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past3Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past3Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past3Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past3Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past6Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past6Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past6Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past6Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past6Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past6Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past9Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past9Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past9Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past9Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past9Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past9Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past12Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past12Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past12Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past12Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past12Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past12Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past18Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past18Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past18Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past18Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past18Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past18Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past24Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past24Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past24Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past24Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past24Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past24Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
The mobile link. |
Link
|
Link | string |
The link. |
Get Current Conditions for Top Cities
Returns current conditions data for the top 50, 100, or 150 cities worldwide, based on rank.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group
|
group | True | integer |
Group size, indicating how many cities to return. Valid values are 50, 100, or 150. |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Key
|
Key | string |
The key. |
Localized Name
|
LocalizedName | string |
The localized name. |
English Name
|
EnglishName | string |
The English name. |
ID
|
Country.ID | string |
The identifier. |
Localized Name
|
Country.LocalizedName | string |
The localized name. |
English Name
|
Country.EnglishName | string |
The English name. |
Code
|
TimeZone.Code | string |
The code. |
Name
|
TimeZone.Name | string |
The name. |
GMT Offset
|
TimeZone.GmtOffset | float |
The GMT offset. |
Is Daylight Saving
|
TimeZone.IsDaylightSaving | boolean |
Whether is daylight saving. |
Next Offset Change
|
TimeZone.NextOffsetChange | string |
The next offset change. |
Latitude
|
GeoPosition.Latitude | float |
The latitude. |
Longitude
|
GeoPosition.Longitude | float |
The longitude. |
Value
|
GeoPosition.Elevation.Metric.Value | float |
The value. |
Unit
|
GeoPosition.Elevation.Metric.Unit | string |
The unit. |
Unit Type
|
GeoPosition.Elevation.Metric.UnitType | integer |
The unit type. |
Value
|
GeoPosition.Elevation.Imperial.Value | float |
The value. |
Unit
|
GeoPosition.Elevation.Imperial.Unit | string |
The unit. |
Unit Type
|
GeoPosition.Elevation.Imperial.UnitType | integer |
The unit type. |
Local Observation Date Time
|
LocalObservationDateTime | string |
The local observation date time. |
Epoch Time
|
EpochTime | integer |
The epoch time. |
Weather Text
|
WeatherText | string |
The weather text. |
Weather Icon
|
WeatherIcon | integer |
The weather icon. |
Has Precipitation
|
HasPrecipitation | boolean |
Whether has precipitation. |
Precipitation Type
|
PrecipitationType | string |
The precipitation type. |
Is Day Time
|
IsDayTime | boolean |
Whether is day time. |
Value
|
Temperature.Metric.Value | float |
The value. |
Unit
|
Temperature.Metric.Unit | string |
The unit. |
Unit Type
|
Temperature.Metric.UnitType | integer |
The unit type. |
Value
|
Temperature.Imperial.Value | float |
The value. |
Unit
|
Temperature.Imperial.Unit | string |
The unit. |
Unit Type
|
Temperature.Imperial.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
The mobile link. |
Link
|
Link | string |
The link. |
ID
|
LocalSource.Id | integer |
The identifier. |
Name
|
LocalSource.Name | string |
The name. |
Weather Code
|
LocalSource.WeatherCode | string |
The weather code. |
Get Daily Forecasts
Returns daily forecast data for a specific location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Duration (days)
|
duration | True | integer |
Time interval (duration) |
Location Key
|
locationKey | True | integer |
Unique ID used to search for a specific location. |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
|
Metric
|
metric | boolean |
Specifies whether or not to display metric values. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Effective Date
|
Headline.EffectiveDate | string |
The effective date. |
Effective Epoch Date
|
Headline.EffectiveEpochDate | integer |
The effective epoch date. |
Severity
|
Headline.Severity | integer |
The severity. |
Text
|
Headline.Text | string |
The text. |
Category
|
Headline.Category | string |
The category. |
End Date
|
Headline.EndDate | string |
The end date. |
End Epoch Date
|
Headline.EndEpochDate | integer |
The end epoch date. |
Mobile Link
|
Headline.MobileLink | string |
The mobile link. |
Link
|
Headline.Link | string |
The link. |
Daily Forecasts
|
DailyForecasts | array of object | |
Date
|
DailyForecasts.Date | string |
The date. |
Epoch Date
|
DailyForecasts.EpochDate | integer |
The epoch date. |
Rise
|
DailyForecasts.Sun.Rise | string |
The rise. |
Epoch Rise
|
DailyForecasts.Sun.EpochRise | integer |
The epoch rise. |
Set
|
DailyForecasts.Sun.Set | string |
The set. |
Epoch Set
|
DailyForecasts.Sun.EpochSet | integer |
The epoch set. |
Rise
|
DailyForecasts.Moon.Rise | string |
The rise. |
Epoch Rise
|
DailyForecasts.Moon.EpochRise | integer |
The epoch rise. |
Set
|
DailyForecasts.Moon.Set | string |
The set. |
Epoch Set
|
DailyForecasts.Moon.EpochSet | integer |
The epoch set. |
Phase
|
DailyForecasts.Moon.Phase | string |
The phase. |
Age
|
DailyForecasts.Moon.Age | integer |
The age. |
Value
|
DailyForecasts.Temperature.Minimum.Value | float |
The value. |
Unit
|
DailyForecasts.Temperature.Minimum.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Temperature.Minimum.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Temperature.Maximum.Value | float |
The value. |
Unit
|
DailyForecasts.Temperature.Maximum.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Temperature.Maximum.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.RealFeelTemperature.Minimum.Value | float |
The value. |
Unit
|
DailyForecasts.RealFeelTemperature.Minimum.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.RealFeelTemperature.Minimum.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.RealFeelTemperature.Maximum.Value | float |
The value. |
Unit
|
DailyForecasts.RealFeelTemperature.Maximum.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.RealFeelTemperature.Maximum.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.RealFeelTemperatureShade.Minimum.Value | float |
The value. |
Unit
|
DailyForecasts.RealFeelTemperatureShade.Minimum.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.RealFeelTemperatureShade.Minimum.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.RealFeelTemperatureShade.Maximum.Value | float |
The value. |
Unit
|
DailyForecasts.RealFeelTemperatureShade.Maximum.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.RealFeelTemperatureShade.Maximum.UnitType | integer |
The unit type. |
Hours Of Sun
|
DailyForecasts.HoursOfSun | float |
The hours of sun. |
Value
|
DailyForecasts.DegreeDaySummary.Heating.Value | float |
The value. |
Unit
|
DailyForecasts.DegreeDaySummary.Heating.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.DegreeDaySummary.Heating.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.DegreeDaySummary.Cooling.Value | float |
The value. |
Unit
|
DailyForecasts.DegreeDaySummary.Cooling.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.DegreeDaySummary.Cooling.UnitType | integer |
The unit type. |
Air And Pollen
|
DailyForecasts.AirAndPollen | array of object | |
Name
|
DailyForecasts.AirAndPollen.Name | string |
The name. |
Value
|
DailyForecasts.AirAndPollen.Value | float |
The value. |
Category
|
DailyForecasts.AirAndPollen.Category | string |
The category. |
Category Value
|
DailyForecasts.AirAndPollen.CategoryValue | integer |
The category value. |
Type
|
DailyForecasts.AirAndPollen.Type | string |
The type. |
Icon
|
DailyForecasts.Day.Icon | integer |
The icon. |
Icon Phrase
|
DailyForecasts.Day.IconPhrase | string |
The icon phase. |
Has Precipitation
|
DailyForecasts.Day.HasPrecipitation | boolean |
Whether has precipitation. |
Short Phrase
|
DailyForecasts.Day.ShortPhrase | string |
The short phase. |
Long Phrase
|
DailyForecasts.Day.LongPhrase | string |
The long phase. |
Precipitation Probability
|
DailyForecasts.Day.PrecipitationProbability | integer |
The precipitation probability. |
Thunderstorm Probability
|
DailyForecasts.Day.ThunderstormProbability | integer |
The thunderstorm probability. |
Rain Probability
|
DailyForecasts.Day.RainProbability | integer |
The rain probability. |
Snow Probability
|
DailyForecasts.Day.SnowProbability | integer |
The snow probability. |
Ice Probability
|
DailyForecasts.Day.IceProbability | integer |
The ice probability. |
Value
|
DailyForecasts.Day.Wind.Speed.Value | float |
The value. |
Unit
|
DailyForecasts.Day.Wind.Speed.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Day.Wind.Speed.UnitType | integer |
The unit type. |
Degrees
|
DailyForecasts.Day.Wind.Direction.Degrees | integer |
The degrees. |
Localized
|
DailyForecasts.Day.Wind.Direction.Localized | string |
The localized. |
English
|
DailyForecasts.Day.Wind.Direction.English | string |
The English. |
Value
|
DailyForecasts.Day.WindGust.Speed.Value | float |
The value. |
Unit
|
DailyForecasts.Day.WindGust.Speed.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Day.WindGust.Speed.UnitType | integer |
The unit type. |
Degrees
|
DailyForecasts.Day.WindGust.Direction.Degrees | integer |
The degrees. |
Localized
|
DailyForecasts.Day.WindGust.Direction.Localized | string |
The localized. |
English
|
DailyForecasts.Day.WindGust.Direction.English | string |
The English. |
Value
|
DailyForecasts.Day.TotalLiquid.Value | float |
The value. |
Unit
|
DailyForecasts.Day.TotalLiquid.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Day.TotalLiquid.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Day.Rain.Value | float |
The value. |
Unit
|
DailyForecasts.Day.Rain.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Day.Rain.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Day.Snow.Value | float |
The value. |
Unit
|
DailyForecasts.Day.Snow.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Day.Snow.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Day.Ice.Value | float |
The value. |
Unit
|
DailyForecasts.Day.Ice.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Day.Ice.UnitType | integer |
The unit type. |
Hours Of Precipitation
|
DailyForecasts.Day.HoursOfPrecipitation | float |
The hours of precipitation. |
Hours Of Rain
|
DailyForecasts.Day.HoursOfRain | float |
The hours of rain. |
Hours Of Snow
|
DailyForecasts.Day.HoursOfSnow | float |
The hours of snow. |
Hours Of Ice
|
DailyForecasts.Day.HoursOfIce | float |
The hours of ice. |
Cloud Cover
|
DailyForecasts.Day.CloudCover | float |
The cloud cover. |
Value
|
DailyForecasts.Day.Evapotranspiration.Value | float |
The value. |
Unit
|
DailyForecasts.Day.Evapotranspiration.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Day.Evapotranspiration.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Day.SolarIrradiance.Value | float |
The value. |
Unit
|
DailyForecasts.Day.SolarIrradiance.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Day.SolarIrradiance.UnitType | integer |
The unit type. |
Icon
|
DailyForecasts.Night.Icon | integer |
The icon. |
Icon Phrase
|
DailyForecasts.Night.IconPhrase | string |
The icon phase. |
Has Precipitation
|
DailyForecasts.Night.HasPrecipitation | boolean |
Whether has precipitation. |
Short Phrase
|
DailyForecasts.Night.ShortPhrase | string |
The short phase. |
Long Phrase
|
DailyForecasts.Night.LongPhrase | string |
The long phase. |
Precipitation Probability
|
DailyForecasts.Night.PrecipitationProbability | integer |
The precipitation probability. |
Thunderstorm Probability
|
DailyForecasts.Night.ThunderstormProbability | integer |
The thunderstorm probability. |
Rain Probability
|
DailyForecasts.Night.RainProbability | integer |
The rain probability. |
Snow Probability
|
DailyForecasts.Night.SnowProbability | integer |
The snow probability. |
Ice Probability
|
DailyForecasts.Night.IceProbability | integer |
The ice probability. |
Value
|
DailyForecasts.Night.Wind.Speed.Value | float |
The value. |
Unit
|
DailyForecasts.Night.Wind.Speed.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Night.Wind.Speed.UnitType | integer |
The unit type. |
Degrees
|
DailyForecasts.Night.Wind.Direction.Degrees | integer |
The degrees. |
Localized
|
DailyForecasts.Night.Wind.Direction.Localized | string |
The localized. |
English
|
DailyForecasts.Night.Wind.Direction.English | string |
The English. |
Value
|
DailyForecasts.Night.WindGust.Speed.Value | float |
The value. |
Unit
|
DailyForecasts.Night.WindGust.Speed.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Night.WindGust.Speed.UnitType | integer |
The unit type. |
Degrees
|
DailyForecasts.Night.WindGust.Direction.Degrees | integer |
The degrees. |
Localized
|
DailyForecasts.Night.WindGust.Direction.Localized | string |
The localized. |
English
|
DailyForecasts.Night.WindGust.Direction.English | string |
The English. |
Value
|
DailyForecasts.Night.TotalLiquid.Value | float |
The value. |
Unit
|
DailyForecasts.Night.TotalLiquid.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Night.TotalLiquid.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Night.Rain.Value | float |
The value. |
Unit
|
DailyForecasts.Night.Rain.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Night.Rain.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Night.Snow.Value | float |
The value. |
Unit
|
DailyForecasts.Night.Snow.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Night.Snow.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Night.Ice.Value | float |
The value. |
Unit
|
DailyForecasts.Night.Ice.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Night.Ice.UnitType | integer |
The unit type. |
Hours Of Precipitation
|
DailyForecasts.Night.HoursOfPrecipitation | float |
The hours of precipitation. |
Hours Of Rain
|
DailyForecasts.Night.HoursOfRain | float |
The hours of rain. |
Hours Of Snow
|
DailyForecasts.Night.HoursOfSnow | float |
The hours of snow. |
Hours Of Ice
|
DailyForecasts.Night.HoursOfIce | float |
The hours of ice. |
Cloud Cover
|
DailyForecasts.Night.CloudCover | integer |
The cloud cover. |
Value
|
DailyForecasts.Night.Evapotranspiration.Value | float |
The value. |
Unit
|
DailyForecasts.Night.Evapotranspiration.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Night.Evapotranspiration.UnitType | integer |
The unit type. |
Value
|
DailyForecasts.Night.SolarIrradiance.Value | float |
The value. |
Unit
|
DailyForecasts.Night.SolarIrradiance.Unit | string |
The unit. |
Unit Type
|
DailyForecasts.Night.SolarIrradiance.UnitType | integer |
The unit type. |
Sources
|
DailyForecasts.Sources | array of string |
Sources |
Mobile Link
|
DailyForecasts.MobileLink | string |
The mobile link. |
Link
|
DailyForecasts.Link | string |
The link. |
Get Daily Index Values for a Group of Indices
Returns daily index data for a specific group of indices, by location key.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Duration (days)
|
duration | True | integer |
Time interval (duration) |
Location Key
|
locationKey | True | integer |
Unique ID used to search for a specific location. |
Indices Group
|
groupId | True | string |
All index groups |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Name
|
Name | string |
The name. |
ID
|
ID | integer |
The identifier. |
Ascending
|
Ascending | boolean |
Whether ascending. |
Local Date Time
|
LocalDateTime | string |
The local date time. |
Epoch Date Time
|
EpochDateTime | integer |
The epoch day time. |
Value
|
Value | float |
The value. |
Category
|
Category | string |
The category. |
Category Value
|
CategoryValue | integer |
The category value. |
Text
|
Text | string |
The text. |
Mobile Link
|
MobileLink | string |
The mobile link. |
Link
|
Link | string |
The link. |
Get Daily Index Values for a Specific Index
Returns daily index data for a specific index, by location key. Not all daily indices data are available for retrieval, check (https://developer.accuweather.com/list-available-daily-indices)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Duration (days)
|
duration | True | integer |
Time interval (duration) |
Location Key
|
locationKey | True | integer |
Unique ID used to search for a specific location. |
Index
|
indexId | True | integer |
The index to get the values for. NOTE: Not all daily indices data are available for retrieval, Check: https://developer.accuweather.com/list-available-daily-indices |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Name
|
Name | string |
The name. |
ID
|
ID | integer |
The identifier. |
Ascending
|
Ascending | boolean |
Whether ascending. |
Local Date Time
|
LocalDateTime | string |
The local date time. |
Epoch Date Time
|
EpochDateTime | integer |
The epoch day time. |
Value
|
Value | float |
The value. |
Category
|
Category | string |
The category. |
Category Value
|
CategoryValue | integer |
The category value. |
Text
|
Text | string |
The text. |
Mobile Link
|
MobileLink | string |
The mobile link. |
Link
|
Link | string |
The link. |
Get Daily Index Values for for All Indices
Returns daily index data for all indices, by location key.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | integer |
Unique ID used to search for a specific location. |
Duration (days)
|
duration | True | integer |
Time interval (duration) |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Name
|
Name | string |
The name. |
ID
|
ID | integer |
The identifier. |
Ascending
|
Ascending | boolean |
Whether ascending. |
Local Date Time
|
LocalDateTime | string |
The local date time. |
Epoch Date Time
|
EpochDateTime | integer |
The epoch day time. |
Value
|
Value | float |
The value. |
Category
|
Category | string |
The category. |
Category Value
|
CategoryValue | integer |
The category value. |
Text
|
Text | string |
The text. |
Mobile Link
|
MobileLink | string |
The mobile link. |
Link
|
Link | string |
The link. |
Get fifteen day of weather alarms
Returns 15 days of weather alarms for a specific location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | string |
The unique ID used to search for a specific location. |
Language
|
language | string |
The string indicating the language in which to return the resource. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Date
|
Date | string |
The date for which the alarm exists, displayed in ISO8601 format. |
Epoch Date
|
EpochDate | integer |
Date of the forecast, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT). |
Alarms
|
Alarms | array of object | |
Alarm Type
|
Alarms.AlarmType | string |
Type of alarm in effect: Rain, Ice, Snow, Wind, WindGust, or Thunderstorm. |
Value
|
Alarms.Value.Metric.Value | float |
The value. |
Unit
|
Alarms.Value.Metric.Unit | string |
The unit. |
Unit Type
|
Alarms.Value.Metric.UnitType | integer |
The unit type. |
Value
|
Alarms.Value.Imperial.Value | float |
The value. |
Unit
|
Alarms.Value.Imperial.Unit | string |
The unit. |
Unit Type
|
Alarms.Value.Imperial.UnitType | integer |
The unit type. |
Value
|
Alarms.Day.Metric.Value | float |
The value. |
Unit
|
Alarms.Day.Metric.Unit | string |
The unit. |
Unit Type
|
Alarms.Day.Metric.UnitType | integer |
The unit type. |
Value
|
Alarms.Day.Imperial.Value | float |
The value. |
Unit
|
Alarms.Day.Imperial.Unit | string |
The unit. |
Unit Type
|
Alarms.Day.Imperial.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
Link to the daily forecast for the requested location on AccuWeather`s mobile site. |
Link
|
Link | string |
Link to the daily forecast for the requested location on AccuWeather`s web site. |
Get Historical Current Conditions (past 24 hours)
Returns historical current conditions data for a specific location. Current conditions searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the current conditions data is returned. The full object can be obtained by passing "details=true" into the url string.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | integer |
Unique ID used to search for a specific location. |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Local Observation Date Time
|
LocalObservationDateTime | string |
The local observation date time. |
Epoch Time
|
EpochTime | integer |
The epoch time. |
Weather Text
|
WeatherText | string |
The weather text. |
Weather Icon
|
WeatherIcon | integer |
The weather icon. |
Has Precipitation
|
HasPrecipitation | boolean |
Whether has precipitation. |
Precipitation Type
|
PrecipitationType | string |
The precipitation type. |
Is Day Time
|
IsDayTime | boolean |
Whether is day time. |
Value
|
Temperature.Metric.Value | float |
The value. |
Unit
|
Temperature.Metric.Unit | string |
The unit. |
Unit Type
|
Temperature.Metric.UnitType | integer |
The unit type. |
Value
|
Temperature.Imperial.Value | float |
The value. |
Unit
|
Temperature.Imperial.Unit | string |
The unit. |
Unit Type
|
Temperature.Imperial.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperature.Metric.Value | float |
The value. |
Unit
|
RealFeelTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperature.Imperial.Value | float |
The value. |
Unit
|
RealFeelTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperatureShade.Metric.Value | float |
The value. |
Unit
|
RealFeelTemperatureShade.Metric.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperatureShade.Metric.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperatureShade.Imperial.Value | float |
The value. |
Unit
|
RealFeelTemperatureShade.Imperial.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperatureShade.Imperial.UnitType | integer |
The unit type. |
Relative Humidity
|
RelativeHumidity | integer |
The relative humidity. |
Indoor Relative Humidity
|
IndoorRelativeHumidity | integer |
The indoor relative humidity. |
Value
|
DewPoint.Metric.Value | float |
The value. |
Unit
|
DewPoint.Metric.Unit | string |
The unit. |
Unit Type
|
DewPoint.Metric.UnitType | integer |
The unit type. |
Value
|
DewPoint.Imperial.Value | float |
The value. |
Unit
|
DewPoint.Imperial.Unit | string |
The unit. |
Unit Type
|
DewPoint.Imperial.UnitType | integer |
The unit type. |
Degrees
|
Wind.Direction.Degrees | integer |
The degrees. |
Localized
|
Wind.Direction.Localized | string |
The localized. |
English
|
Wind.Direction.English | string |
The English. |
Value
|
Wind.Speed.Metric.Value | float |
The value. |
Unit
|
Wind.Speed.Metric.Unit | string |
The unit. |
Unit Type
|
Wind.Speed.Metric.UnitType | integer |
The unit type. |
Value
|
Wind.Speed.Imperial.Value | float |
The value. |
Unit
|
Wind.Speed.Imperial.Unit | string |
The unit. |
Unit Type
|
Wind.Speed.Imperial.UnitType | integer |
The unit type. |
Value
|
WindGust.Speed.Metric.Value | float |
The value. |
Unit
|
WindGust.Speed.Metric.Unit | string |
The unit. |
Unit Type
|
WindGust.Speed.Metric.UnitType | integer |
The unit type. |
Value
|
WindGust.Speed.Imperial.Value | float |
The value. |
Unit
|
WindGust.Speed.Imperial.Unit | string |
The unit. |
Unit Type
|
WindGust.Speed.Imperial.UnitType | integer |
The unit type. |
UV Index
|
UVIndex | integer |
The UV index. |
UV IndexText
|
UVIndexText | string |
The UV index text. |
Value
|
Visibility.Metric.Value | float |
The value. |
Unit
|
Visibility.Metric.Unit | string |
The unit. |
Unit Type
|
Visibility.Metric.UnitType | integer |
The unit type. |
Value
|
Visibility.Imperial.Value | float |
The value. |
Unit
|
Visibility.Imperial.Unit | string |
The unit. |
Unit Type
|
Visibility.Imperial.UnitType | integer |
The unit type. |
Obstructions To Visibility
|
ObstructionsToVisibility | string |
The obstructions to visibility. |
Cloud Cover
|
CloudCover | integer |
The cloud cover. |
Value
|
Ceiling.Metric.Value | float |
The value. |
Unit
|
Ceiling.Metric.Unit | string |
The unit. |
Unit Type
|
Ceiling.Metric.UnitType | integer |
The unit type. |
Value
|
Ceiling.Imperial.Value | float |
The value. |
Unit
|
Ceiling.Imperial.Unit | string |
The unit. |
Unit Type
|
Ceiling.Imperial.UnitType | integer |
The unit type. |
Value
|
Pressure.Metric.Value | float |
The value. |
Unit
|
Pressure.Metric.Unit | string |
The unit. |
Unit Type
|
Pressure.Metric.UnitType | integer |
The unit type. |
Value
|
Pressure.Imperial.Value | float |
The value. |
Unit
|
Pressure.Imperial.Unit | string |
The unit. |
Unit Type
|
Pressure.Imperial.UnitType | integer |
The unit type. |
Localized Text
|
PressureTendency.LocalizedText | string |
The localized text. |
Code
|
PressureTendency.Code | string |
The code. |
Value
|
Past24HourTemperatureDeparture.Metric.Value | float |
The value. |
Unit
|
Past24HourTemperatureDeparture.Metric.Unit | string |
The unit. |
Unit Type
|
Past24HourTemperatureDeparture.Metric.UnitType | integer |
The unit type. |
Value
|
Past24HourTemperatureDeparture.Imperial.Value | float |
The value. |
Unit
|
Past24HourTemperatureDeparture.Imperial.Unit | string |
The unit. |
Unit Type
|
Past24HourTemperatureDeparture.Imperial.UnitType | integer |
The unit type. |
Value
|
ApparentTemperature.Metric.Value | float |
The value. |
Unit
|
ApparentTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
ApparentTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
ApparentTemperature.Imperial.Value | float |
The value. |
Unit
|
ApparentTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
ApparentTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
WindChillTemperature.Metric.Value | float |
The value. |
Unit
|
WindChillTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
WindChillTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
WindChillTemperature.Imperial.Value | float |
The value. |
Unit
|
WindChillTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
WindChillTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
WetBulbTemperature.Metric.Value | float |
The value. |
Unit
|
WetBulbTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
WetBulbTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
WetBulbTemperature.Imperial.Value | float |
The value. |
Unit
|
WetBulbTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
WetBulbTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
Precip1hr.Metric.Value | float |
The value. |
Unit
|
Precip1hr.Metric.Unit | string |
The unit. |
Unit Type
|
Precip1hr.Metric.UnitType | integer |
The unit type. |
Value
|
Precip1hr.Imperial.Value | float |
The value. |
Unit
|
Precip1hr.Imperial.Unit | string |
The unit. |
Unit Type
|
Precip1hr.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Precipitation.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Precipitation.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Precipitation.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Precipitation.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Precipitation.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Precipitation.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.PastHour.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.PastHour.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.PastHour.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.PastHour.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.PastHour.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.PastHour.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past3Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past3Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past3Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past3Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past3Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past3Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past6Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past6Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past6Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past6Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past6Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past6Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past9Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past9Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past9Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past9Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past9Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past9Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past12Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past12Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past12Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past12Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past12Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past12Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past18Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past18Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past18Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past18Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past18Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past18Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past24Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past24Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past24Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past24Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past24Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past24Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
The mobile link. |
Link
|
Link | string |
The link. |
Get Historical Current Conditions (past 6 hours)
Returns historical current conditions data for a specific location. Current conditions searches require a location key. Please use the Locations API to obtain the location key for your desired location. By default, a truncated version of the current conditions data is returned. The full object can be obtained by passing "details=true" into the url string.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | integer |
Unique ID used to search for a specific location. |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Local Observation Date Time
|
LocalObservationDateTime | string |
The local observation date time. |
Epoch Time
|
EpochTime | integer |
The epoch time. |
Weather Text
|
WeatherText | string |
The weather text. |
Weather Icon
|
WeatherIcon | integer |
The weather icon. |
Has Precipitation
|
HasPrecipitation | boolean |
Whether has precipitation. |
Precipitation Type
|
PrecipitationType | string |
The precipitation type. |
Is Day Time
|
IsDayTime | boolean |
Whether is day time. |
Value
|
Temperature.Metric.Value | float |
The value. |
Unit
|
Temperature.Metric.Unit | string |
The unit. |
Unit Type
|
Temperature.Metric.UnitType | integer |
The unit type. |
Value
|
Temperature.Imperial.Value | float |
The value. |
Unit
|
Temperature.Imperial.Unit | string |
The unit. |
Unit Type
|
Temperature.Imperial.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperature.Metric.Value | float |
The value. |
Unit
|
RealFeelTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperature.Imperial.Value | float |
The value. |
Unit
|
RealFeelTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperatureShade.Metric.Value | float |
The value. |
Unit
|
RealFeelTemperatureShade.Metric.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperatureShade.Metric.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperatureShade.Imperial.Value | float |
The value. |
Unit
|
RealFeelTemperatureShade.Imperial.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperatureShade.Imperial.UnitType | integer |
The unit type. |
Relative Humidity
|
RelativeHumidity | integer |
The relative humidity. |
Indoor Relative Humidity
|
IndoorRelativeHumidity | integer |
The indoor relative humidity. |
Value
|
DewPoint.Metric.Value | float |
The value. |
Unit
|
DewPoint.Metric.Unit | string |
The unit. |
Unit Type
|
DewPoint.Metric.UnitType | integer |
The unit type. |
Value
|
DewPoint.Imperial.Value | float |
The value. |
Unit
|
DewPoint.Imperial.Unit | string |
The unit. |
Unit Type
|
DewPoint.Imperial.UnitType | integer |
The unit type. |
Degrees
|
Wind.Direction.Degrees | integer |
The degrees. |
Localized
|
Wind.Direction.Localized | string |
The localized. |
English
|
Wind.Direction.English | string |
The English. |
Value
|
Wind.Speed.Metric.Value | float |
The value. |
Unit
|
Wind.Speed.Metric.Unit | string |
The unit. |
Unit Type
|
Wind.Speed.Metric.UnitType | integer |
The unit type. |
Value
|
Wind.Speed.Imperial.Value | float |
The value. |
Unit
|
Wind.Speed.Imperial.Unit | string |
The unit. |
Unit Type
|
Wind.Speed.Imperial.UnitType | integer |
The unit type. |
Value
|
WindGust.Speed.Metric.Value | float |
The value. |
Unit
|
WindGust.Speed.Metric.Unit | string |
The unit. |
Unit Type
|
WindGust.Speed.Metric.UnitType | integer |
The unit type. |
Value
|
WindGust.Speed.Imperial.Value | float |
The value. |
Unit
|
WindGust.Speed.Imperial.Unit | string |
The unit. |
Unit Type
|
WindGust.Speed.Imperial.UnitType | integer |
The unit type. |
UV Index
|
UVIndex | integer |
The UV index. |
UV IndexText
|
UVIndexText | string |
The UV index text. |
Value
|
Visibility.Metric.Value | float |
The value. |
Unit
|
Visibility.Metric.Unit | string |
The unit. |
Unit Type
|
Visibility.Metric.UnitType | integer |
The unit type. |
Value
|
Visibility.Imperial.Value | float |
The value. |
Unit
|
Visibility.Imperial.Unit | string |
The unit. |
Unit Type
|
Visibility.Imperial.UnitType | integer |
The unit type. |
Obstructions To Visibility
|
ObstructionsToVisibility | string |
The obstructions to visibility. |
Cloud Cover
|
CloudCover | integer |
The cloud cover. |
Value
|
Ceiling.Metric.Value | float |
The value. |
Unit
|
Ceiling.Metric.Unit | string |
The unit. |
Unit Type
|
Ceiling.Metric.UnitType | integer |
The unit type. |
Value
|
Ceiling.Imperial.Value | float |
The value. |
Unit
|
Ceiling.Imperial.Unit | string |
The unit. |
Unit Type
|
Ceiling.Imperial.UnitType | integer |
The unit type. |
Value
|
Pressure.Metric.Value | float |
The value. |
Unit
|
Pressure.Metric.Unit | string |
The unit. |
Unit Type
|
Pressure.Metric.UnitType | integer |
The unit type. |
Value
|
Pressure.Imperial.Value | float |
The value. |
Unit
|
Pressure.Imperial.Unit | string |
The unit. |
Unit Type
|
Pressure.Imperial.UnitType | integer |
The unit type. |
Localized Text
|
PressureTendency.LocalizedText | string |
The localized text. |
Code
|
PressureTendency.Code | string |
The code. |
Value
|
Past24HourTemperatureDeparture.Metric.Value | float |
The value. |
Unit
|
Past24HourTemperatureDeparture.Metric.Unit | string |
The unit. |
Unit Type
|
Past24HourTemperatureDeparture.Metric.UnitType | integer |
The unit type. |
Value
|
Past24HourTemperatureDeparture.Imperial.Value | float |
The value. |
Unit
|
Past24HourTemperatureDeparture.Imperial.Unit | string |
The unit. |
Unit Type
|
Past24HourTemperatureDeparture.Imperial.UnitType | integer |
The unit type. |
Value
|
ApparentTemperature.Metric.Value | float |
The value. |
Unit
|
ApparentTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
ApparentTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
ApparentTemperature.Imperial.Value | float |
The value. |
Unit
|
ApparentTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
ApparentTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
WindChillTemperature.Metric.Value | float |
The value. |
Unit
|
WindChillTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
WindChillTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
WindChillTemperature.Imperial.Value | float |
The value. |
Unit
|
WindChillTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
WindChillTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
WetBulbTemperature.Metric.Value | float |
The value. |
Unit
|
WetBulbTemperature.Metric.Unit | string |
The unit. |
Unit Type
|
WetBulbTemperature.Metric.UnitType | integer |
The unit type. |
Value
|
WetBulbTemperature.Imperial.Value | float |
The value. |
Unit
|
WetBulbTemperature.Imperial.Unit | string |
The unit. |
Unit Type
|
WetBulbTemperature.Imperial.UnitType | integer |
The unit type. |
Value
|
Precip1hr.Metric.Value | float |
The value. |
Unit
|
Precip1hr.Metric.Unit | string |
The unit. |
Unit Type
|
Precip1hr.Metric.UnitType | integer |
The unit type. |
Value
|
Precip1hr.Imperial.Value | float |
The value. |
Unit
|
Precip1hr.Imperial.Unit | string |
The unit. |
Unit Type
|
Precip1hr.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Precipitation.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Precipitation.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Precipitation.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Precipitation.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Precipitation.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Precipitation.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.PastHour.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.PastHour.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.PastHour.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.PastHour.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.PastHour.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.PastHour.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past3Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past3Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past3Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past3Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past3Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past3Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past6Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past6Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past6Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past6Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past6Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past6Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past9Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past9Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past9Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past9Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past9Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past9Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past12Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past12Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past12Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past12Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past12Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past12Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past18Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past18Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past18Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past18Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past18Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past18Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past24Hours.Metric.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past24Hours.Metric.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past24Hours.Metric.UnitType | integer |
The unit type. |
Value
|
PrecipitationSummary.Past24Hours.Imperial.Value | float |
The value. |
Unit
|
PrecipitationSummary.Past24Hours.Imperial.Unit | string |
The unit. |
Unit Type
|
PrecipitationSummary.Past24Hours.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past6HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past12HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Minimum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Minimum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Minimum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Minimum.Imperial.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Maximum.Metric.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Maximum.Metric.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Maximum.Metric.UnitType | integer |
The unit type. |
Value
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.Value | float |
The value. |
Unit
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.Unit | string |
The unit. |
Unit Type
|
TemperatureSummary.Past24HourRange.Maximum.Imperial.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
The mobile link. |
Link
|
Link | string |
The link. |
Get Hourly Forecasts
Returns forecast data for the next hour(s) for a specific location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Duration (hours)
|
duration | True | integer |
Time interval (duration) |
Location Key
|
locationKey | True | integer |
Unique ID used to search for a specific location. |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
|
Metric
|
metric | boolean |
Specifies whether or not to display metric values. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Date Time
|
DateTime | string |
The date time. |
Epoch Date Time
|
EpochDateTime | integer |
The epoch date time. |
Weather Icon
|
WeatherIcon | integer |
The weather icon. |
Icon Phrase
|
IconPhrase | string |
The icon phase. |
Has Precipitation
|
HasPrecipitation | boolean |
Whether has precipitation. |
Is Daylight
|
IsDaylight | boolean |
Whether is daylight. |
Value
|
Temperature.Value | float |
The value. |
Unit
|
Temperature.Unit | string |
The unit. |
Unit Type
|
Temperature.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperature.Value | float |
The value. |
Unit
|
RealFeelTemperature.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperature.UnitType | integer |
The unit type. |
Value
|
RealFeelTemperatureShade.Value | float |
The value. |
Unit
|
RealFeelTemperatureShade.Unit | string |
The unit. |
Unit Type
|
RealFeelTemperatureShade.UnitType | integer |
The unit type. |
Value
|
WetBulbTemperature.Value | float |
The value. |
Unit
|
WetBulbTemperature.Unit | string |
The unit. |
Unit Type
|
WetBulbTemperature.UnitType | integer |
The unit type. |
Value
|
DewPoint.Value | float |
The value. |
Unit
|
DewPoint.Unit | string |
The unit. |
Unit Type
|
DewPoint.UnitType | integer |
The unit type. |
Value
|
Wind.Speed.Value | float |
The value. |
Unit
|
Wind.Speed.Unit | string |
The unit. |
Unit Type
|
Wind.Speed.UnitType | integer |
The unit type. |
Degrees
|
Wind.Direction.Degrees | integer |
The degrees. |
Localized
|
Wind.Direction.Localized | string |
The localized. |
English
|
Wind.Direction.English | string |
The English. |
Value
|
WindGust.Speed.Value | float |
The value. |
Unit
|
WindGust.Speed.Unit | string |
The unit. |
Unit Type
|
WindGust.Speed.UnitType | integer |
The unit type. |
Relative Humidity
|
RelativeHumidity | integer |
The relative humidity. |
Indoor Relative Humidity
|
IndoorRelativeHumidity | integer |
The indoor relative humidity. |
Value
|
Visibility.Value | float |
The value. |
Unit
|
Visibility.Unit | string |
The unit. |
Unit Type
|
Visibility.UnitType | integer |
The unit type. |
Value
|
Ceiling.Value | float |
The value. |
Unit
|
Ceiling.Unit | string |
The unit. |
Unit Type
|
Ceiling.UnitType | integer |
The unit type. |
UV Index
|
UVIndex | integer |
The UV index. |
UV IndexText
|
UVIndexText | string |
The UV index text. |
Precipitation Probability
|
PrecipitationProbability | integer |
The precipitation probability. |
Thunderstorm Probability
|
ThunderstormProbability | integer |
The thunderstorm probability. |
Rain Probability
|
RainProbability | integer |
The rain probability. |
Snow Probability
|
SnowProbability | integer |
The snow probability. |
Ice Probability
|
IceProbability | integer |
The ice probability. |
Value
|
TotalLiquid.Value | float |
The value. |
Unit
|
TotalLiquid.Unit | string |
The unit. |
Unit Type
|
TotalLiquid.UnitType | integer |
The unit type. |
Value
|
Rain.Value | float |
The value. |
Unit
|
Rain.Unit | string |
The unit. |
Unit Type
|
Rain.UnitType | integer |
The unit type. |
Value
|
Snow.Value | float |
The value. |
Unit
|
Snow.Unit | string |
The unit. |
Unit Type
|
Snow.UnitType | integer |
The unit type. |
Value
|
Ice.Value | float |
The value. |
Unit
|
Ice.Unit | string |
The unit. |
Unit Type
|
Ice.UnitType | integer |
The unit type. |
Cloud Cover
|
CloudCover | integer |
The cloud cover. |
Value
|
Evapotranspiration.Value | float |
The value. |
Unit
|
Evapotranspiration.Unit | string |
The unit. |
Unit Type
|
Evapotranspiration.UnitType | integer |
The unit type. |
Value
|
SolarIrradiance.Value | float |
The value. |
Unit
|
SolarIrradiance.Unit | string |
The unit. |
Unit Type
|
SolarIrradiance.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
The mobile link. |
Link
|
Link | string |
The link. |
Get List of Daily Indices
Returns metadata for all daily indices.
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Name
|
Name | string |
The name. |
ID
|
ID | integer |
The identifier. |
Ascending
|
Ascending | boolean |
Whether ascending. |
Description
|
Description | string |
The description. |
Get List of Index Groups
Returns metadata for all index groups.
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Name
|
Name | string |
The name. |
ID
|
ID | integer |
The identifier. |
Get List of Indices in a Specific Group
Returns metadata for all indices in a specified group.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
groupId | True | integer |
Index group ID |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Name
|
Name | string |
The name. |
ID
|
ID | integer |
The identifier. |
Ascending
|
Ascending | boolean |
Whether ascending. |
Description
|
Description | string |
The description. |
Get one day of weather alarms
Returns 1 day of weather alarms for a specific location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | string |
The unique ID used to search for a specific location. |
Language
|
language | string |
The string indicating the language in which to return the resource. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Date
|
Date | string |
The date for which the alarm exists, displayed in ISO8601 format. |
Epoch Date
|
EpochDate | integer |
Date of the forecast, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT). |
Alarms
|
Alarms | array of object | |
Alarm Type
|
Alarms.AlarmType | string |
Type of alarm in effect: Rain, Ice, Snow, Wind, WindGust, or Thunderstorm. |
Value
|
Alarms.Value.Metric.Value | float |
The value. |
Unit
|
Alarms.Value.Metric.Unit | string |
The unit. |
Unit Type
|
Alarms.Value.Metric.UnitType | integer |
The unit type. |
Value
|
Alarms.Value.Imperial.Value | float |
The value. |
Unit
|
Alarms.Value.Imperial.Unit | string |
The unit. |
Unit Type
|
Alarms.Value.Imperial.UnitType | integer |
The unit type. |
Value
|
Alarms.Day.Metric.Value | float |
The value. |
Unit
|
Alarms.Day.Metric.Unit | string |
The unit. |
Unit Type
|
Alarms.Day.Metric.UnitType | integer |
The unit type. |
Value
|
Alarms.Day.Imperial.Value | float |
The value. |
Unit
|
Alarms.Day.Imperial.Unit | string |
The unit. |
Unit Type
|
Alarms.Day.Imperial.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
Link to the daily forecast for the requested location on AccuWeather`s mobile site. |
Link
|
Link | string |
Link to the daily forecast for the requested location on AccuWeather`s web site. |
Get radar and satellite imagery
Returns links to radar and satellite images by location key. Imagery searches require a location key. Please use the Locations API to obtain a location key for your desired location. Radar images are not available for all locations worldwide at this time. If radar is not available for your desired location, satellite images are still provided.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Resolution
|
resolution | True | string |
The requested resolution. |
Location Key
|
locationKey | True | string |
The unique ID used to search for a specific location. |
Language
|
language | string |
The string indicating the language in which to return the resource. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Mobile Link
|
MobileLink | string |
Link to the daily forecast for the requested location on AccuWeather`s mobile site. |
Link
|
Link | string |
Link to the daily forecast for the requested location on AccuWeather`s web site. |
Size
|
Radar.Size | string |
The resolution of the image. |
Date
|
Radar.Images.Date | string |
The date/time of the image, displayed in ISO8601 format. |
URL
|
Radar.Images.Url | string |
The URL of the image. |
Size
|
Satellite.Size | string |
The resolution of the image. |
Date
|
Satellite.Images.Date | string |
The date/time of the image, displayed in ISO8601 format. |
URL
|
Satellite.Images.Url | string |
The URL of the image. |
Get Region List
Returns basic information about all regions.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Language
|
language | string |
String indicating the language in which to return the resource. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
ID
|
ID | string |
The identifier. |
Localized Name
|
LocalizedName | string |
The localized name. |
English Name
|
EnglishName | string |
The English name. |
Get ten days of weather alarms
Returns 10 days of weather alarms for a specific location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | string |
The unique ID used to search for a specific location. |
Language
|
language | string |
The string indicating the language in which to return the resource. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Date
|
Date | string |
The date for which the alarm exists, displayed in ISO8601 format. |
Epoch Date
|
EpochDate | integer |
Date of the forecast, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT). |
Alarms
|
Alarms | array of object | |
Alarm Type
|
Alarms.AlarmType | string |
Type of alarm in effect: Rain, Ice, Snow, Wind, WindGust, or Thunderstorm. |
Value
|
Alarms.Value.Metric.Value | float |
The value. |
Unit
|
Alarms.Value.Metric.Unit | string |
The unit. |
Unit Type
|
Alarms.Value.Metric.UnitType | integer |
The unit type. |
Value
|
Alarms.Value.Imperial.Value | float |
The value. |
Unit
|
Alarms.Value.Imperial.Unit | string |
The unit. |
Unit Type
|
Alarms.Value.Imperial.UnitType | integer |
The unit type. |
Value
|
Alarms.Day.Metric.Value | float |
The value. |
Unit
|
Alarms.Day.Metric.Unit | string |
The unit. |
Unit Type
|
Alarms.Day.Metric.UnitType | integer |
The unit type. |
Value
|
Alarms.Day.Imperial.Value | float |
The value. |
Unit
|
Alarms.Day.Imperial.Unit | string |
The unit. |
Unit Type
|
Alarms.Day.Imperial.UnitType | integer |
The unit type. |
Mobile Link
|
MobileLink | string |
Link to the daily forecast for the requested location on AccuWeather`s mobile site. |
Link
|
Link | string |
Link to the daily forecast for the requested location on AccuWeather`s web site. |
Get Top Cities List
Returns information for the top 50, 100, or 150 cities, worldwide.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group
|
group | True | integer |
The number of cities to return. |
Language
|
language | string |
String indicating the language in which to return the resource. (Default en-us) |
|
Details
|
details | boolean |
Specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Version
|
Version | integer |
The version. |
Key
|
Key | string |
The key. |
Type
|
Type | string |
The type. |
Rank
|
Rank | integer |
The rank. |
Localized Name
|
LocalizedName | string |
The localized name. |
English Name
|
EnglishName | string |
The English name. |
Primary Postal Code
|
PrimaryPostalCode | string |
The primary postal code. |
ID
|
Region.ID | string |
The identifier. |
Localized Name
|
Region.LocalizedName | string |
The localized name. |
English Name
|
Region.EnglishName | string |
The English name. |
ID
|
Country.ID | string |
The identifier. |
Localized Name
|
Country.LocalizedName | string |
The localized name. |
English Name
|
Country.EnglishName | string |
The English name. |
ID
|
AdministrativeArea.ID | string |
The identifier. |
Localized Name
|
AdministrativeArea.LocalizedName | string |
The localized name. |
English Name
|
AdministrativeArea.EnglishName | string |
The English name. |
Level
|
AdministrativeArea.Level | integer |
The level. |
Localized Type
|
AdministrativeArea.LocalizedType | string |
The localized type. |
English Type
|
AdministrativeArea.EnglishType | string |
The English type. |
Country ID
|
AdministrativeArea.CountryID | string |
The country identifier. |
Code
|
TimeZone.Code | string |
The code. |
Name
|
TimeZone.Name | string |
The name. |
GMT Offset
|
TimeZone.GmtOffset | float |
The GMT offset. |
Is Daylight Saving
|
TimeZone.IsDaylightSaving | boolean |
Whether is daylight saving. |
Next Offset Change
|
TimeZone.NextOffsetChange | string |
The next offset change. |
Latitude
|
GeoPosition.Latitude | float |
The latitude. |
Longitude
|
GeoPosition.Longitude | float |
The longitude. |
Value
|
GeoPosition.Elevation.Metric.Value | float |
The value. |
Unit
|
GeoPosition.Elevation.Metric.Unit | string |
The unit. |
Unit Type
|
GeoPosition.Elevation.Metric.UnitType | integer |
The unit type. |
Value
|
GeoPosition.Elevation.Imperial.Value | float |
The value. |
Unit
|
GeoPosition.Elevation.Imperial.Unit | string |
The unit. |
Unit Type
|
GeoPosition.Elevation.Imperial.UnitType | integer |
The unit type. |
Is Alias
|
IsAlias | boolean |
Whether is alias. |
Supplemental Admin Areas
|
SupplementalAdminAreas | array of string |
The supploement admin areas. |
Data Sets
|
DataSets | array of string |
The data sets. |
Key
|
Details.Key | string |
The key. |
Station Code
|
Details.StationCode | string |
The station code. |
Station GMT Offset
|
Details.StationGmtOffset | float |
The station GMT offset. |
Band Map
|
Details.BandMap | string |
The band map. |
Climo
|
Details.Climo | string |
The climo. |
Local Radar
|
Details.LocalRadar | string |
The local radar. |
Media Region
|
Details.MediaRegion | string |
The media region. |
Metar
|
Details.Metar | string |
The metar. |
NX Metro
|
Details.NXMetro | string |
The NX metro. |
NX State
|
Details.NXState | string |
The NX state. |
Population
|
Details.Population | integer |
The population. |
Primary Warning County Code
|
Details.PrimaryWarningCountyCode | string |
The primary warning country code. |
Primary Warning Zone Code
|
Details.PrimaryWarningZoneCode | string |
The primary warning zone code. |
Satellite
|
Details.Satellite | string |
The satellite. |
Synoptic
|
Details.Synoptic | string |
The synoptic. |
Marine Station
|
Details.MarineStation | string |
The marine station. |
Marine Station GMT Offset
|
Details.MarineStationGMTOffset | float |
The marine station GMT offset. |
Video Code
|
Details.VideoCode | string |
The video code. |
Location Stem
|
Details.LocationStem | string |
The location stem. |
Partner ID
|
Details.PartnerID | string |
The partner identifier. |
Sources
|
Details.Sources | array of object | |
Data Type
|
Details.Sources.DataType | string |
The data type. |
Source
|
Details.Sources.Source | string |
The source. |
Source ID
|
Details.Sources.SourceId | integer |
The source identifier. |
Partner Source URL
|
Details.Sources.PartnerSourceUrl | string |
The partner source URL address. |
Canonical Postal Code
|
Details.CanonicalPostalCode | string |
The canonical postal code. |
Canonical Location Key
|
Details.CanonicalLocationKey | string |
The canonical location key. |
List all languages
Returns metadata for all languages.
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
ID
|
ID | integer |
The identifier. |
Name
|
Name | string |
The name. |
Display Name
|
DisplayName | string |
The display name. |
Localized Name
|
LocalizedName | string |
The translated name. |
ISO
|
ISO | string |
The culture code. |
Language Type
|
LanguageType | integer |
The identifier for the language Type |
Microsoft Name
|
MicroSoftName | string |
The Microsoft display name of the language. |
Microsoft Code
|
MicroSoftCode | string |
The Microsoft culture code for the language. |
Timestamp
|
TimeStamp | string |
The time that the language information was pulled from the database. |
List the available translation groups
Lists groups of phrases that are available for translation.
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
ID
|
ID | integer |
The identifier. |
Name
|
Name | string |
The name. |
List the translations for a specific group
Returns all translated phrases for a specific group, in the desired language.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
groupID | True | string |
The string indicating the group ID in which to return the resource. |
Language
|
language | string |
The string indicating the language in which to return the resource. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Language Code
|
LanguageCode | string |
Culture code of the language, for which the phrase is translated. |
Phrase Code
|
PhraseCode | string |
Word (or phrase - without spaces) to use as a key for joining the translations. |
Text
|
Text | string |
Translated word or phrase. |
Data Code
|
DataCode | string |
Key to use for translation. |
Search by location key
Returns information about a specific location, by location key. You must know the location key to perform this query.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location Key
|
locationKey | True | string |
The key for the location being searched. |
Language
|
language | string |
String indicating the language in which to return the resource. |
|
Details
|
details | boolean |
Boolean value specifies whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Version
|
Version | integer |
The response version. |
Key
|
Key | string |
The location key. |
Type
|
Type | string |
The location type. |
Rank
|
Rank | integer |
The location rank. |
Localized Name
|
LocalizedName | string |
The localized name. |
English Name
|
EnglishName | string |
The English name. |
Primary Postal Code
|
PrimaryPostalCode | string |
The location postal code. |
Region ID
|
Region.ID | string |
The region ID. |
Region Localized Name
|
Region.LocalizedName | string |
The region localized name. |
Region English Name
|
Region.EnglishName | string |
The region English name. |
Country ID
|
Country.ID | string |
The country ID. |
Country Localized Name
|
Country.LocalizedName | string |
The country localized name. |
Country English Name
|
Country.EnglishName | string |
The country English name. |
Administrative Area ID
|
AdministrativeArea.ID | string |
The administrative area ID. |
Administrative Area Localized Name
|
AdministrativeArea.LocalizedName | string |
The administrative area name. |
Administrative Area English Name
|
AdministrativeArea.EnglishName | string |
The administrative area English name. |
Administrative Area Level
|
AdministrativeArea.Level | integer |
The administrative area level. |
Administrative Area Localized Type
|
AdministrativeArea.LocalizedType | string |
The administrative area localized type. |
Administrative Area English Type
|
AdministrativeArea.EnglishType | string |
The administrative area English type. |
Administrative Area Country ID
|
AdministrativeArea.CountryID | string |
The administrative area country ID. |
Time Zone Code
|
TimeZone.Code | string |
The time zone code. |
Time Zone Name
|
TimeZone.Name | string |
The time zone name. |
Time Zone GMT Offset
|
TimeZone.GmtOffset | integer |
The time zone GMT offset. |
Time Zone Is Daylight Saving
|
TimeZone.IsDaylightSaving | boolean |
Whether he time zone is Daylight Saving. |
Time Zone Next Offset Change
|
TimeZone.NextOffsetChange | string |
The time zone next offset change. |
Latitude
|
GeoPosition.Latitude | float |
The geoposition latitude. |
Longitude
|
GeoPosition.Longitude | float |
The geoposition longitude. |
Elevation Metric Value
|
GeoPosition.Elevation.Metric.Value | integer |
The elevation in metric value. |
Elevation Metric Unit
|
GeoPosition.Elevation.Metric.Unit | string |
The elevation in metric unit. |
Elevation Metric Unit Type
|
GeoPosition.Elevation.Metric.UnitType | integer |
The elevation in metric unit type. |
Elevation Imperial Value
|
GeoPosition.Elevation.Imperial.Value | integer |
The elevation in imperial value. |
Elevation Imperial Unit
|
GeoPosition.Elevation.Imperial.Unit | string |
The elevation in imperial unit. |
Elevation Imperial Unit Type
|
GeoPosition.Elevation.Imperial.UnitType | integer |
The elevation in imperial unit type. |
Is Alias
|
IsAlias | boolean |
Whether location is alias. |
SupplementalAdminAreas
|
SupplementalAdminAreas | array of object | |
Supplemental Administrative Level
|
SupplementalAdminAreas.Level | integer |
The supplemental administrative level. |
Supplemental Administrative Localized Name
|
SupplementalAdminAreas.LocalizedName | string |
The supplemental administrative localized name. |
Supplemental Administrative English Name
|
SupplementalAdminAreas.EnglishName | string |
The supplemental administrative English name. |
Data Sets
|
DataSets | array of string |
The data sets. |
Search location by IP address
Returns information about a specific location, by IP Address.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
IP Address
|
q | True | string |
A valid IP address to search for. |
language
|
language | string |
The language in which to return the resource. |
|
Details
|
details | boolean |
Whether or not to include full details in the response. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Version
|
Version | integer |
The response version. |
Key
|
Key | string |
The location key. |
Type
|
Type | string |
The location type. |
Rank
|
Rank | integer |
The location rank. |
Localized Name
|
LocalizedName | string |
The location localized name. |
English Name
|
EnglishName | string |
The location English name. |
Primary Postal Code
|
PrimaryPostalCode | string |
The location postal code. |
Region ID.
|
Region.ID | string |
The region ID. |
Region Localized Name
|
Region.LocalizedName | string |
The region localized name. |
Region English Name
|
Region.EnglishName | string |
The region English name. |
Country ID
|
Country.ID | string |
The country ID. |
Country Localized Name
|
Country.LocalizedName | string |
The country localized name. |
Country English Name
|
Country.EnglishName | string |
The country English name. |
Administrative Area ID
|
AdministrativeArea.ID | string |
The administrative area ID. |
Administrative Area Localized Name
|
AdministrativeArea.LocalizedName | string |
The administrative area localized name. |
Administrative Area English Name
|
AdministrativeArea.EnglishName | string |
The administrative area English name. |
Administrative Area Level
|
AdministrativeArea.Level | integer |
The administrative area level. |
Administrative Area Localized Type
|
AdministrativeArea.LocalizedType | string |
The administrative area localized type. |
Administrative Area English Type
|
AdministrativeArea.EnglishType | string |
The administrative area English type. |
Administrative Area Country ID
|
AdministrativeArea.CountryID | string |
The administrative area country ID. |
Time Zone Code
|
TimeZone.Code | string |
The time zone code. |
Time Zone Name
|
TimeZone.Name | string |
The time zone name. |
Time Zone GMT Offset
|
TimeZone.GmtOffset | integer |
The time zone GMT offset. |
Time Zone Is Daylight Saving
|
TimeZone.IsDaylightSaving | boolean |
Whether the time zone is Daylight Saving. |
Time Zone Next Offset Change
|
TimeZone.NextOffsetChange | string |
The time zone next offset change. |
Latitude
|
GeoPosition.Latitude | float |
The location latitude. |
Longitude
|
GeoPosition.Longitude | float |
The location longitude. |
Elevation Metric Value
|
GeoPosition.Elevation.Metric.Value | integer |
The elevation in metric. |
Elevation Metric Unit
|
GeoPosition.Elevation.Metric.Unit | string |
The elevation in metric unit. |
Elevation Metric Unit Type
|
GeoPosition.Elevation.Metric.UnitType | integer |
The elevation in metric unit type. |
Elevation Imperial Value
|
GeoPosition.Elevation.Imperial.Value | integer |
The elevation in imperial. |
Elevation Imperial Unit
|
GeoPosition.Elevation.Imperial.Unit | string |
The elevation in imperial unit. |
Elevation Imperial Unit Type
|
GeoPosition.Elevation.Imperial.UnitType | integer |
The elevation in imperial unit type. |
Is Alias
|
IsAlias | boolean |
Whether location is alias. |
SupplementalAdminAreas
|
SupplementalAdminAreas | array of object | |
Supplemental Administrative Area Level
|
SupplementalAdminAreas.Level | integer |
The supplemental administrative area level. |
Supplemental Administrative Area Localized Name
|
SupplementalAdminAreas.LocalizedName | string |
The supplemental administrative area localized name. |
Supplemental Administrative Area English Name
|
SupplementalAdminAreas.EnglishName | string |
The supplemental administrative area English name. |
Data Sets
|
DataSets | array of string |
The data sets. |
Details Key
|
Details.Key | string |
The details key. |
Details Station Code
|
Details.StationCode | string |
The details station code. |
Details Station GMT Offset
|
Details.StationGmtOffset | integer |
The details station GMT offset. |
Details Band Map
|
Details.BandMap | string |
The details band map. |
Details Climo
|
Details.Climo | string |
The details source of the climatology data. |
Details Local Radar
|
Details.LocalRadar | string |
The details local radar. |
Details Media Region
|
Details.MediaRegion | string |
The details media region. |
Details Metar
|
Details.Metar | string |
The details metar station. |
Details NX Metro
|
Details.NXMetro | string |
The details city level radar code. |
Details NX State
|
Details.NXState | string |
The details state level radar code. |
Details Population
|
Details.Population | integer |
The details population. |
Details Primary Warning County Code
|
Details.PrimaryWarningCountyCode | string |
The details primary warning county code. |
Details Primary Warning Zone Code
|
Details.PrimaryWarningZoneCode | string |
The details primary warning zone code. |
Details Satellite
|
Details.Satellite | string |
The details satellite. |
Details Synoptic
|
Details.Synoptic | string |
The details synoptic station. |
Details Marine Station
|
Details.MarineStation | string |
The details marine station. |
Details Marine Station GMT Offset
|
Details.MarineStationGMTOffset | string |
The details marine station GMT offset. |
Details Video Code
|
Details.VideoCode | string |
The details video code. |
Details Location Stem
|
Details.LocationStem | string |
The details location stem. |
Details DMA ID
|
Details.DMA.ID | string |
The details Designated Marketing Area ID. |
Details DMA English Name
|
Details.DMA.EnglishName | string |
The details Designated Marketing Area English name. |
Details Partner ID
|
Details.PartnerID | string |
The details partner ID. |
Sources
|
Details.Sources | array of object | |
Details Source Data Type
|
Details.Sources.DataType | string |
The details source data type. |
Details Source
|
Details.Sources.Source | string |
The details source. |
Details Source ID
|
Details.Sources.SourceId | integer |
The details source ID. |
Details Canonical Postal Code
|
Details.CanonicalPostalCode | string |
The details canonical postal code. |
Details Canonical Location Key
|
Details.CanonicalLocationKey | string |
The details canonical location key. |