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 Ahmad Najjar
Email ahmadn82@hotmail.com
Connector Metadata
Publisher Ahmad Najjar
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 connection10060 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 Admin Area List

Returns basic information about administrative areas in the specified country.

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 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 Region List

Returns basic information about all regions.

Get Top Cities List

Returns information for the top 50, 100, or 150 cities, worldwide.

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

Version

Key
Key string

Key

Type
Type string

Type

Rank
Rank integer

Rank

LocalizedName
LocalizedName string

Localized name

ID
Country.ID string

ID

LocalizedName
Country.LocalizedName string

Localized name

ID
AdministrativeArea.ID string

ID

LocalizedName
AdministrativeArea.LocalizedName string

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

Version

Key
Key string

Key

Type
Type string

Type

Rank
Rank integer

Rank

LocalizedName
LocalizedName string

Localized name

EnglishName
EnglishName string

English name

PrimaryPostalCode
PrimaryPostalCode string

Primary Postal Code

ID
Region.ID string

ID

LocalizedName
Region.LocalizedName string

Localized name

EnglishName
Region.EnglishName string

English name

ID
Country.ID string

ID

LocalizedName
Country.LocalizedName string

Localized name

EnglishName
Country.EnglishName string

English name

ID
AdministrativeArea.ID string

ID

LocalizedName
AdministrativeArea.LocalizedName string

Localized name

EnglishName
AdministrativeArea.EnglishName string

English name

Level
AdministrativeArea.Level integer

Level

LocalizedType
AdministrativeArea.LocalizedType string

Localized type

EnglishType
AdministrativeArea.EnglishType string

English type

CountryID
AdministrativeArea.CountryID string

Country Id

Code
TimeZone.Code string

Code

Name
TimeZone.Name string

Name

TimeZone.GmtOffset float

Gmt Offset

IsDaylightSaving
TimeZone.IsDaylightSaving boolean

Is Daylight Saving

NextOffsetChange
TimeZone.NextOffsetChange string

Next Offset Change

Latitude
GeoPosition.Latitude float

Latitude

Longitude
GeoPosition.Longitude float

Longitude

Value
GeoPosition.Elevation.Metric.Value double

Value

Unit
GeoPosition.Elevation.Metric.Unit string

Unit

UnitType
GeoPosition.Elevation.Metric.UnitType integer

Unit type

Value
GeoPosition.Elevation.Imperial.Value double

Value

Unit
GeoPosition.Elevation.Imperial.Unit string

Unit

UnitType
GeoPosition.Elevation.Imperial.UnitType integer

Unit type

IsAlias
IsAlias boolean

Is Alias

Key
ParentCity.Key string

Key

LocalizedName
ParentCity.LocalizedName string

Localized name

EnglishName
ParentCity.EnglishName string

English name

SupplementalAdminAreas
SupplementalAdminAreas array of object

Supplemental Admin Areas

Level
SupplementalAdminAreas.Level integer

Level

LocalizedName
SupplementalAdminAreas.LocalizedName string

Localized name

EnglishName
SupplementalAdminAreas.EnglishName string

English name

DataSets
DataSets array of string

Data Sets

Key
Details.Key string

Key

StationCode
Details.StationCode string

Station Code

Details.StationGmtOffset float

Station Gmt Offset

BandMap
Details.BandMap string

Band Map

Climo
Details.Climo string

Climo

LocalRadar
Details.LocalRadar string

Local Radar

MediaRegion
Details.MediaRegion string

Media Region

Metar
Details.Metar string

Metar

NXMetro
Details.NXMetro string

NX Metro

NXState
Details.NXState string

NX State

Population
Details.Population integer

Population

PrimaryWarningCountyCode
Details.PrimaryWarningCountyCode string

Primary Warning County Code

PrimaryWarningZoneCode
Details.PrimaryWarningZoneCode string

Primary Warning Zone Code

Satellite
Details.Satellite string

Satellite

Synoptic
Details.Synoptic string

Synoptic

MarineStation
Details.MarineStation string

Marine Station

MarineStationGMTOffset
Details.MarineStationGMTOffset float

Marine Station GMT Offset

VideoCode
Details.VideoCode string

Video Code

LocationStem
Details.LocationStem string

Location Stem

ID
Details.DMA.ID string

ID

EnglishName
Details.DMA.EnglishName string

English name

PartnerID
Details.PartnerID string

Partner ID

Sources
Details.Sources array of object

Sources

DataType
Details.Sources.DataType string

Data Type

Source
Details.Sources.Source string

Source

SourceId
Details.Sources.SourceId integer

SourceId

CanonicalPostalCode
Details.CanonicalPostalCode string

Canonical Postal Code

CanonicalLocationKey
Details.CanonicalLocationKey string

Canonical Location Key

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

ID

LocalizedName
LocalizedName string

Localized name

EnglishName
EnglishName string

English name

Level
Level integer

Level

LocalizedType
LocalizedType string

Localized type

EnglishType
EnglishType string

English type

CountryID
CountryID string

Country Id

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

ID

LocalizedName
LocalizedName string

Localized name

EnglishName
EnglishName string

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 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
LocalObservationDateTime
LocalObservationDateTime string

Local Observation Date Time

EpochTime
EpochTime integer

Epoch Time

WeatherText
WeatherText string

Weather Text

WeatherIcon
WeatherIcon integer

Weather Icon

HasPrecipitation
HasPrecipitation boolean

Has Precipitation

PrecipitationType
PrecipitationType string

Precipitation Type

IsDayTime
IsDayTime boolean

Is Day Time

Value
Temperature.Metric.Value double

Value

Unit
Temperature.Metric.Unit string

Unit

UnitType
Temperature.Metric.UnitType integer

Unit type

Value
Temperature.Imperial.Value double

Value

Unit
Temperature.Imperial.Unit string

Unit

UnitType
Temperature.Imperial.UnitType integer

Unit type

Value
RealFeelTemperature.Metric.Value double

Value

Unit
RealFeelTemperature.Metric.Unit string

Unit

UnitType
RealFeelTemperature.Metric.UnitType integer

Unit type

Value
RealFeelTemperature.Imperial.Value double

Value

Unit
RealFeelTemperature.Imperial.Unit string

Unit

UnitType
RealFeelTemperature.Imperial.UnitType integer

Unit type

Value
RealFeelTemperatureShade.Metric.Value double

Value

Unit
RealFeelTemperatureShade.Metric.Unit string

Unit

UnitType
RealFeelTemperatureShade.Metric.UnitType integer

Unit type

Value
RealFeelTemperatureShade.Imperial.Value double

Value

Unit
RealFeelTemperatureShade.Imperial.Unit string

Unit

UnitType
RealFeelTemperatureShade.Imperial.UnitType integer

Unit type

RelativeHumidity
RelativeHumidity integer

Relative Humidity

IndoorRelativeHumidity
IndoorRelativeHumidity integer

Indoor Relative Humidity

Value
DewPoint.Metric.Value double

Value

Unit
DewPoint.Metric.Unit string

Unit

UnitType
DewPoint.Metric.UnitType integer

Unit type

Value
DewPoint.Imperial.Value double

Value

Unit
DewPoint.Imperial.Unit string

Unit

UnitType
DewPoint.Imperial.UnitType integer

Unit type

Degrees
Wind.Direction.Degrees integer

Degrees

Localized
Wind.Direction.Localized string

Localized

English
Wind.Direction.English string

English

Value
Wind.Speed.Metric.Value double

Value

Unit
Wind.Speed.Metric.Unit string

Unit

UnitType
Wind.Speed.Metric.UnitType integer

Unit type

Value
Wind.Speed.Imperial.Value double

Value

Unit
Wind.Speed.Imperial.Unit string

Unit

UnitType
Wind.Speed.Imperial.UnitType integer

Unit type

Value
WindGust.Speed.Metric.Value double

Value

Unit
WindGust.Speed.Metric.Unit string

Unit

UnitType
WindGust.Speed.Metric.UnitType integer

Unit type

Value
WindGust.Speed.Imperial.Value double

Value

Unit
WindGust.Speed.Imperial.Unit string

Unit

UnitType
WindGust.Speed.Imperial.UnitType integer

Unit type

UVIndex
UVIndex integer

UV Index

UVIndexText
UVIndexText string

UV Index Text

Value
Visibility.Metric.Value double

Value

Unit
Visibility.Metric.Unit string

Unit

UnitType
Visibility.Metric.UnitType integer

Unit type

Value
Visibility.Imperial.Value double

Value

Unit
Visibility.Imperial.Unit string

Unit

UnitType
Visibility.Imperial.UnitType integer

Unit type

ObstructionsToVisibility
ObstructionsToVisibility string

Obstructions To Visibility

CloudCover
CloudCover integer

Cloud Cover

Value
Ceiling.Metric.Value double

Value

Unit
Ceiling.Metric.Unit string

Unit

UnitType
Ceiling.Metric.UnitType integer

Unit type

Value
Ceiling.Imperial.Value double

Value

Unit
Ceiling.Imperial.Unit string

Unit

UnitType
Ceiling.Imperial.UnitType integer

Unit type

Value
Pressure.Metric.Value double

Value

Unit
Pressure.Metric.Unit string

Unit

UnitType
Pressure.Metric.UnitType integer

Unit type

Value
Pressure.Imperial.Value double

Value

Unit
Pressure.Imperial.Unit string

Unit

UnitType
Pressure.Imperial.UnitType integer

Unit type

LocalizedText
PressureTendency.LocalizedText string

Localized Text

Code
PressureTendency.Code string

Code

Value
Past24HourTemperatureDeparture.Metric.Value double

Value

Unit
Past24HourTemperatureDeparture.Metric.Unit string

Unit

UnitType
Past24HourTemperatureDeparture.Metric.UnitType integer

Unit type

Value
Past24HourTemperatureDeparture.Imperial.Value double

Value

Unit
Past24HourTemperatureDeparture.Imperial.Unit string

Unit

UnitType
Past24HourTemperatureDeparture.Imperial.UnitType integer

Unit type

Value
ApparentTemperature.Metric.Value double

Value

Unit
ApparentTemperature.Metric.Unit string

Unit

UnitType
ApparentTemperature.Metric.UnitType integer

Unit type

Value
ApparentTemperature.Imperial.Value double

Value

Unit
ApparentTemperature.Imperial.Unit string

Unit

UnitType
ApparentTemperature.Imperial.UnitType integer

Unit type

Value
WindChillTemperature.Metric.Value double

Value

Unit
WindChillTemperature.Metric.Unit string

Unit

UnitType
WindChillTemperature.Metric.UnitType integer

Unit type

Value
WindChillTemperature.Imperial.Value double

Value

Unit
WindChillTemperature.Imperial.Unit string

Unit

UnitType
WindChillTemperature.Imperial.UnitType integer

Unit type

Value
WetBulbTemperature.Metric.Value double

Value

Unit
WetBulbTemperature.Metric.Unit string

Unit

UnitType
WetBulbTemperature.Metric.UnitType integer

Unit type

Value
WetBulbTemperature.Imperial.Value double

Value

Unit
WetBulbTemperature.Imperial.Unit string

Unit

UnitType
WetBulbTemperature.Imperial.UnitType integer

Unit type

Value
Precip1hr.Metric.Value double

Value

Unit
Precip1hr.Metric.Unit string

Unit

UnitType
Precip1hr.Metric.UnitType integer

Unit type

Value
Precip1hr.Imperial.Value double

Value

Unit
Precip1hr.Imperial.Unit string

Unit

UnitType
Precip1hr.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Precipitation.Metric.Value double

Value

Unit
PrecipitationSummary.Precipitation.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Precipitation.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Precipitation.Imperial.Value double

Value

Unit
PrecipitationSummary.Precipitation.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Precipitation.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.PastHour.Metric.Value double

Value

Unit
PrecipitationSummary.PastHour.Metric.Unit string

Unit

UnitType
PrecipitationSummary.PastHour.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.PastHour.Imperial.Value double

Value

Unit
PrecipitationSummary.PastHour.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.PastHour.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past3Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past3Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past3Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past3Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past3Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past3Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past6Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past6Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past6Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past6Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past6Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past6Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past9Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past9Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past9Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past9Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past9Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past9Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past12Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past12Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past12Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past12Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past12Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past12Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past18Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past18Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past18Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past18Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past18Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past18Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past24Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past24Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past24Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past24Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past24Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past24Hours.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Maximum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Maximum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Maximum.Imperial.UnitType integer

Unit type

MobileLink
MobileLink string

Mobile Link

Link
Link string

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

Key

LocalizedName
LocalizedName string

Localized name

EnglishName
EnglishName string

English name

ID
Country.ID string

ID

LocalizedName
Country.LocalizedName string

Localized name

EnglishName
Country.EnglishName string

English name

Code
TimeZone.Code string

Code

Name
TimeZone.Name string

Name

TimeZone.GmtOffset float

Gmt Offset

IsDaylightSaving
TimeZone.IsDaylightSaving boolean

Is Day lightSaving

NextOffsetChange
TimeZone.NextOffsetChange string

Next Offset Change

Latitude
GeoPosition.Latitude float

Latitude

Longitude
GeoPosition.Longitude float

Longitude

GeoPosition.Elevation.Metric.Value double

Value

Unit
GeoPosition.Elevation.Metric.Unit string

Unit

UnitType
GeoPosition.Elevation.Metric.UnitType integer

Unit type

GeoPosition.Elevation.Imperial.Value double

Value

Unit
GeoPosition.Elevation.Imperial.Unit string

Unit

UnitType
GeoPosition.Elevation.Imperial.UnitType integer

Unit type

LocalObservationDateTime
LocalObservationDateTime string

Local Observation Date Time

EpochTime
EpochTime integer

Epoch Time

WeatherText
WeatherText string

Weather Text

WeatherIcon
WeatherIcon integer

Weather Icon

HasPrecipitation
HasPrecipitation boolean

Has Precipitation

PrecipitationType
PrecipitationType string

Precipitation Type

IsDayTime
IsDayTime boolean

Is Day Time

Value
Temperature.Metric.Value double

Value

Unit
Temperature.Metric.Unit string

Unit

UnitType
Temperature.Metric.UnitType integer

Unit type

Temperature.Imperial.Value float

Value

Unit
Temperature.Imperial.Unit string

Unit

UnitType
Temperature.Imperial.UnitType integer

Unit type

MobileLink
MobileLink string

Mobile Link

Link
Link string

Link

Id
LocalSource.Id integer

Id

Name
LocalSource.Name string

Name

WeatherCode
LocalSource.WeatherCode string

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
EffectiveDate
Headline.EffectiveDate string

Effective Date

EffectiveEpochDate
Headline.EffectiveEpochDate integer

Effective Epoch Date

Severity
Headline.Severity integer

Severity

Text
Headline.Text string

Text

Category
Headline.Category string

Category

EndDate
Headline.EndDate string

EndDate

EndEpochDate
Headline.EndEpochDate integer

End Epoch Date

MobileLink
Headline.MobileLink string

Mobile Link

Link
Headline.Link string

Link

DailyForecasts
DailyForecasts array of object

Daily Forecasts

Date
DailyForecasts.Date string

Date

EpochDate
DailyForecasts.EpochDate integer

Epoch Date

Rise
DailyForecasts.Sun.Rise string

Rise

EpochRise
DailyForecasts.Sun.EpochRise integer

Epoch Rise

Set
DailyForecasts.Sun.Set string

Set

EpochSet
DailyForecasts.Sun.EpochSet integer

Epoch Set

Rise
DailyForecasts.Moon.Rise string

Rise

EpochRise
DailyForecasts.Moon.EpochRise integer

Epoch Rise

Set
DailyForecasts.Moon.Set string

Set

EpochSet
DailyForecasts.Moon.EpochSet integer

Epoch Set

Phase
DailyForecasts.Moon.Phase string

Phase

Age
DailyForecasts.Moon.Age integer

Age

Value
DailyForecasts.Temperature.Minimum.Value double

Value

Unit
DailyForecasts.Temperature.Minimum.Unit string

Unit

UnitType
DailyForecasts.Temperature.Minimum.UnitType integer

Unit type

Value
DailyForecasts.Temperature.Maximum.Value double

Value

Unit
DailyForecasts.Temperature.Maximum.Unit string

Unit

UnitType
DailyForecasts.Temperature.Maximum.UnitType integer

Unit type

Value
DailyForecasts.RealFeelTemperature.Minimum.Value double

Value

Unit
DailyForecasts.RealFeelTemperature.Minimum.Unit string

Unit

UnitType
DailyForecasts.RealFeelTemperature.Minimum.UnitType integer

Unit type

Value
DailyForecasts.RealFeelTemperature.Maximum.Value double

Value

Unit
DailyForecasts.RealFeelTemperature.Maximum.Unit string

Unit

UnitType
DailyForecasts.RealFeelTemperature.Maximum.UnitType integer

Unit type

Value
DailyForecasts.RealFeelTemperatureShade.Minimum.Value double

Value

Unit
DailyForecasts.RealFeelTemperatureShade.Minimum.Unit string

Unit

UnitType
DailyForecasts.RealFeelTemperatureShade.Minimum.UnitType integer

Unit type

Value
DailyForecasts.RealFeelTemperatureShade.Maximum.Value double

Value

Unit
DailyForecasts.RealFeelTemperatureShade.Maximum.Unit string

Unit

UnitType
DailyForecasts.RealFeelTemperatureShade.Maximum.UnitType integer

Unit type

HoursOfSun
DailyForecasts.HoursOfSun float

Hours Of Sun

Value
DailyForecasts.DegreeDaySummary.Heating.Value double

Value

Unit
DailyForecasts.DegreeDaySummary.Heating.Unit string

Unit

UnitType
DailyForecasts.DegreeDaySummary.Heating.UnitType integer

Unit type

Value
DailyForecasts.DegreeDaySummary.Cooling.Value double

Value

Unit
DailyForecasts.DegreeDaySummary.Cooling.Unit string

Unit

UnitType
DailyForecasts.DegreeDaySummary.Cooling.UnitType integer

Unit type

AirAndPollen
DailyForecasts.AirAndPollen array of object

Air And Pollen

Name
DailyForecasts.AirAndPollen.Name string

Name

Value
DailyForecasts.AirAndPollen.Value double

Value

Category
DailyForecasts.AirAndPollen.Category string

Category

CategoryValue
DailyForecasts.AirAndPollen.CategoryValue integer

Category Value

Type
DailyForecasts.AirAndPollen.Type string

Type

Icon
DailyForecasts.Day.Icon integer

Icon

IconPhrase
DailyForecasts.Day.IconPhrase string

Icon Phrase

HasPrecipitation
DailyForecasts.Day.HasPrecipitation boolean

Has Precipitation

ShortPhrase
DailyForecasts.Day.ShortPhrase string

Short Phrase

LongPhrase
DailyForecasts.Day.LongPhrase string

Long Phrase

PrecipitationProbability
DailyForecasts.Day.PrecipitationProbability integer

Precipitation Probability

ThunderstormProbability
DailyForecasts.Day.ThunderstormProbability integer

Thunderstorm Probability

RainProbability
DailyForecasts.Day.RainProbability integer

Rain Probability

SnowProbability
DailyForecasts.Day.SnowProbability integer

Snow Probability

IceProbability
DailyForecasts.Day.IceProbability integer

Ice Probability

Value
DailyForecasts.Day.Wind.Speed.Value double

Value

Unit
DailyForecasts.Day.Wind.Speed.Unit string

Unit

UnitType
DailyForecasts.Day.Wind.Speed.UnitType integer

Unit type

Degrees
DailyForecasts.Day.Wind.Direction.Degrees integer

Degrees

Localized
DailyForecasts.Day.Wind.Direction.Localized string

Localized

English
DailyForecasts.Day.Wind.Direction.English string

English

Value
DailyForecasts.Day.WindGust.Speed.Value double

Value

Unit
DailyForecasts.Day.WindGust.Speed.Unit string

Unit

UnitType
DailyForecasts.Day.WindGust.Speed.UnitType integer

Unit type

Degrees
DailyForecasts.Day.WindGust.Direction.Degrees integer

Degrees

Localized
DailyForecasts.Day.WindGust.Direction.Localized string

Localized

English
DailyForecasts.Day.WindGust.Direction.English string

English

Value
DailyForecasts.Day.TotalLiquid.Value double

Value

Unit
DailyForecasts.Day.TotalLiquid.Unit string

Unit

UnitType
DailyForecasts.Day.TotalLiquid.UnitType integer

Unit type

Value
DailyForecasts.Day.Rain.Value double

Value

Unit
DailyForecasts.Day.Rain.Unit string

Unit

UnitType
DailyForecasts.Day.Rain.UnitType integer

Unit type

Value
DailyForecasts.Day.Snow.Value double

Value

Unit
DailyForecasts.Day.Snow.Unit string

Unit

UnitType
DailyForecasts.Day.Snow.UnitType integer

Unit type

Value
DailyForecasts.Day.Ice.Value double

Value

Unit
DailyForecasts.Day.Ice.Unit string

Unit

UnitType
DailyForecasts.Day.Ice.UnitType integer

Unit type

HoursOfPrecipitation
DailyForecasts.Day.HoursOfPrecipitation integer

Hours Of Precipitation

HoursOfRain
DailyForecasts.Day.HoursOfRain integer

Hours Of Rain

HoursOfSnow
DailyForecasts.Day.HoursOfSnow integer

Hours Of Snow

HoursOfIce
DailyForecasts.Day.HoursOfIce integer

Hours Of Ice

CloudCover
DailyForecasts.Day.CloudCover integer

Cloud Cover

Value
DailyForecasts.Day.Evapotranspiration.Value double

Value

Unit
DailyForecasts.Day.Evapotranspiration.Unit string

Unit

UnitType
DailyForecasts.Day.Evapotranspiration.UnitType integer

Unit type

Value
DailyForecasts.Day.SolarIrradiance.Value double

Value

Unit
DailyForecasts.Day.SolarIrradiance.Unit string

Unit

UnitType
DailyForecasts.Day.SolarIrradiance.UnitType integer

Unit type

Icon
DailyForecasts.Night.Icon integer

Icon

IconPhrase
DailyForecasts.Night.IconPhrase string

Icon Phrase

HasPrecipitation
DailyForecasts.Night.HasPrecipitation boolean

Has Precipitation

ShortPhrase
DailyForecasts.Night.ShortPhrase string

Short Phrase

LongPhrase
DailyForecasts.Night.LongPhrase string

Long Phrase

PrecipitationProbability
DailyForecasts.Night.PrecipitationProbability integer

Precipitation Probability

ThunderstormProbability
DailyForecasts.Night.ThunderstormProbability integer

Thunderstorm Probability

RainProbability
DailyForecasts.Night.RainProbability integer

Rain Probability

SnowProbability
DailyForecasts.Night.SnowProbability integer

Snow Probability

IceProbability
DailyForecasts.Night.IceProbability integer

Ice Probability

Value
DailyForecasts.Night.Wind.Speed.Value double

Value

Unit
DailyForecasts.Night.Wind.Speed.Unit string

Unit

UnitType
DailyForecasts.Night.Wind.Speed.UnitType integer

Unit type

Degrees
DailyForecasts.Night.Wind.Direction.Degrees integer

Degrees

Localized
DailyForecasts.Night.Wind.Direction.Localized string

Localized

English
DailyForecasts.Night.Wind.Direction.English string

English

Value
DailyForecasts.Night.WindGust.Speed.Value double

Value

Unit
DailyForecasts.Night.WindGust.Speed.Unit string

Unit

UnitType
DailyForecasts.Night.WindGust.Speed.UnitType integer

Unit type

Degrees
DailyForecasts.Night.WindGust.Direction.Degrees integer

Degrees

Localized
DailyForecasts.Night.WindGust.Direction.Localized string

Localized

English
DailyForecasts.Night.WindGust.Direction.English string

English

Value
DailyForecasts.Night.TotalLiquid.Value double

Value

Unit
DailyForecasts.Night.TotalLiquid.Unit string

Unit

UnitType
DailyForecasts.Night.TotalLiquid.UnitType integer

Unit type

Value
DailyForecasts.Night.Rain.Value double

Value

Unit
DailyForecasts.Night.Rain.Unit string

Unit

UnitType
DailyForecasts.Night.Rain.UnitType integer

Unit type

Value
DailyForecasts.Night.Snow.Value double

Value

Unit
DailyForecasts.Night.Snow.Unit string

Unit

UnitType
DailyForecasts.Night.Snow.UnitType integer

Unit type

Value
DailyForecasts.Night.Ice.Value double

Value

Unit
DailyForecasts.Night.Ice.Unit string

Unit

UnitType
DailyForecasts.Night.Ice.UnitType integer

Unit type

HoursOfPrecipitation
DailyForecasts.Night.HoursOfPrecipitation integer

Hours Of Precipitation

HoursOfRain
DailyForecasts.Night.HoursOfRain integer

Hours Of Rain

HoursOfSnow
DailyForecasts.Night.HoursOfSnow integer

Hours Of Snow

HoursOfIce
DailyForecasts.Night.HoursOfIce integer

Hours Of Ice

CloudCover
DailyForecasts.Night.CloudCover integer

Cloud Cover

Value
DailyForecasts.Night.Evapotranspiration.Value double

Value

Unit
DailyForecasts.Night.Evapotranspiration.Unit string

Unit

UnitType
DailyForecasts.Night.Evapotranspiration.UnitType integer

Unit type

Value
DailyForecasts.Night.SolarIrradiance.Value double

Value

Unit
DailyForecasts.Night.SolarIrradiance.Unit string

Unit

UnitType
DailyForecasts.Night.SolarIrradiance.UnitType integer

Unit type

Sources
DailyForecasts.Sources array of string

Sources

MobileLink
DailyForecasts.MobileLink string

Mobile Link

Link
DailyForecasts.Link string

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

Name

ID
ID integer

ID

Ascending
Ascending boolean

Ascending

LocalDateTime
LocalDateTime string

Local Date Time

EpochDateTime
EpochDateTime integer

Epoch Date Time

Value
Value double

Value

Category
Category string

Category

CategoryValue
CategoryValue integer

Category Value

Text
Text string

Text

MobileLink
MobileLink string

Mobile Link

Link
Link string

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

Name

ID
ID integer

ID

Ascending
Ascending boolean

Ascending

LocalDateTime
LocalDateTime string

Local Date Time

EpochDateTime
EpochDateTime integer

Epoch Date Time

Value
Value double

Value

Category
Category string

Category

CategoryValue
CategoryValue integer

Category Value

Text
Text string

Text

MobileLink
MobileLink string

Mobile Link

Link
Link string

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

Name

ID
ID integer

ID

Ascending
Ascending boolean

Ascending

LocalDateTime
LocalDateTime string

Local Date Time

EpochDateTime
EpochDateTime integer

Epoch Date Time

Value
Value double

Value

Category
Category string

Category

CategoryValue
CategoryValue integer

Category Value

Text
Text string

Text

MobileLink
MobileLink string

Mobile Link

Link
Link string

Link

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
LocalObservationDateTime
LocalObservationDateTime string

Local Observation Date Time

EpochTime
EpochTime integer

Epoch Time

WeatherText
WeatherText string

Weather Text

WeatherIcon
WeatherIcon integer

Weather Icon

HasPrecipitation
HasPrecipitation boolean

Has Precipitation

PrecipitationType
PrecipitationType string

Precipitation Type

IsDayTime
IsDayTime boolean

Is Day Time

Value
Temperature.Metric.Value double

Value

Unit
Temperature.Metric.Unit string

Unit

UnitType
Temperature.Metric.UnitType integer

Unit type

Value
Temperature.Imperial.Value double

Value

Unit
Temperature.Imperial.Unit string

Unit

UnitType
Temperature.Imperial.UnitType integer

Unit type

Value
RealFeelTemperature.Metric.Value double

Value

Unit
RealFeelTemperature.Metric.Unit string

Unit

UnitType
RealFeelTemperature.Metric.UnitType integer

Unit type

Value
RealFeelTemperature.Imperial.Value double

Value

Unit
RealFeelTemperature.Imperial.Unit string

Unit

UnitType
RealFeelTemperature.Imperial.UnitType integer

Unit type

Value
RealFeelTemperatureShade.Metric.Value double

Value

Unit
RealFeelTemperatureShade.Metric.Unit string

Unit

UnitType
RealFeelTemperatureShade.Metric.UnitType integer

Unit type

Value
RealFeelTemperatureShade.Imperial.Value double

Value

Unit
RealFeelTemperatureShade.Imperial.Unit string

Unit

UnitType
RealFeelTemperatureShade.Imperial.UnitType integer

Unit type

RelativeHumidity
RelativeHumidity integer

Relative Humidity

IndoorRelativeHumidity
IndoorRelativeHumidity integer

Indoor Relative Humidity

Value
DewPoint.Metric.Value double

Value

Unit
DewPoint.Metric.Unit string

Unit

UnitType
DewPoint.Metric.UnitType integer

Unit type

Value
DewPoint.Imperial.Value double

Value

Unit
DewPoint.Imperial.Unit string

Unit

UnitType
DewPoint.Imperial.UnitType integer

Unit type

Degrees
Wind.Direction.Degrees integer

Degrees

Localized
Wind.Direction.Localized string

Localized

English
Wind.Direction.English string

English

Value
Wind.Speed.Metric.Value double

Value

Unit
Wind.Speed.Metric.Unit string

Unit

UnitType
Wind.Speed.Metric.UnitType integer

Unit type

Value
Wind.Speed.Imperial.Value double

Value

Unit
Wind.Speed.Imperial.Unit string

Unit

UnitType
Wind.Speed.Imperial.UnitType integer

Unit type

Value
WindGust.Speed.Metric.Value double

Value

Unit
WindGust.Speed.Metric.Unit string

Unit

UnitType
WindGust.Speed.Metric.UnitType integer

Unit type

Value
WindGust.Speed.Imperial.Value double

Value

Unit
WindGust.Speed.Imperial.Unit string

Unit

UnitType
WindGust.Speed.Imperial.UnitType integer

Unit type

UVIndex
UVIndex integer

UV Index

UVIndexText
UVIndexText string

UV Index Text

Value
Visibility.Metric.Value double

Value

Unit
Visibility.Metric.Unit string

Unit

UnitType
Visibility.Metric.UnitType integer

Unit type

Value
Visibility.Imperial.Value double

Value

Unit
Visibility.Imperial.Unit string

Unit

UnitType
Visibility.Imperial.UnitType integer

Unit type

ObstructionsToVisibility
ObstructionsToVisibility string

Obstructions To Visibility

CloudCover
CloudCover integer

Cloud Cover

Value
Ceiling.Metric.Value double

Value

Unit
Ceiling.Metric.Unit string

Unit

UnitType
Ceiling.Metric.UnitType integer

Unit type

Value
Ceiling.Imperial.Value double

Value

Unit
Ceiling.Imperial.Unit string

Unit

UnitType
Ceiling.Imperial.UnitType integer

Unit type

Value
Pressure.Metric.Value double

Value

Unit
Pressure.Metric.Unit string

Unit

UnitType
Pressure.Metric.UnitType integer

Unit type

Value
Pressure.Imperial.Value double

Value

Unit
Pressure.Imperial.Unit string

Unit

UnitType
Pressure.Imperial.UnitType integer

Unit type

LocalizedText
PressureTendency.LocalizedText string

Localized Text

Code
PressureTendency.Code string

Code

Value
Past24HourTemperatureDeparture.Metric.Value double

Value

Unit
Past24HourTemperatureDeparture.Metric.Unit string

Unit

UnitType
Past24HourTemperatureDeparture.Metric.UnitType integer

Unit type

Value
Past24HourTemperatureDeparture.Imperial.Value double

Value

Unit
Past24HourTemperatureDeparture.Imperial.Unit string

Unit

UnitType
Past24HourTemperatureDeparture.Imperial.UnitType integer

Unit type

Value
ApparentTemperature.Metric.Value double

Value

Unit
ApparentTemperature.Metric.Unit string

Unit

UnitType
ApparentTemperature.Metric.UnitType integer

Unit type

Value
ApparentTemperature.Imperial.Value double

Value

Unit
ApparentTemperature.Imperial.Unit string

Unit

UnitType
ApparentTemperature.Imperial.UnitType integer

Unit type

Value
WindChillTemperature.Metric.Value double

Value

Unit
WindChillTemperature.Metric.Unit string

Unit

UnitType
WindChillTemperature.Metric.UnitType integer

Unit type

Value
WindChillTemperature.Imperial.Value double

Value

Unit
WindChillTemperature.Imperial.Unit string

Unit

UnitType
WindChillTemperature.Imperial.UnitType integer

Unit type

Value
WetBulbTemperature.Metric.Value double

Value

Unit
WetBulbTemperature.Metric.Unit string

Unit

UnitType
WetBulbTemperature.Metric.UnitType integer

Unit type

Value
WetBulbTemperature.Imperial.Value double

Value

Unit
WetBulbTemperature.Imperial.Unit string

Unit

UnitType
WetBulbTemperature.Imperial.UnitType integer

Unit type

Value
Precip1hr.Metric.Value double

Value

Unit
Precip1hr.Metric.Unit string

Unit

UnitType
Precip1hr.Metric.UnitType integer

Unit type

Value
Precip1hr.Imperial.Value double

Value

Unit
Precip1hr.Imperial.Unit string

Unit

UnitType
Precip1hr.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Precipitation.Metric.Value double

Value

Unit
PrecipitationSummary.Precipitation.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Precipitation.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Precipitation.Imperial.Value double

Value

Unit
PrecipitationSummary.Precipitation.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Precipitation.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.PastHour.Metric.Value double

Value

Unit
PrecipitationSummary.PastHour.Metric.Unit string

Unit

UnitType
PrecipitationSummary.PastHour.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.PastHour.Imperial.Value double

Value

Unit
PrecipitationSummary.PastHour.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.PastHour.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past3Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past3Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past3Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past3Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past3Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past3Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past6Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past6Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past6Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past6Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past6Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past6Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past9Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past9Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past9Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past9Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past9Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past9Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past12Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past12Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past12Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past12Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past12Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past12Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past18Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past18Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past18Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past18Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past18Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past18Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past24Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past24Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past24Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past24Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past24Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past24Hours.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Maximum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Maximum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Maximum.Imperial.UnitType integer

Unit type

MobileLink
MobileLink string

Mobile Link

Link
Link string

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
LocalObservationDateTime
LocalObservationDateTime string

Local Observation Date Time

EpochTime
EpochTime integer

Epoch Time

WeatherText
WeatherText string

Weather Text

WeatherIcon
WeatherIcon integer

Weather Icon

HasPrecipitation
HasPrecipitation boolean

Has Precipitation

PrecipitationType
PrecipitationType string

Precipitation Type

IsDayTime
IsDayTime boolean

Is Day Time

Value
Temperature.Metric.Value double

Value

Unit
Temperature.Metric.Unit string

Unit

UnitType
Temperature.Metric.UnitType integer

Unit type

Value
Temperature.Imperial.Value double

Value

Unit
Temperature.Imperial.Unit string

Unit

UnitType
Temperature.Imperial.UnitType integer

Unit type

Value
RealFeelTemperature.Metric.Value double

Value

Unit
RealFeelTemperature.Metric.Unit string

Unit

UnitType
RealFeelTemperature.Metric.UnitType integer

Unit type

Value
RealFeelTemperature.Imperial.Value double

Value

Unit
RealFeelTemperature.Imperial.Unit string

Unit

UnitType
RealFeelTemperature.Imperial.UnitType integer

Unit type

Value
RealFeelTemperatureShade.Metric.Value double

Value

Unit
RealFeelTemperatureShade.Metric.Unit string

Unit

UnitType
RealFeelTemperatureShade.Metric.UnitType integer

Unit type

Value
RealFeelTemperatureShade.Imperial.Value double

Value

Unit
RealFeelTemperatureShade.Imperial.Unit string

Unit

UnitType
RealFeelTemperatureShade.Imperial.UnitType integer

Unit type

RelativeHumidity
RelativeHumidity integer

Relative Humidity

IndoorRelativeHumidity
IndoorRelativeHumidity integer

Indoor Relative Humidity

Value
DewPoint.Metric.Value double

Value

Unit
DewPoint.Metric.Unit string

Unit

UnitType
DewPoint.Metric.UnitType integer

Unit type

Value
DewPoint.Imperial.Value double

Value

Unit
DewPoint.Imperial.Unit string

Unit

UnitType
DewPoint.Imperial.UnitType integer

Unit type

Degrees
Wind.Direction.Degrees integer

Degrees

Localized
Wind.Direction.Localized string

Localized

English
Wind.Direction.English string

English

Value
Wind.Speed.Metric.Value double

Value

Unit
Wind.Speed.Metric.Unit string

Unit

UnitType
Wind.Speed.Metric.UnitType integer

Unit type

Value
Wind.Speed.Imperial.Value double

Value

Unit
Wind.Speed.Imperial.Unit string

Unit

UnitType
Wind.Speed.Imperial.UnitType integer

Unit type

Value
WindGust.Speed.Metric.Value double

Value

Unit
WindGust.Speed.Metric.Unit string

Unit

UnitType
WindGust.Speed.Metric.UnitType integer

Unit type

Value
WindGust.Speed.Imperial.Value double

Value

Unit
WindGust.Speed.Imperial.Unit string

Unit

UnitType
WindGust.Speed.Imperial.UnitType integer

Unit type

UVIndex
UVIndex integer

UV Index

UVIndexText
UVIndexText string

UV Index Text

Value
Visibility.Metric.Value double

Value

Unit
Visibility.Metric.Unit string

Unit

UnitType
Visibility.Metric.UnitType integer

Unit type

Value
Visibility.Imperial.Value double

Value

Unit
Visibility.Imperial.Unit string

Unit

UnitType
Visibility.Imperial.UnitType integer

Unit type

ObstructionsToVisibility
ObstructionsToVisibility string

Obstructions To Visibility

CloudCover
CloudCover integer

Cloud Cover

Value
Ceiling.Metric.Value double

Value

Unit
Ceiling.Metric.Unit string

Unit

UnitType
Ceiling.Metric.UnitType integer

Unit type

Value
Ceiling.Imperial.Value double

Value

Unit
Ceiling.Imperial.Unit string

Unit

UnitType
Ceiling.Imperial.UnitType integer

Unit type

Value
Pressure.Metric.Value double

Value

Unit
Pressure.Metric.Unit string

Unit

UnitType
Pressure.Metric.UnitType integer

Unit type

Value
Pressure.Imperial.Value double

Value

Unit
Pressure.Imperial.Unit string

Unit

UnitType
Pressure.Imperial.UnitType integer

Unit type

LocalizedText
PressureTendency.LocalizedText string

Localized Text

Code
PressureTendency.Code string

Code

Value
Past24HourTemperatureDeparture.Metric.Value double

Value

Unit
Past24HourTemperatureDeparture.Metric.Unit string

Unit

UnitType
Past24HourTemperatureDeparture.Metric.UnitType integer

Unit type

Value
Past24HourTemperatureDeparture.Imperial.Value double

Value

Unit
Past24HourTemperatureDeparture.Imperial.Unit string

Unit

UnitType
Past24HourTemperatureDeparture.Imperial.UnitType integer

Unit type

Value
ApparentTemperature.Metric.Value double

Value

Unit
ApparentTemperature.Metric.Unit string

Unit

UnitType
ApparentTemperature.Metric.UnitType integer

Unit type

Value
ApparentTemperature.Imperial.Value double

Value

Unit
ApparentTemperature.Imperial.Unit string

Unit

UnitType
ApparentTemperature.Imperial.UnitType integer

Unit type

Value
WindChillTemperature.Metric.Value double

Value

Unit
WindChillTemperature.Metric.Unit string

Unit

UnitType
WindChillTemperature.Metric.UnitType integer

Unit type

Value
WindChillTemperature.Imperial.Value double

Value

Unit
WindChillTemperature.Imperial.Unit string

Unit

UnitType
WindChillTemperature.Imperial.UnitType integer

Unit type

Value
WetBulbTemperature.Metric.Value double

Value

Unit
WetBulbTemperature.Metric.Unit string

Unit

UnitType
WetBulbTemperature.Metric.UnitType integer

Unit type

Value
WetBulbTemperature.Imperial.Value double

Value

Unit
WetBulbTemperature.Imperial.Unit string

Unit

UnitType
WetBulbTemperature.Imperial.UnitType integer

Unit type

Value
Precip1hr.Metric.Value double

Value

Unit
Precip1hr.Metric.Unit string

Unit

UnitType
Precip1hr.Metric.UnitType integer

Unit type

Value
Precip1hr.Imperial.Value double

Value

Unit
Precip1hr.Imperial.Unit string

Unit

UnitType
Precip1hr.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Precipitation.Metric.Value double

Value

Unit
PrecipitationSummary.Precipitation.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Precipitation.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Precipitation.Imperial.Value double

Value

Unit
PrecipitationSummary.Precipitation.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Precipitation.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.PastHour.Metric.Value double

Value

Unit
PrecipitationSummary.PastHour.Metric.Unit string

Unit

UnitType
PrecipitationSummary.PastHour.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.PastHour.Imperial.Value double

Value

Unit
PrecipitationSummary.PastHour.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.PastHour.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past3Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past3Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past3Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past3Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past3Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past3Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past6Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past6Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past6Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past6Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past6Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past6Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past9Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past9Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past9Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past9Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past9Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past9Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past12Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past12Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past12Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past12Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past12Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past12Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past18Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past18Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past18Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past18Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past18Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past18Hours.Imperial.UnitType integer

Unit type

Value
PrecipitationSummary.Past24Hours.Metric.Value double

Value

Unit
PrecipitationSummary.Past24Hours.Metric.Unit string

Unit

UnitType
PrecipitationSummary.Past24Hours.Metric.UnitType integer

Unit type

Value
PrecipitationSummary.Past24Hours.Imperial.Value double

Value

Unit
PrecipitationSummary.Past24Hours.Imperial.Unit string

Unit

UnitType
PrecipitationSummary.Past24Hours.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past6HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past6HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past6HourRange.Maximum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past12HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past12HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past12HourRange.Maximum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Minimum.Metric.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Minimum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Minimum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Minimum.Imperial.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Minimum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Minimum.Imperial.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Maximum.Metric.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Maximum.Metric.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Maximum.Metric.UnitType integer

Unit type

Value
TemperatureSummary.Past24HourRange.Maximum.Imperial.Value double

Value

Unit
TemperatureSummary.Past24HourRange.Maximum.Imperial.Unit string

Unit

UnitType
TemperatureSummary.Past24HourRange.Maximum.Imperial.UnitType integer

Unit type

MobileLink
MobileLink string

Mobile Link

Link
Link string

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
DateTime
DateTime string

Date Time

EpochDateTime
EpochDateTime integer

Epoch Date Time

WeatherIcon
WeatherIcon integer

Weather Icon

IconPhrase
IconPhrase string

Icon Phrase

HasPrecipitation
HasPrecipitation boolean

Has Precipitation

IsDaylight
IsDaylight boolean

Is Daylight

Value
Temperature.Value double

Value

Unit
Temperature.Unit string

Unit

UnitType
Temperature.UnitType integer

Unit type

Value
RealFeelTemperature.Value double

Value

Unit
RealFeelTemperature.Unit string

Unit

UnitType
RealFeelTemperature.UnitType integer

Unit type

Value
RealFeelTemperatureShade.Value double

Value

Unit
RealFeelTemperatureShade.Unit string

Unit

UnitType
RealFeelTemperatureShade.UnitType integer

Unit type

Value
WetBulbTemperature.Value double

Value

Unit
WetBulbTemperature.Unit string

Unit

UnitType
WetBulbTemperature.UnitType integer

Unit type

Value
DewPoint.Value double

Value

Unit
DewPoint.Unit string

Unit

UnitType
DewPoint.UnitType integer

Unit type

Value
Wind.Speed.Value double

Value

Unit
Wind.Speed.Unit string

Unit

UnitType
Wind.Speed.UnitType integer

Unit type

Degrees
Wind.Direction.Degrees integer

Degrees

Localized
Wind.Direction.Localized string

Localized

English
Wind.Direction.English string

English

Value
WindGust.Speed.Value double

Value

Unit
WindGust.Speed.Unit string

Unit

UnitType
WindGust.Speed.UnitType integer

Unit type

RelativeHumidity
RelativeHumidity integer

Relative Humidity

IndoorRelativeHumidity
IndoorRelativeHumidity integer

Indoor Relative Humidity

Value
Visibility.Value double

Value

Unit
Visibility.Unit string

Unit

UnitType
Visibility.UnitType integer

Unit type

Value
Ceiling.Value double

Value

Unit
Ceiling.Unit string

Unit

UnitType
Ceiling.UnitType integer

Unit type

UVIndex
UVIndex integer

UV Index

UVIndexText
UVIndexText string

UV IndexText

PrecipitationProbability
PrecipitationProbability integer

Precipitation Probability

ThunderstormProbability
ThunderstormProbability integer

Thunderstorm Probability

RainProbability
RainProbability integer

Rain Probability

SnowProbability
SnowProbability integer

Snow Probability

IceProbability
IceProbability integer

Ice Probability

Value
TotalLiquid.Value double

Value

Unit
TotalLiquid.Unit string

Unit

UnitType
TotalLiquid.UnitType integer

Unit type

Value
Rain.Value double

Value

Unit
Rain.Unit string

Unit

UnitType
Rain.UnitType integer

Unit type

Value
Snow.Value double

Value

Unit
Snow.Unit string

Unit

UnitType
Snow.UnitType integer

Unit type

Value
Ice.Value double

Value

Unit
Ice.Unit string

Unit

UnitType
Ice.UnitType integer

Unit type

CloudCover
CloudCover integer

Cloud Cover

Value
Evapotranspiration.Value double

Value

Unit
Evapotranspiration.Unit string

Unit

UnitType
Evapotranspiration.UnitType integer

Unit type

Value
SolarIrradiance.Value double

Value

Unit
SolarIrradiance.Unit string

Unit

UnitType
SolarIrradiance.UnitType integer

Unit type

MobileLink
MobileLink string

Mobile Link

Link
Link string

Link

Get List of Daily Indices

Returns metadata for all daily indices.

Returns

Name Path Type Description
array of object
Name
Name string

Name

ID
ID integer

ID

Ascending
Ascending boolean

Ascending

Description
Description string

Description

Get List of Index Groups

Returns metadata for all index groups.

Returns

Name Path Type Description
array of object
Name
Name string

Name

ID
ID integer

ID

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

Name

ID
ID integer

ID

Ascending
Ascending boolean

Ascending

Description
Description string

Description

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

ID

LocalizedName
LocalizedName string

Localized name

EnglishName
EnglishName string

English name

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

Version

Key
Key string

Key

Type
Type string

Type

Rank
Rank integer

Rank

LocalizedName
LocalizedName string

Localized name

EnglishName
EnglishName string

English name

PrimaryPostalCode
PrimaryPostalCode string

Primary Postal Code

ID
Region.ID string

ID

LocalizedName
Region.LocalizedName string

Localized name

EnglishName
Region.EnglishName string

English name

ID
Country.ID string

ID

LocalizedName
Country.LocalizedName string

Localized name

EnglishName
Country.EnglishName string

English name

ID
AdministrativeArea.ID string

ID

LocalizedName
AdministrativeArea.LocalizedName string

Localized name

EnglishName
AdministrativeArea.EnglishName string

English name

Level
AdministrativeArea.Level integer

Level

LocalizedType
AdministrativeArea.LocalizedType string

Localized type

EnglishType
AdministrativeArea.EnglishType string

English type

CountryID
AdministrativeArea.CountryID string

Country Id

Code
TimeZone.Code string

Code

Name
TimeZone.Name string

Name

GmtOffset
TimeZone.GmtOffset float

Gmt Offset

IsDaylightSaving
TimeZone.IsDaylightSaving boolean

Is Day light Saving

NextOffsetChange
TimeZone.NextOffsetChange string

Next Offset Change

Latitude
GeoPosition.Latitude float

Latitude

Longitude
GeoPosition.Longitude float

Longitude

Value
GeoPosition.Elevation.Metric.Value double

Value

Unit
GeoPosition.Elevation.Metric.Unit string

Unit

UnitType
GeoPosition.Elevation.Metric.UnitType integer

Unit type

Value
GeoPosition.Elevation.Imperial.Value double

Value

Unit
GeoPosition.Elevation.Imperial.Unit string

Unit

UnitType
GeoPosition.Elevation.Imperial.UnitType integer

Unit type

IsAlias
IsAlias boolean

Is Alias

SupplementalAdminAreas
SupplementalAdminAreas array of

Supplemental Admin Areas

DataSets
DataSets array of string

Data Sets

Key
Details.Key string

Key

StationCode
Details.StationCode string

Station Code

StationGmtOffset
Details.StationGmtOffset float

Station Gmt Offset

BandMap
Details.BandMap string

Band Map

Climo
Details.Climo string

Climo

LocalRadar
Details.LocalRadar string

Local Radar

MediaRegion
Details.MediaRegion string

Media Region

Metar
Details.Metar string

Metar

NXMetro
Details.NXMetro string

NX Metro

NXState
Details.NXState string

NX State

Population
Details.Population integer

Population

PrimaryWarningCountyCode
Details.PrimaryWarningCountyCode string

Primary Warning County Code

PrimaryWarningZoneCode
Details.PrimaryWarningZoneCode string

Primary Warning Zone Code

Satellite
Details.Satellite string

Satellite

Synoptic
Details.Synoptic string

Synoptic

MarineStation
Details.MarineStation string

Marine Station

MarineStationGMTOffset
Details.MarineStationGMTOffset float

Marine Station GMT Offset

VideoCode
Details.VideoCode string

Video Code

LocationStem
Details.LocationStem string

Location Stem

PartnerID
Details.PartnerID string

Partner ID

Sources
Details.Sources array of object

Sources

DataType
Details.Sources.DataType string

Data Type

Source
Details.Sources.Source string

Source

SourceId
Details.Sources.SourceId integer

Source Id

PartnerSourceUrl
Details.Sources.PartnerSourceUrl string

Partner Source Url

CanonicalPostalCode
Details.CanonicalPostalCode string

Canonical Postal Code

CanonicalLocationKey
Details.CanonicalLocationKey string

Canonical Location Key

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

SupplementalAdminAreas

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

SupplementalAdminAreas

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

Sources

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.