Core Weather

Schemas


API.CurrentConditions.Entities.OpenAPI.Country

  • IDstring · minLength: 1 · required

    Unique ISO or Microsoft Localization Code for the country.

  • LocalizedNamestring · minLength: 1 · required

    Country name as displayed in the local dialect set with language code in the URL. If no language code is selected, the default is US English (us-en).

  • EnglishNamestring · minLength: 1 · required

    Country name displayed in English.

API.CurrentConditions.Entities.OpenAPI.CurrentConditions

  • LocalObservationDateTimestring · date-time · required

    The date and time at which the data was collected, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochTimeinteger · int64 · required

    The date and time at which the data was collected, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • WeatherTextstring · minLength: 1 · required

    A phrase describing the current weather conditions in the specified language.

  • WeatherIconinteger · int32 · required

    A numeric value representing an image that displays the phrase returned in the WeatherText parameter.

  • HasPrecipitationboolean · required

    A flag indicating the presence or absence of precipitation. A true response indicates precipitation, false indicates no precipitation.

  • PrecipitationTypestring · minLength: 1 · required

    The type of precipitation, if any. Possible values are Rain, Snow, Ice, Mixed, or Null for no precipitation.

  • IsDayTimeboolean · required

    A boolean flag that indicates the day/night status. True at daytime, false at nighttime.

  • Temperaturerequired

    An object containing information about the observed air temperature at the requested location with a rounded value for Fahrenheit and Celsius. The object may be NULL.

  • MobileLinkstring · minLength: 1 · required

    Link to current conditions on AccuWeather's mobile site for the requested location.

  • Linkstring · minLength: 1 · required

    Link to current conditions on AccuWeather's free site for the requested location.

  • RealFeelTemperature | null

    An object containing the AccuWeather patented RealFeel™ temperature with a rounded value for Fahrenheit or Celsius. The object may be NULL.

  • RealFeelTemperatureShade | null

    An object containing the AccuWeather patented RealFeel™ shade temperature with a rounded value for Fahrenheit or Celsius. The object may be NULL.

  • RelativeHumidityinteger · int32

    A measure of moisture in the air, expressed as a percentage of the maximum amount possible at the same temperature.

  • IndoorRelativeHumidityinteger | null · int32

    A measure of moisture in the air inside a typical heated home, expressed as a percentage of the maximum amount possible at the same temperature. At temperatures above 68°F this is set to the outdoor relative humidity.

  • DewPoint | null

    The temperature at which the humidity in the air will begin to condense on surfaces. The object contains a rounded value for Fahrenheit and Celsius. The object may be NULL.

  • Wind | null

    An object containing wind direction and speed information with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • WindGust | null

    An object containing information about the maximum short-burst wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • UVIndexinteger | null · int32

    A numerical value that indicates the sun's measured ultraviolet radiation strength.

  • UVIndexFloatnumber | null · float

    A decimal value that indicates the sun's measured ultraviolet radiation strength.

  • UVIndexTextstring | null

    A brief UV index status description.

  • Visibility | null

    An object containing information about visibility distance with a rounded value for Miles and Kilometer. The object may be NULL.

  • ObstructionsToVisibilitystring | null

    The visibility distance's limiting factor.

  • CloudCoverinteger | null · int32

    A number representing the percentage of the sky that is covered by clouds. May be NULL.

  • Ceiling | null

    An object containing information about the cloud base elevation with a rounded value for Feet and Meter. The object may be NULL.

  • Pressure | null

    An object containing information about the measured air pressure at ground level with a rounded value for Inches of Mercury and Millibar. The object may be NULL.

  • PressureTendency | null

    An object containing information about the atmospheric pressure change.

  • Past24HourTemperatureDeparture | null

    An object containing information about departure from the temperature observed 24 hours ago with rounded values for Fahrenheit and Celsius. The object may be NULL.

  • WindChillTemperature | null

    An object containing information about perceived air temperature on exposed skin due to wind with rounded values for Fahrenheit and Celsius. The object may be NULL.

  • WetBulbTemperature | null

    The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation. An object containing a rounded value for Fahrenheit and Celsius. The object may be NULL.

  • WetBulbGlobeTemperature | null

    A temperature value that indicates heat stress on the human body in direct sunlight based on temperature, humidity, wind speed, sun angle, and cloud cover. An object containing a rounded value for Fahrenheit and Celsius. The object may be NULL.

  • Precip1hr | null

    Amount of liquid water equivalent of precipitation that has fallen in the past hour. An object containing a rounded value for Inch and Millimeter. The object may be NULL.

  • PrecipitationSummary | null

    Summary of precipitation amounts over the past 24 hours, in 3-hour increments.

  • TemperatureSummary | null

    Summary of temperature fluctuations over the past 6, 12, and 24 hours.

  • ApparentTemperature | null

    Perceived outdoor temperature caused by the combination of air temperature, relative humidity, and wind speed.

API.CurrentConditions.Entities.OpenAPI.CurrentConditionsPoint

  • typestring · minLength: 1 · required
  • featuresobject[] · required

API.CurrentConditions.Entities.OpenAPI.CurrentConditionsPointProperties

  • stationCodestring · minLength: 1 · required

    Code that represents a specific the weather station.

  • stationNamestring · minLength: 1 · required

    Name of the weather station.

  • stationWeightinteger · int32 · required

    Weight of weather station.

  • weatherIconinteger · int32 · required

    Numeric value representing an image that displays the WeatherText.

  • hasPrecipitationboolean · required

    Flag indicating the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation.

  • precipitationTypestring · minLength: 1 · required

    If precipitation is present, the type of precipitation will be returned. Possible values are Rain, Snow, Ice, or Mixed. Null in the absence of precipitation.

  • temperaturenumber · float · required

    The observed air temperature at the requested location as a rounded value in the specified units, Fahrenheit or Celsius. The value may be NULL.

  • realFeelTemperaturenumber · float · required

    The patented AccuWeather RealFeel™ temperature as a rounded value in the specified units, Fahrenheit or Celsius. The value may be NULL.

  • realFeelTemperaturePhrasestring · minLength: 1 · required

    Short phrase to describe the current conditions of a location based on AccuWeather's patented RealFeel™ temperature.

  • realFeelTemperatureShadenumber · float · required

    The patented AccuWeather RealFeel™ shade temperature as a rounded value in the specified units, Fahrenheit or Celsius. The value may be NULL.

  • realFeelTemperatureShadePhrasestring · minLength: 1 · required

    Short phrase to describe the current conditions, while in the shade, of a location based on AccuWeather's patented RealFeel™ temperature.

  • relativeHumidityinteger · int32 · required

    A measure of water vapor in the air, expressed as a percentage of the amount needed for saturation.

  • dewPointnumber · float · required

    The temperature at which the humidity in the air will begin to condense on surfaces. It is a rounded value in the specified units, Fahrenheit or Celsius. The value may be NULL.

  • windDirectionDegreesinteger · int32 · required

    Wind direction in azimuth degrees from north (180° indicates a wind coming from the south).

  • windDirectionLocalizedstring · minLength: 1 · required

    A wind direction abbreviation in the specified language.

  • windDirectionEnglishstring · minLength: 1 · required

    An English wind direction abbreviation.

  • windSpeednumber · float · required

    The measured wind speed as a rounded value in the specified units, Miles per hour or Kilometer per hour. The value may be NULL.

  • windGustnumber · float · required

    The maximum short-burst wind speed as a rounded value in the specified units, Miles per hour or Kilometer per hour. The value may be NULL.

  • uvIndexinteger · int32 · required

    A numerical value that indicates the sun's measured ultraviolet radiation strength. The value may be NULL.

  • visibilitynumber · float · required

    The visibility distance as a rounded value in the specified units, Miles or Kilometer per hour. The value may be NULL.

  • pressurenumber · float · required

    The measured air pressure at ground level as a rounded value for Inches of Mercury and Millibar. The value may be NULL.

  • Past24HourTemperatureDeparturenumber · float · required

    Departure from the temperature observed 24 hours ago. It is a rounded value in the specified units, Fahrenheit or Celsius. The value may be NULL.

  • past1HourPrecipitationnumber · float · required

    Amount of liquid water equivalent of precipitation that has fallen in the past hour. It is a rounded value in the specified units, Inch or Millimeter. The value may be NULL..

  • past3HourPrecipitationnumber · float · required

    Amount of liquid water equivalent of precipitation that has fallen in the past 3 hours. It is a rounded value in the specified units, Inch or Millimeter. The value may be NULL.

  • past6HourPrecipitationnumber · float · required

    Amount of liquid water equivalent of precipitation that has fallen in the past 6 hours. It is a rounded value in the specified units, Inch or Millimeter. The value may be NULL.

  • past9HourPrecipitationnumber · float · required

    Amount of liquid water equivalent of precipitation that has fallen in the past 9 hours. It is a rounded value in the specified units, Inch or Millimeter. The value may be NULL.

  • past12HourPrecipitationnumber · float · required

    Amount of liquid water equivalent of precipitation that has fallen in the past 12 hours. It is a rounded value in the specified units, Inch or Millimeter. The value may be NULL..

  • past18HourPrecipitationnumber · float · required

    Amount of liquid water equivalent of precipitation that has fallen in the past 18 hours. It is a rounded value in the specified units, Inch or Millimeter. The value may be NULL.

  • past24HourPrecipitationnumber · float · required

    Amount of liquid water equivalent of precipitation that has fallen in the past 24 hours. It is a rounded value in the specified units, Inch or Millimeter. The value may be NULL.

API.CurrentConditions.Entities.OpenAPI.Direction

  • Degreesinteger · int32 · required

    Wind direction in azimuth degrees from north (180° indicates a wind coming from the south).

  • Localizedstring · minLength: 1 · required

    A wind direction abbreviation in the specified language.

  • Englishstring · minLength: 1 · required

    An English wind direction abbreviation.

API.CurrentConditions.Entities.OpenAPI.GeoPosition

  • Elevationrequired

    An object containing information about elevation of the the city above sea level with with a rounded value for Feet and Meter. The object may be NULL.

  • Latitudenumber · float · required
  • Longitudenumber · float · required

API.CurrentConditions.Entities.OpenAPI.LocalCurrentConditions

  • LocalObservationDateTimestring · date-time · required

    The date and time at which the data was collected, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochTimeinteger · int64 · required

    The date and time at which the data was collected, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • WeatherTextstring · minLength: 1 · required

    A phrase describing the current weather conditions in the specified language.

  • WeatherIconinteger · int32 · required

    A numeric value representing an image that displays the phrase returned in the WeatherText parameter.

  • HasPrecipitationboolean · required

    A flag indicating the presence or absence of precipitation. A true response indicates precipitation, false indicates no precipitation.

  • PrecipitationTypestring · minLength: 1 · required

    The type of precipitation, if any. Possible values are Rain, Snow, Ice, Mixed, or Null for no precipitation.

  • IsDayTimeboolean · required

    Information specific to the local data source. This parameter is not returned if there is no local source information.

  • Temperaturerequired

    An object containing information about the observed air temperature at the requested location.

  • MobileLinkstring · minLength: 1 · required

    Link to current conditions on AccuWeather's mobile site for the requested location.

  • Linkstring · minLength: 1 · required

    Link to current conditions on AccuWeather's free site for the requested location.

  • RealFeelTemperature | null

    AccuWeather's patented RealFeel™ temperature. A temperature value that uses a variety of factors to determine how the temperature actually feels outside.

  • RealFeelTemperatureShade | null

    AccuWeather's patented RealFeel™ shade temperature. A temperature value that uses a variety of factors to determine how the temperature actually feels outside in the shade.

  • RelativeHumidityinteger · int32

    A measure of moisture in the air, expressed as a percentage of the maximum amount possible at the same temperature.

  • IndoorRelativeHumidityinteger | null · int32

    A measure of moisture in the air inside a typical heated home, expressed as a percentage of the maximum amount possible at the same temperature. At temperatures above 68°F this is set to the outdoor relative humidity.

  • DewPoint | null

    The temperature at which the humidity in the air will begin to condense on surfaces.

  • Wind | null

    An object containing wind direction and speed information.

  • WindGust | null

    An object containing information about the maximum short-burst wind speed.

  • UVIndexinteger | null · int32

    A numerical value that indicates the sun's measured ultraviolet radiation strength.

  • UVIndexFloatnumber | null · float

    A decimal value that indicates the sun's measured ultraviolet radiation strength.

  • UVIndexTextstring | null

    A brief UV index status description.

  • Visibility | null

    An object containing information about visibility distance.

  • ObstructionsToVisibilitystring | null

    The visibility distance's limiting factor.

  • CloudCoverinteger | null · int32

    A number representing the percentage of the sky that is covered by clouds. May be NULL.

  • Ceiling | null

    An object containing information about the cloud base elevation.

  • Pressure | null

    An object containing information about the measured air pressure at ground level.

  • PressureTendency | null

    Atmospheric pressure change

  • Past24HourTemperatureDeparture | null

    Departure from the temperature observed 24 hours ago.

  • WindChillTemperature | null

    Perceived air temperature on exposed skin due to wind.

  • WetBulbTemperature | null

    The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation.

  • WetBulbGlobeTemperature | null

    A temperature value that indicates heat stress on the human body in direct sunlight based on temperature, humidity, wind speed, sun angle, and cloud cover.

  • Precip1hr | null

    Amount of liquid water equivalent of precipitation that has fallen in the past hour.

  • PrecipitationSummary | null

    Summary of precipitation amounts over the past 24 hours, in 3-hour increments.

  • TemperatureSummary | null

    Summary of temperature fluctuations over the past 6, 12, and 24 hours.

  • ApparentTemperature | null

    Perceived outdoor temperature caused by the combination of air temperature, relative humidity, and wind speed.

API.CurrentConditions.Entities.OpenAPI.LocalSource

  • Idinteger · int32 · required

    A numeric identifier unique to the local data provider.

  • Namestring · minLength: 1 · required

    The local data provider's name, displayed in the requested language if it is available. Otherwise the name is displayed in English or the language in which the name was provided.

  • WeatherCodestring · minLength: 1 · required

    A unique code provided by the local data provider. This code allows the current condition to be matched to icons provided by the local data provider instead of AccuWeather's icons.

API.CurrentConditions.Entities.OpenAPI.ObservationSummary

  • localObservationDateTimestring · date-time · required

    The date and time at which the data was collected, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochTimeinteger · int64 · required

    The date and time at which the data was collected, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • WeatherTextstring · minLength: 1 · required

    A phrase describing the current weather conditions in the specified language.

  • WeatherIconinteger · int32 · required

    A numeric value representing an image that displays the phrase returned in the WeatherText parameter.

  • HasPrecipitationboolean · required

    A flag indicating the presence or absence of precipitation. A true response indicates precipitation, false indicates no precipitation.

  • PrecipitationTypestring · minLength: 1 · required

    The type of precipitation, if any. Possible values are Rain, Snow, Ice, Mixed, or Null for no precipitation.

  • IsDayTimeboolean · required

    A boolean flag that indicates the day/night status. True at daytime, false at nighttime.

  • Temperaturerequired

    An object containing information about the observed air temperature at the requested location with a rounded value for Fahrenheit and Celsius. The object may be NULL.

  • MobileLinkstring · minLength: 1 · required

    Link to current conditions on AccuWeather's mobile site for the requested location.

  • Linkstring · minLength: 1 · required

    Link to current conditions on AccuWeather's free site for the requested location.

API.CurrentConditions.Entities.OpenAPI.PastHourRange

  • Minimumrequired

    An object containing a rounded value for Fahrenheit and Celsius. The object may be NULL

  • Maximumrequired

    An object containing a rounded value for Fahrenheit and Celsius. The object may be NULL

API.CurrentConditions.Entities.OpenAPI.Phrase

  • DataCodestring · minLength: 1 · required

    A code phrase to briefly describe current conditions.

  • Flagboolean · required

    Flag indicating the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation.

  • PrecipitationTypestring · minLength: 1 · required

    The type of precipitation, if any. Possible values are Rain, Snow, Ice, Mixed, or Null for no precipitation.

  • PhraseCodeinteger · int64 · required

    An integer that maps to a given DataCode.

API.CurrentConditions.Entities.OpenAPI.PrecipitationSummary

  • Precipitationrequired

    Deprecated. Please use the precipitation summary for a specific time span.

  • PastHourrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past hour. An object containing a rounded value for Inch and Millimeter. The object may be NULL.

  • Past3Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past three hours. An object containing a rounded value for Inch and Millimeter. The object may be NULL

  • Past6Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past six hours. An object containing a rounded value for Inch and Millimeter. The object may be NULL

  • Past9Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past nine hours. An object containing a rounded value for Inch and Millimeter. The object may be NULL

  • Past12Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours. An object containing a rounded value for Inch and Millimeter. The object may be NULL

  • Past18Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours. An object containing a rounded value for Inch and Millimeter. The object may be NULL

  • Past24Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours. An object containing a rounded value for Inch and Millimeter. The object may be NULL

API.CurrentConditions.Entities.OpenAPI.PrecipitationSummaryMetric

  • Precipitationrequired

    Deprecated. Please use the precipitation summary for a specific time span.

  • PastHourrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past hour. Contains Metric and Imperial Values.

  • Past3Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past three hours. Contains Metric and Imperial Values.

  • Past6Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past six hours. Contains Metric and Imperial Values.

  • Past9Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past nine hours. Contains Metric and Imperial Values.

  • Past12Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours. Contains Metric and Imperial Values.

  • Past18Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours. Contains Metric and Imperial Values.

  • Past24Hoursrequired

    The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours. Contains Metric and Imperial Values.

API.CurrentConditions.Entities.OpenAPI.TemperatureSummary

  • Past6HourRangerequired

    Summary of temperature fluctuations over the past 6 hours.

  • Past12HourRangerequired

    Summary of temperature fluctuations over the past 12 hours.

  • Past24HourRangerequired

    Summary of temperature fluctuations over the past 24 hours.

API.CurrentConditions.Entities.OpenAPI.TemperatureSummaryMetric

  • Past6HourRangerequired

    An object containing temperature minimum and maximum over the past 6 hours.

  • Past12HourRangerequired

    An object containing temperature minimum and maximum over the past 12 hours.

  • Past24HourRangerequired

    An object containing temperature minimum and maximum over the past 24 hours.

API.CurrentConditions.Entities.OpenAPI.TimeZone

  • Codestring · minLength: 1 · required

    Official abbreviation code for designated Time Zone.

  • Namestring · minLength: 1 · required

    Official name of designated Time Zone.

  • GmtOffsetnumber · float · required

    Number of hours offset from local GMT time.

  • IsDaylightSavingboolean · required

    A “true” or “false” verification of whether a location is currently observing Day Light Saving time.

  • NextOffsetChangestring · date-time · required

    Next time that daylight saving time changes.

API.CurrentConditions.Entities.OpenAPI.TopCityCurrentConditions

  • Keystring · minLength: 1 · required

    Unique ID to search a location.

  • LocalizedNamestring · minLength: 1 · required

    Display name in local dialect set with language code in URL. Default is US English (us-en).

  • EnglishNamestring · minLength: 1 · required

    Location name as displayed in English.

  • Countryrequired

    An object containing country information.

  • TimeZonerequired

    An object containing timezone information.

  • GeoPositionrequired

    An object containing geoposition information.

  • LocalObservationDateTimestring · date-time · required

    Datetime of the current observation displayed in ISO8601 format: yyyy-mm-ddThh:mm:ss±hh:mm.

  • EpochTimeinteger · int64 · required

    Datetime of the current observation displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • WeatherTextstring · minLength: 1 · required

    Phrase description of the current weather condition. Displayed in specified language.

  • WeatherIconinteger · int64 · required

    Numeric value representing an image that displays the WeatherText.

  • HasPrecipitationboolean · required

    Flag indicating the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation.

  • PrecipitationTypestring · minLength: 1 · required

    If precipitation is present, the type of precipitation will be returned. Possible values are Rain, Snow, Ice, or Mixed. Null in the absence of precipitation.

  • IsDayTimeboolean · required

    Flag indicating the time of day (true=>day, false=>night).

  • Temperaturerequired

    An object containing temperature information with a rounded value for Fahrenheit and Celsius. The object may be NULL.

  • MobileLinkstring · minLength: 1 · required

    Link to current conditions on AccuWeather's mobile site for the requested location.

  • Linkstring · minLength: 1 · required

    Link to current conditions on AccuWeather's free site for the requested location.

  • LocalSource | null

    Information specific to the local data source. This parameter is not returned if there is no local source information.

API.CurrentConditions.Entities.OpenAPI.Wind

  • Directionrequired

    An object containing wind direction in azimuth degrees.

  • Speedrequired

    An object containing information about wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

API.CurrentConditions.Entities.OpenAPI.WindGust

  • Speedrequired

    An object containing information about the maximum wind gust speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

API.CurrentConditions.Entities.OpenAPI.WindGustMetric

  • Speedrequired

    An object containing information about the maximum wind gust speed.

API.CurrentConditions.Entities.OpenAPI.WindMetric

  • Directionrequired

    An object containing wind direction in azimuth degrees.

  • Speedrequired

    An object containing information about wind speed.

Common.OpenAPISpecification.Entities.ErrorResponse

  • Codeinteger · int32 · required

    The HTTP status code generated by the origin server for this occurrence of the problem (legacy).

  • Messagestring · minLength: 1 · required

    The error message describing the problem (legacy).

  • Referencestring · minLength: 1 · required

    A URL reference that identifies the specific occurrence of the problem (legacy).

  • typestring · uri · required

    A URI reference [RFC3986] that identifies the problem type. This is aligned with RFC 7807.

    Example: https://httpproblems.com/http-status/401
  • titlestring · required

    A short, human-readable summary of the problem type. This is aligned with RFC 7807.

    Example: Unauthorized
  • statusinteger · required

    The HTTP status code generated by the origin server for this occurrence of the problem. This is aligned with RFC 7807.

    Example: 401
  • instancestring · uri-reference · required

    A URI reference that identifies the specific occurrence of the problem. This is aligned with RFC 7807.

    Example: /locations/v1/349727
  • traceobject · required

    Contains custom diagnostic information about the request.

Common.OpenAPISpecification.Entities.Feature`1[[AccuWeather.NetStandard.API.CurrentConditions.Entities.OpenAPI.CurrentConditionsPointProperties, AccuWeather.NetStandard.API.CurrentConditions, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

  • typestring · minLength: 1 · required
  • geometryrequired
  • propertiesrequired

Common.OpenAPISpecification.Entities.Geometry

  • typestring · minLength: 1 · required
  • coordinatesnumber[] · required

Common.OpenAPISpecification.Entities.PressureTendency

  • localizedTextstring · minLength: 1 · required
  • codestring · minLength: 1 · required

Common.OpenAPISpecification.Entities.Quantity

  • UnitTypeinteger · int64 · required
  • Valuenumber · float · required
  • Unitstring · minLength: 1 · required

Common.OpenAPISpecification.Entities.QuantityMeasurements

  • Metricrequired
  • Imperialrequired

Common.OpenAPISpecification.Entities.QuantityPhrase

  • UnitTypeinteger · int64 · required
  • Valuenumber · float · required
  • Unitstring · minLength: 1 · required
  • Phrasestring

Common.OpenAPISpecification.Entities.QuantityPhraseMeasurements

  • Metricrequired
  • Imperialrequired

Common.OpenAPISpecification.Entities.QuantityRange

  • Minimumrequired
  • Maximumrequired

API.Forecasts.Daily.Entities.OpenAPI.AirQuality

  • Namestring · minLength: 1 · required

    Name of the pollen or pollutant. For example: grass, mold, weed, air quality, tree and UV index.

  • Valueinteger · int32 · required

    Value of the given type above. Values associated with mold, grass, weed and tree are in units of parts per cubic meter. Both air quality and UV are indices, so they are unitless.

  • Categorystring · minLength: 1 · required

    Category of the air quality or pollution type. For example: low, high, good, moderate, unhealthy, hazardous.

  • CategoryValueinteger · int64 · required

    Value associated with the air quality or pollution category. These values range from 1 to 6. 1 implying good conditions, 6 implying hazardous conditions.

  • Typestring | null

    Only exists for air quality. Examples include ozone and particle pollution.

API.Forecasts.Daily.Entities.OpenAPI.DailyForecast

  • Datestring · date-time · required

    Date of the forecast displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochDateinteger · int64 · required

    Date of the forecast displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • Temperaturerequired

    An object containing the forecasted temperature with a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • Dayrequired

    Object containing details about the day.

  • Nightrequired

    Object containing detailsa about the night.

  • Sourcesstring[] · required

    List of forecast sources.

  • MobileLinkstring · minLength: 1 · required

    Link to daily forecasts on AccuWeather's mobile site for the requested location.

  • Linkstring · minLength: 1 · required

    Link to daily forecasts on AccuWeather's free site for the requested location.

  • Sun | null

    Object containing details about the sun.

  • Moon | null

    Object containing details about the moon.

  • RealFeelTemperature | null

    An object containing the patented AccuWeather RealFeel™ temperature with a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • RealFeelTemperatureShade | null

    An object containing the patented AccuWeather RealFeel™ shade temperature with a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • HoursOfSunnumber | null · float

    Number of hours of sun.

  • DegreeDaySummary | null

    Summary of Heating Degree Day or Cooling Degree Day information.

  • AirAndPollenarray | null

    List of air quality and pollutants.

API.Forecasts.Daily.Entities.OpenAPI.DailyForecastSummary

  • Headlinerequired

    Represents the most significant weather event over the next five days, regardless of selected timespan.

  • DailyForecastsobject[] · required

    Forecasts for each 12-hour period.

API.Forecasts.Daily.Entities.OpenAPI.Day

  • Iconinteger · int32 · required

    Numeric value representing an icon that matches the forecast.

  • IconPhrasestring · minLength: 1 · required

    Phrase description of the Icon.

  • HasPrecipitationboolean · required

    Boolean value that indicates the presence of any type of precipitation. Displays true if precipitation is present.

  • PrecipitationTypestring · minLength: 1 · required

    Indicates if the precipitation is rain, snow, ice, or mixed. Only returned if HasPrecipitation is true.

  • PrecipitationIntensitystring | null

    Indicates if the precipitation strength is light, moderate, or heavy. Only returned if HasPrecipitation is true.

  • ShortPhrasestring | null

    Phrase description of the forecast. (Note: AccuWeather attempts to keep this phrase under 30 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 30 characters.).

  • LongPhrasestring | null

    Phrase description of the forecast. (Note: AccuWeather attempts to keep this phrase under 100 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 100 characters.).

  • PrecipitationProbabilityinteger | null · int32

    A percentage value representing the probability of precipitation.

  • ThunderstormProbabilityinteger | null · int32

    A percentage value representing the probability of a thunderstorm.

  • RainProbabilityinteger | null · int32

    A percentage value representing the probability of rain.

  • SnowProbabilityinteger | null · int32

    A percentage value representing the probability of snow.

  • IceProbabilityinteger | null · int32

    A percentage value representing the probability of ice.

  • Wind | null

    An object containing wind direction and speed information with a rounded value in the specified units, Miles per hour or Kilometer per hour. The object may be NULL.

  • WindGust | null

    An object containing information about the maximum short-burst wind speed with a rounded value in the specified units, Miles per hour or Kilometer per hour. The object may be NULL.

  • TotalLiquid | null

    A measurement of total liquid for the 12-hour period. An object with a rounded value in the specified units, Inch or Millimeter. The object may be NULL.

  • Rain | null

    A measurement of rain for the 12-hour period. An object with a rounded value in the specified units, Inch or Millimeter. The object may be NULL.

  • Snow | null

    A measurement of snow for the 12-hour period. An object with a rounded value in the specified units, Inch or Centimeter. The object may be NULL.

  • Ice | null

    A measurement of ice for the 12-hour period. An object with a rounded value in the specified units, Inch or Millimeter. The object may be NULL.

  • HoursOfPrecipitationnumber | null · float

    The total number of hours containing any type of precipitation in the indicated 12-hour period.

  • HoursOfRainnumber | null · float

    The total number of hours containing rain in the indicated 12-hour period.

  • HoursOfSnownumber | null · float

    The total number of hours containing snowfall in the indicated 12-hour period.

  • HoursOfIcenumber | null · float

    The total number of hours containing ice precipitation in the indicated 12-hour period.

  • CloudCoverinteger · int32

    The percentage of cloud cover.

  • Evapotranspiration | null

    Soil water loss by evaporation and plant transpiration. An object with a rounded value in the specified units, Inch or Millimeter. The object may be NULL.

  • SolarIrradiance | null

    The sun's electromagnetic radiation (global horizontal irradiance) as measured at the Earth's surface. An object with a rounded value in Watts per square Meter. The object may be NULL.

  • RelativeHumidity | null

    A measure of water vapor in the air, expressed as a percentage of the amount needed for saturation.

  • WetBulbTemperature | null

    The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation. The object contains a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • WetBulbGlobeTemperature | null

    A temperature value that indicates heat stress on the human body in direct sunlight based on temperature, humidity, wind speed, sun angle, and cloud cover. The object contains a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • UVIndexFloat | null

    An object containing the sun's measured ultraviolet radiation strength.

API.Forecasts.Daily.Entities.OpenAPI.DegreeDaySummary

  • Heatingrequired

    Number of degrees that the mean temperature is below 65 degrees F. An object with a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • Coolingrequired

    Number of degrees that the mean temperature is above 65 degrees F. An object with a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

API.Forecasts.Daily.Entities.OpenAPI.Headline

  • EffectiveDatestring · date-time · required

    Datetime displayed in ISO8601 format: yyyy-mm-ddThh:mm:ss±hh:mm that the headline is in effect.

  • EffectiveEpochDateinteger · int64 · required

    Effective datetime of the headline displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • Severityinteger · int32 · required

    Severity of the headline displayed as an integer. The lower the number, the greater the severity.

  • Textstring · minLength: 1 · required

    Text of the headline.

  • Categorystring · minLength: 1 · required

    Category of the headline.

  • EndDatestring · date-time · required

    Datetime displayed in ISO8601 format: yyyy-mm-ddThh:mm:ss±hh:mm that the headline period ends.

  • EndEpochDateinteger · int64 · required

    End datetime of the headline displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • MobileLinkstring · minLength: 1 · required

    Link to extended forecasts on AccuWeather's mobile site for the requested location.

  • Linkstring · minLength: 1 · required

    Link to extended forecasts on AccuWeather's free site for the requested location.

API.Forecasts.Daily.Entities.OpenAPI.HumidityRange

  • Minimuminteger · int32

    The lowest observed water vapor amount expressed as a percentage of the amount needed for saturation, measured over the indicated 12-hour period.

  • Maximuminteger · int32

    The highest observed water vapor amount expressed as a percentage of the amount needed for saturation, measured over the indicated 12-hour period.

  • Averageinteger · int32

    The average observed water vapor amount expressed as a percentage of the amount needed for saturation, measured over the indicated 12-hour period.

API.Forecasts.Daily.Entities.OpenAPI.IndexRange

  • Minimumnumber | null · float

    A numerical value that indicates the sun's maximum measured ultraviolet radiation strength.

  • Maximumnumber | null · float

    A numerical value that indicates the sun's minimum measured ultraviolet radiation strength.

API.Forecasts.Daily.Entities.OpenAPI.Moon

  • Risestring · date-time · required

    Moon rise displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochRiseinteger · int64 · required

    Moon rise displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • Setstring · date-time · required

    Moon set displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochSetinteger · int64 · required

    Moon set displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • Phasestring · minLength: 1 · required

    The phase of the moon.

  • Ageinteger · int32 · required

    The number of days since the new moon.

API.Forecasts.Daily.Entities.OpenAPI.Sun

  • Risestring · date-time · required

    Sun rise displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochRiseinteger · int64 · required

    Sun rise displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • Setstring · date-time · required

    Sun set displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochSetinteger · int64 · required

    Sun set displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

Common.OpenAPISpecification.Entities.Direction

  • Degreesinteger · int32 · required
  • Localizedstring · minLength: 1 · required
  • Englishstring · minLength: 1 · required

Common.OpenAPISpecification.Entities.QuantityPhraseRangeMeasurement

  • Minimumrequired
  • Maximumrequired

Common.OpenAPISpecification.Entities.QuantityRangeAverage

  • Minimumrequired
  • Maximumrequired
  • Average

Common.OpenAPISpecification.Entities.Wind

  • Speedrequired
  • Direction

API.Forecasts.Hourly.Entities.OpenAPI.HourlyForecast

  • DateTimestring · date-time · required

    Datetime of the forecast displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochDateTimeinteger · int64 · required

    Datetime of the forecast displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • WeatherIconinteger · int32 · required

    Numeric value representing an image that displays the IconPhrase.

  • IconPhrasestring · minLength: 1 · required

    Phrase description of the forecast. Displayed in specified language.

  • HasPrecipitationboolean · required

    Boolean value that indicates the presence of any type of precipitation. Displays true if precipitation is present.

  • IsDaylightboolean · required

    Boolean value (true or false) that specifies whether or not it is daylight.

  • Temperaturerequired

    An object containing the forecasted temperature with a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • PrecipitationProbabilityinteger · int32 · required

    A percentage value representing the probability of precipitation.

  • accuLumenBrightnessIndexnumber · float · required
  • MobileLinkstring · minLength: 1 · required

    Link to hourly forecasts on AccuWeather's mobile site for the requested location.

  • Linkstring · minLength: 1 · required

    Link to hourly forecasts on AccuWeather's free site for the requested location.

  • PrecipitationTypestring | null

    Indicates if the precipitation is rain, snow, ice, or mixed. Only returned if HasPrecipitation is true.

  • PrecipitationIntensitystring | null

    Indicates if the precipitation strength is light, moderate, or heavy. Only returned if HasPrecipitation is true.

  • RealFeelTemperature | null

    An object containing the patented AccuWeather RealFeel™ temperature with a rounded value in the specified units, Fahrenheit or Celsius. The object also contains a brief description of how warm or cold the temperature actually feels outside. The object may be NULL.

  • RealFeelTemperatureShade | null

    An object containing the patented AccuWeather RealFeel™ shade temperature with a rounded value in the specified units, Fahrenheit or Celsius. The object also contains a brief description of how warm or cold the temperature actually feels outside. The object may be NULL.

  • WetBulbTemperature | null

    The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation. The object contains a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • WetBulbGlobeTemperature | null

    A temperature value that indicates heat stress on the human body in direct sunlight based on temperature, humidity, wind speed, sun angle, and cloud cover. The object contains a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • DewPoint | null

    The temperature at which the humidity in the air will begin to condense on surfaces. The object contains a rounded value in the specified units, Fahrenheit or Celsius. The object may be NULL.

  • Wind | null

    An object containing wind direction and speed information with a rounded value in the specified units, Miles per hour or Kilometer per hour. The object may be NULL.

  • WindGust | null

    An object containing information about the maximum short-burst wind speed with a rounded value in the specified units, Miles per hour or Kilometer per hour. The object may be NULL.

  • RelativeHumidityinteger | null · int32

    A measure of water vapor in the air, expressed as a percentage of the amount needed for saturation.

  • IndoorRelativeHumidityinteger | null · int32

    A measure of moisture in the air inside a typical heated home, expressed as a percentage of the maximum amount possible at the same temperature. At temperatures above 68°F this is set to the outdoor relative humidity.

  • Visibility | null

    An object containing information about visibility distance with a rounded value in the specified units, Miles or Kilometer. The object may be NULL.

  • Ceiling | null

    An object containing information about the cloud base elevation with a rounded value in the specified units, Feet or Meter. The object may be NULL.

  • UVIndexinteger · int32

    A numerical value that indicates the sun's measured ultraviolet radiation strength.

  • UVIndexFloatnumber · float

    A decimal value that indicates the sun's measured ultraviolet radiation strength.

  • UVIndexTextstring | null

    Text associated with the UVIndex.

  • ThunderstormProbabilityinteger | null · int32

    A percentage value representing the probability of a thunderstorm.

  • RainProbabilityinteger | null · int32

    A percentage value representing the probability of rain.

  • SnowProbabilityinteger · int64

    A percentage value representing the probability of snow.

  • IceProbabilityinteger | null · int32

    A percentage value representing the probability of ice.

  • TotalLiquid | null

    A measurement of total liquid for the hour. An object with a rounded value in the specified units, Inch or Millimeter. The object may be NULL.

  • Rain | null

    A measurement of rain for the hour. An object with a rounded value in the specified units, Inch or Millimeter. The object may be NULL.

  • Snow | null

    A measurement of snow for the hour. An object with a rounded value in the specified units, Inch or Centimeter. The object may be NULL.

  • Ice | null

    A measurement of ice for the hour. An object with a rounded value in the specified units, Inch or Millimeter. The object may be NULL.

  • CloudCoverinteger | null · int32

    The percentage of cloud cover.

  • Evapotranspiration | null

    Soil water loss by evaporation and plant transpiration. An object with a rounded value in the specified units, Inch or Millimeter. The object may be NULL.

  • SolarIrradiance | null

    The sun's electromagnetic radiation (global horizontal irradiance) as measured at the Earth's surface. An object with a rounded value in Watts per square Meter. The object may be NULL.

API.Forecasts.Hourly.Entities.OpenAPI.HourlyForecastPoint

  • dateTimestring · date-time · required

    Datetime of the forecast displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • featureCollectionrequired

API.Forecasts.Hourly.Entities.OpenAPI.HourlyForecastPointFeature

  • featuresobject[] · required
  • typestring · minLength: 1 · required

API.Forecasts.Hourly.Entities.OpenAPI.HourlyForecastPointProperties

  • stationCodestring · minLength: 1 · required

    The weather station code of the location.

  • rainnumber · float · required

    A measurement of rain for the hour.

  • rainUnitstring · minLength: 1 · required

    THe unit of measurement for the rain.

  • snownumber · float · required

    A measurement of snow for the hour.

  • snowUnitstring · minLength: 1 · required

    The unit of measurement for the snow.

  • icenumber · float · required

    A measurement of ice for the hour.

  • iceUnitstring · minLength: 1 · required

    The unit of measurement for the ice.

  • totalLiquidnumber · float · required

    A measurement of total liquid for the hour.

  • totalLiquidUnitstring · minLength: 1 · required

    The unit of measurement for the total liquid.

  • stationNamestring | null

    The name of the weather station.

  • stationWeightinteger · int32

    A number representing the importantance of the weather station.

  • stationOffsetnumber · float

    The GMT offset of the weather station.

  • weatherIconinteger | null · int32

    Numeric value representing an image that displays the IconPhrase.

  • iconPhrasestring | null

    Phrase description of the forecast. Displayed in specified language.

  • temperaturenumber | null · float

    The forecasted temperature for the hour.

  • temperatureUnitstring | null

    The unit of measurement for the temperature.

  • realFeelTemperaturenumber | null · float

    The forecasted patented AccuWeather RealFeel™ temperature for the hour.

  • realFeelTemperatureUnitstring | null

    The unit of measurement for the patented AccuWeather RealFeel™ temperature.

  • realFeelTemperaturePhrasestring | null

    A phrase representing the patented AccuWeather RealFeel™ temperature.

  • windDirectionDegreesnumber · float

    Angular measurement of the wind direction.

  • windDirectionEnglishstring | null

    Abbreviated text value of the wind direction.

  • windDirectionLocalizedstring | null

    Abbreviated text value of the wind direction in the requested language.

  • windSpeednumber | null · float

    Linear measurement of the wind speed.

  • windSpeedUnitstring | null

    The unit of measurment for the wind speed.

  • windGustnumber | null · float

    Linear measurement of the wind gust.

  • windGustUnitstring | null

    The unit of measurment for the wind gust.

  • hasPrecipitationboolean

    Boolean value that indicates the presence of any type of precipitation. Displays true if precipitation is present.

  • precipitationTypestring | null

    Indicates if the precipitation is rain, snow, ice, or mixed. Only returned if HasPrecipitation is true.

  • precipitationIntensitystring | null

    Indicates if the precipitation strength is light, moderate, or heavy. Only returned if HasPrecipitation is true.

Common.OpenAPISpecification.Entities.Feature`1[[AccuWeather.NetStandard.API.Forecasts.Hourly.Entities.OpenAPI.HourlyForecastPointProperties, AccuWeather.NetStandard.API.Forecasts.Hourly, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

  • typestring · minLength: 1 · required
  • geometryrequired
  • propertiesrequired

API.Locations.Entities.OpenAPI.AdministrativeArea

  • Levelinteger · int64 · required

    An assigned number to describe the scale of the administrative subdivisions for countries. As the Level number increases, the scale of the subdivision will decrease. Numbers of 10 or greater are reserved for non-political boundaries and should be used independently

  • CountryIDstring · minLength: 1 · required

    Unique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.

  • IDstring · minLength: 1 · required

    Unique administrative area ID

  • LocalizedNamestring · minLength: 1 · required

    Administrative area name as displayed in local dialect set with language code in the URL. If no language code is selected, the default is English

  • EnglishNamestring · minLength: 1 · required

    Administrative area name displayed in English

  • LocalizedTypestring | null

    Administrative Area type displayed in the local dialect set with the language code in the URL. Default is US English (en-us).

  • EnglishTypestring | null

    Administrative Area type displayed in English.

API.Locations.Entities.OpenAPI.AppPartnership

  • Typestring · minLength: 1 · required

    The type of partnership

API.Locations.Entities.OpenAPI.Area

  • IDstring · minLength: 1 · required

    Unique administrative area ID

  • LocalizedNamestring · minLength: 1 · required

    Administrative area name as displayed in local dialect set with language code in the URL. If no language code is selected, the default is English

  • EnglishNamestring · minLength: 1 · required

    Administrative area name displayed in English

API.Locations.Entities.OpenAPI.Asset

  • Namestring · minLength: 1 · required

    The name of the asset

  • Urlstring · minLength: 1 · required

    The URL associated to the asset

API.Locations.Entities.OpenAPI.CoordinateTranslate

  • Keystring · minLength: 1 · required

    Unique ID to search a location

API.Locations.Entities.OpenAPI.DaylightSavingChange

  • Datestring · date-time · required

    Time when daylight saving will change

  • GmtOffsetnumber · float · required

    Number of hours offset from local GMT time

  • TimeZoneFormatstring · minLength: 1 · required

    Alphabetic abbreviation of the TimeZone

API.Locations.Entities.OpenAPI.Details

  • Keystring · minLength: 1 · required

    Unique ID to identify a location.

  • StationCodestring · minLength: 1 · required

    Weather station code of the location.

  • StationGmtOffsetnumber · float · required

    GMT offset of the weather station.

  • BandMapstring · minLength: 1 · required

    Temperature and precipitation band map code.

  • Climostring · minLength: 1 · required

    Source of climatology data for the location.

  • LocalRadarstring · minLength: 1 · required

    Local radar code associated with the location.

  • MediaRegionstring · minLength: 1 · required

    Media region associated with the location.

  • Metarstring · minLength: 1 · required

    Metar station of the location.

  • NXMetrostring · minLength: 1 · required

    City level radar code.

  • NXStatestring · minLength: 1 · required

    State level radar code.

  • Populationinteger · int64 · required

    Reported population of the location.

  • PrimaryWarningCountyCodestring · minLength: 1 · required

    Primary warning county code.

  • PrimaryWarningZoneCodestring · minLength: 1 · required

    Primary warning zone code.

  • Satellitestring · minLength: 1 · required

    Satellite associated with the location.

  • Synopticstring · minLength: 1 · required

    Synoptic station associated with the location.

  • MarineStationstring · minLength: 1 · required

    Marine station code.

  • MarineStationGMTOffsetnumber · float · required

    GMT offset of the marine station.

  • VideoCodestring · minLength: 1 · required

    Code that identifies city or region for video.

  • LocationStemstring · minLength: 1 · required

    Country ID/location name/postal code or Country ID/location name/Location Key when the location does not have a postal code. For AccuWeather internal use only.

  • Sourcesobject[] · required

    Official sources of data by type

  • CanonicalPostalCodestring · minLength: 1 · required

    Optimized postal code which may be the postal code of the location or a nearby metropolitan area. May be empty.

  • CanonicalLocationKeystring · minLength: 1 · required

    Optimized locationKey which may be the locationKey of the location or a nearby metropolitan area. May be empty.

  • DMA | null

    Designated Marketing Area

  • PartnerIDstring | null

    Unique number that identifies a display partner for the Designated Marketing Area (DMA). Language dependent.

API.Locations.Entities.OpenAPI.Dma

  • IDstring · minLength: 1 · required

    Numeric id to identify the marketing area.

  • EnglishNamestring · minLength: 1 · required

    Name of the Designated Marketing Area.

API.Locations.Entities.OpenAPI.Location

  • PrimaryPostalCodestring · minLength: 1 · required

    Official postal code provided by our main location data provider for the requested location

  • Regionrequired

    The object containing the region details

  • TimeZonerequired

    The object containing the timezone details

  • GeoPositionrequired

    The object containing the geoposition details

  • IsAliasboolean · required

    “True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location

  • SupplementalAdminAreasobject[] · required

    The object containing a list of administrative area details

  • DataSetsstring[] · required

    Array of location-specific products that are available for this location. Products include Alerts, PremiumAirQuality, AirQuality, MinuteCast, and ForecastConfidence. If no location-specific products are available, the array will be empty.

  • EnglishNamestring · minLength: 1 · required

    Location name as displayed in English

  • Versioninteger · int32 · required

    Current version of the API

  • Keystring · minLength: 1 · required

    Unique ID to search a location

  • Typestring · minLength: 1 · required

    Location type such as City, PostalCode, POI or LatLong

  • Rankinteger · int32 · required

    Number applied to locations set by factors such as population, political importance, and geographic size

  • LocalizedNamestring · minLength: 1 · required

    Display name in local dialect set with language code in URL. Default is US English (us-en)

  • Countryrequired

    THe object containing the country details

  • AdministrativeArearequired

    The object containing the amdministrative area details

  • ParentCity | null

    The object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.

  • Details | null

    AccuWeather related details about the specific location

API.Locations.Entities.OpenAPI.LocationBase

  • Versioninteger · int32 · required

    Current version of the API

  • Keystring · minLength: 1 · required

    Unique ID to search a location

  • Typestring · minLength: 1 · required

    Location type such as City, PostalCode, POI or LatLong

  • Rankinteger · int32 · required

    Number applied to locations set by factors such as population, political importance, and geographic size

  • LocalizedNamestring · minLength: 1 · required

    Display name in local dialect set with language code in URL. Default is US English (us-en)

  • Countryrequired

    THe object containing the country details

  • AdministrativeArearequired

    The object containing the amdministrative area details

API.Locations.Entities.OpenAPI.LocationGeoPosition

  • Elevationrequired

    The location elevation compared to the sea level. An object containing a rounded value for Feet and Meter. The object may be NULL.

  • Latitudenumber · float · required
  • Longitudenumber · float · required

API.Locations.Entities.OpenAPI.LocationTimeZone

  • Codestring · minLength: 1 · required

    Official abbreviation code for designated Time Zone

  • NextOffsetChangestring · date-time · required

    Next time that daylight saving time changes

  • Namestring · minLength: 1 · required

    Official name of designated Time Zone

  • GmtOffsetnumber · float · required

    Number of hours offset from local GMT time

  • IsDaylightSavingboolean · required

    A “true” or “false” verification of whether a location is currently observing Day Light Saving time

API.Locations.Entities.OpenAPI.ParentCity

  • Keystring · minLength: 1 · required

    Parent city location key.

  • LocalizedNamestring · minLength: 1 · required

    Parent city name as displayed in local dialect set with language code in the URL. If no language code is selected, the default is English

  • EnglishNamestring · minLength: 1 · required

    Parent city name displayed in English

API.Locations.Entities.OpenAPI.Partner

  • IDinteger · int32 · required

    Unique ID to search a partner

  • PartnerAreaIDinteger · int32 · required

    Unique administrative area ID

  • MarketIDinteger · int32 · required

    Unique market ID associated with the partner

  • BlogIDinteger · int32 · required

    Unique blob ID associated with the partner

  • Namestring · minLength: 1 · required

    The name of the partner

  • HeadlineNewsLogostring | null

    The URL to the partner's headline news logo

  • WebLogostring | null

    The URL to the partner's web logo

  • WebLinkstring | null

    The URL to the partner's website

  • MobileLogostring | null

    The URL to the partner's mobile logo

  • MobileLinkstring | null

    The URL to the partner's mobile website

  • RSSLinkstring | null

    The URL to the partner's RSS feed

  • FeatureLinkstring | null

    The URL to the partner's feature

  • AppPartnership | null

    An object representing all of the partnerships

  • Assetsarray | null

    An object representing all of the assests such as links

API.Locations.Entities.OpenAPI.SourceElement

  • DataTypestring · minLength: 1 · required

    The type of data the source provides.

  • Sourcestring · minLength: 1 · required

    Name of the data provider.

  • SourceIdinteger · int32 · required

    Id associated with the source. Can be used as a key.

  • PartnerSourceUrlstring | null

    Source URL for the display partner of a Designated Marketing Area (DMA

API.Locations.Entities.OpenAPI.Station

  • StationCodestring · minLength: 1 · required

    Unique ID of the weather station

  • GeoPositionrequired

    The object containing the geoposition details

  • GmtOffsetnumber · float · required

    GMT offset of the weather station

  • CurrentGmtOffsetnumber · float · required

    Current GMT offset of the weather station

  • TimeZoneDesignatorstring · minLength: 1 · required

    Alphabetic abbreviation of the TimeZone

  • TimeZoneNamestring · minLength: 1 · required

    The name of the TimeZone

API.Locations.Entities.OpenAPI.SupplementalAdminArea

  • Levelinteger · int64 · required

    An assigned number to describe the scale of the administrative subdivisions for countries. As the Level number increases, the scale of the subdivision will decrease. Numbers of 10 or greater are reserved for non-political boundaries and should be used independently

  • LocalizedNamestring · minLength: 1 · required

    Administrative area name as displayed in local dialect set with language code in the URL. If no language code is selected, the default is English

  • EnglishNamestring · minLength: 1 · required

    Administrative area name displayed in English

API.Locations.Entities.OpenAPI.TimeZone

  • IDinteger · int32 · required

    Unique TimeZone ID

  • Namestring · minLength: 1 · required

    Official name of designated Time Zone

  • GmtOffsetnumber · float · required

    Number of hours offset from local GMT time

  • IsDaylightSavingboolean · required

    A “true” or “false” verification of whether a location is currently observing Day Light Saving time

  • DaylightSavingChangesarray | null

    The list of available daylight saving changes

API.Locations.Entities.Search.AliasSearchMode

integer · enum · int32
Enum values:
0
1
2

API.Locations.Entities.Search.SearchType

integer · enum · int32
Enum values:
0
1
2

Common.OpenAPISpecification.Entities.GeoPosition

  • Latitudenumber · float · required
  • Longitudenumber · float · required

API.Indices.Entities.OpenAPI.Index

  • LocalDateTimestring · date-time · required

    Valid datetime of the index displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochDateTimeinteger · int64 · required

    Valid datetime for the index displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • MobileLinkstring · uri · required

    Link to indices on AccuWeather's mobile site for the requested location.

  • Linkstring · uri · required

    Link to indices on AccuWeather's free site for the requested location.

  • Namestring | null

    Name of the index.

  • IDinteger · int32

    Numeric id used to identify the specific index.

  • Ascendingboolean

    Bit that describes the direction of the index value. When true, the poorest value is 0, best value is 10. When false, the poorest value is 10, best value is 0.

  • Valuenumber | null · float

    Index value that ranges from 0.0 to 10.0.

  • Categorystring | null

    Level that the index value falls. Categories differ among indices.

  • CategoryValueinteger · int32

    Level that the index value falls represented by an int. This value can be 1 through 5 and should be used in combination with the ascending flag because it can differ among indices.

  • Textstring | null

    Sentence that can be used for display purposes to sum up the index value and category.

API.Indices.Entities.OpenAPI.IndexGroup

  • Namestring · minLength: 1 · required

    Name of the index group.

  • IDinteger · int32 · required

    Numeric id used to identify a group of related indices.

  • Ascendingboolean

    Bit that describes the direction of the index value. When true, the poorest value is 0, best value is 10. When false, the poorest value is 10, best value is 0.

  • Descriptionstring | null

    A text value that provides detail about the index group.

API.Indices.Entities.OpenAPI.IndexInfo

  • Namestring · minLength: 1 · required

    Name of the index group.

  • IDinteger · int32 · required

    Numeric id used to identify the specific index group.

  • Ascendingboolean · required

    Bit that describes the direction of the index value. When true, the poorest value is 0, best value is 10. When false, the poorest value is 10, best value is 0.

  • Descriptionstring · minLength: 1 · required

    A text value that provides detail about the index group.

API.Alerts.Entities.OpenAPI.AccuAlert

  • CountryCodestring · minLength: 1 · required

    A unique ID number assigned to a specific country.

  • AlertIDinteger · int64 · required

    A unique ID number that identifies a specific alert for a particular country.

  • Descriptionrequired

    An object containing a short phrase that summarizes the alert.

  • Categorystring · minLength: 1 · required

    A classification word or phrase that describes the alert type.

  • Priorityinteger · int32 · required

    A ranking number that indicates the alert's importance based on the issuing authority's list of alert types. Higher impact alerts have a lower numnber. The highest priority is 1.

  • Typestring · minLength: 1 · required

    An abbreviated alert description.

  • TypeIDstring · minLength: 1 · required

    An alphanumeric ID that indicates the alert description.

  • Classstring · minLength: 1 · required

    The alert classification. Not available for all countries. Can be null.

  • Levelstring · minLength: 1 · required

    Indicates the alert severity. Not available for all countries. Can be null.

  • AlarmLevelstring · minLength: 1 · required

    A color-based system that indicates the alert severity.

  • Sourcestring · minLength: 1 · required

    The alert data provider.

  • SourceIdinteger · int32 · required

    An ID integer that identifies the alert data provider.

  • Disclaimerstring · minLength: 1 · required

    A disclaimer that must be displayed with the alert data. Can be null.

  • HaveReadyStatementsboolean · required

    A boolean value determining if ready statements are available.

  • SourceIconUrlstring | null

    Link to icon from the data provider.

  • SourceTeamstring | null

    The name of the data provider.

  • SourceTeamIconUrlstring | null

    Link to the data provider.

  • Color | null

    An object containing definitions for an additive color that indicates the alert type.

  • Areaarray | null

    An array containing information that defines the requested alert location, alert timing, and alert text.

  • MobileLinkstring | null · uri

    Link to severe weather alerts on AccuWeather's mobile site for the requested location.

  • Linkstring | null · uri

    Link to severe weather alerts on AccuWeather's free site for the requested location.

API.Alerts.Entities.OpenAPI.ActiveDataSource

  • idinteger · int32
  • namestring | null
  • countryCodestring | null
  • alertCountinteger · int32

API.Alerts.Entities.OpenAPI.AlertType

  • Codestring | null

    A unique ID assigned to the alert type.

  • Descriptionstring | null

    An object containing a short phrase that summarizes the alert.

  • Categorystring | null

    A classification word or phrase that describes the alert type.

  • Priorityinteger · int32

    A ranking number that indicates the alert's importance based on the issuing authority's list of alert types. Higher impact alerts have a lower numnber. The highest priority is 1.

  • Colorstring | null

    A descriptive name for the color.

  • Classstring | null

    The alert classification. Not available for all countries. Can be null.

  • Levelstring | null

    Indicates the alert severity. Not available for all countries. Can be null.

  • AlarmLevelstring | null

    A color-based system that indicates the alert severity.

  • DataSourceIdinteger · int32

    An ID integer that identifies the alert data provider.

  • Idinteger · int32

    A unique ID number that identifies a specific alert for a particular country.

  • HaveReadyStatementsboolean

    A boolean value determining if ready statements are available.

  • CountryCodestring | null

    A unique ID number assigned to a specific country.

  • TypeIdstring | null

    An alphanumeric ID that indicates the alert description.

API.Alerts.Entities.OpenAPI.Area

  • Namestring · minLength: 1 · required

    The name for the area that encompasses the requested location and falls under the current alert.

  • StartTimestring · date-time · required

    The time at which the alert began, returned in ISO 8601 format:(yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochStartTimeinteger · int64 · required

    The time at which the alert began, returned in the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • EndTimestring · date-time · required

    The time at which the alert ended or will end, returned in ISO 8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochEndTimeinteger · int64 · required

    The time at which the alert ended or will end, returned in the total number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • LastActionrequired

    An object containing the alert's current status.

  • Summarystring · minLength: 1 · required

    A brief description of the alert.

  • IssuedTimestring · date-time

    The time at which the alert was created, returned in ISO 8601 format:(yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochIssuedTimeinteger · int64

    The time at which the alert was created, returned in the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • Textstring | null

    A full description of the alert.

  • LanguageCodestring | null

    The code for the language in which the alert is returned (for example, en for English).

API.Alerts.Entities.OpenAPI.Color

  • Namestring · minLength: 1 · required

    A descriptive name for the color.

  • Redinteger · int32 · required

    The color's red component.

  • Greeninteger · int32 · required

    The color's green component.

  • Blueinteger · int32 · required

    The color's blue component.

  • Hexstring · minLength: 1 · required

    The hexadecimal code that specifies the color.

API.Alerts.Entities.OpenAPI.DataSource

  • Idinteger · int32

    A unique ID assigned to the data provider.

  • Namestring | null

    The name of the data provider.

  • CountryCodestring | null

    The originating country of the data provider.

API.Alerts.Entities.OpenAPI.Description

  • Localizedstring · minLength: 1 · required

    The alert's current status in the specified language.

  • Englishstring · minLength: 1 · required

    The alert's current status in US English.

API.Alerts.Entities.OpenAPI.DetailsFeature

  • typestring | null
  • geometry | null
  • properties | null

API.Alerts.Entities.OpenAPI.DetailsProperties

  • countryCodestring | null
  • sourcestring | null
  • sourceIdinteger · int32
  • alertIdinteger · int32
  • description | null
  • categorystring | null
  • priorityinteger · int32
  • typestring | null
  • typeIdstring | null
  • classstring | null
  • levelstring | null
  • AlarmLevelstring | null
  • color | null
  • colorHexstring | null
  • startTimestring · date-time
  • epochStartTimeinteger · int32
  • endTimestring · date-time
  • epochEndTimeinteger · int32
  • lastAction | null

API.Alerts.Entities.OpenAPI.Feature

  • typestring | null
  • geometry | null
  • properties | null

API.Alerts.Entities.OpenAPI.Geometry

  • typestring | null
  • coordinatesarray | null

API.Alerts.Entities.OpenAPI.GlobalAlert

  • CountryCodestring · minLength: 1 · required

    A unique ID number assigned to a specific country.

  • AlertIDinteger · int64 · required

    A unique ID number that identifies a specific alert for a particular country.

  • Descriptionrequired

    An object containing a short phrase that summarizes the alert.

  • Categorystring · minLength: 1 · required

    A classification word or phrase that describes the alert type.

  • Priorityinteger · int32 · required

    A ranking number that indicates the alert's importance based on the issuing authority's list of alert types. Higher impact alerts have a lower numnber. The highest priority is 1.

  • Typestring · minLength: 1 · required

    An abbreviated alert description.

  • TypeIDstring · minLength: 1 · required

    An alphanumeric ID that indicates the alert description.

  • Classstring · minLength: 1 · required

    The alert classification. Not available for all countries. Can be null.

  • Levelstring · minLength: 1 · required

    Indicates the alert severity. Not available for all countries. Can be null.

  • AlarmLevelstring · minLength: 1 · required

    A color-based system that indicates the alert severity.

  • Sourcestring · minLength: 1 · required

    The alert data provider.

  • SourceIdinteger · int32 · required

    An ID integer that identifies the alert data provider.

  • Disclaimerstring · minLength: 1 · required

    A disclaimer that must be displayed with the alert data. Can be null.

  • HaveReadyStatementsboolean · required

    A boolean value determining if ready statements are available.

  • Color | null

    An object containing definitions for an additive color that indicates the alert type.

  • SourceIconUrlstring | null

    SourceIconUrl

  • SourceTeamstring | null

    SourceTeam

  • SourceTeamIconUrlstring | null

    SourceTeamIconUrl

  • Areaarray | null

    An array containing information that defines the requested alert location, alert timing, and alert text.

  • MobileLinkstring | null · uri

    Link to severe weather alerts on AccuWeather's mobile site for the requested location.

  • Linkstring | null · uri

    Link to severe weather alerts on AccuWeather's free site for the requested location.

API.Alerts.Entities.OpenAPI.GlobalAlertPointDetailsGeojson

  • typestring | null
  • featuresarray | null

API.Alerts.Entities.OpenAPI.GlobalAlertPointGeojson

  • typestring | null
  • featuresarray | null

API.Alerts.Entities.OpenAPI.GlobalAlertPointJson

  • countryCodestring | null
  • dataSourceIdinteger · int32
  • alertIdinteger · int32
  • description | null
  • categorystring | null
  • priorityinteger · int32
  • typestring | null
  • typeIdinteger · int32
  • color | null
  • colorHexstring | null
  • startTimestring · date-time
  • epochStartTimeinteger · int32
  • endTimestring | null · date-time
  • epochEndTimeinteger | null · int32
  • lastAction | null
  • warningAreaIdsarray | null
  • geometry | null

API.Alerts.Entities.OpenAPI.PointColor

  • redinteger · int32
  • greeninteger · int32
  • blueinteger · int32
  • hexstring | null

API.Alerts.Entities.OpenAPI.PointDescription

  • localizedstring | null
  • englishstring | null

API.Alerts.Entities.OpenAPI.Properties

  • countryCodestring | null
  • dataSourceIdinteger · int32
  • alertIdinteger · int32
  • description | null
  • categorystring | null
  • priorityinteger · int32
  • typestring | null
  • typeIdinteger · int32
  • color | null
  • colorHexstring | null
  • startTimestring · date-time
  • epochStartTimeinteger · int32
  • endTimestring | null · date-time
  • epochEndTimeinteger | null · int32
  • lastAction | null
  • warningAreaIdsarray | null

API.Alerts.Entities.OpenAPI.WarningAreaFeature

  • typestring | null
  • geometry | null
  • properties | null

API.Alerts.Entities.OpenAPI.WarningAreaGeojson

  • typestring | null
  • featuresarray | null

API.Alerts.Entities.OpenAPI.WarningAreaProperties

  • countryCodestring | null
  • adminCodestring | null
  • namestring | null

API.Tropical.Accu.Entities.CategoryType

integer · enum · int32
Enum values:
0
1
2
3
4
5
6

API.Tropical.Accu.Entities.ForecastMetadata

  • storm | null
  • validDateTimestring | null · date-time
  • forecastIdinteger | null · int32
  • forecasterstring | null
  • creationDateTimestring | null · date-time
  • namestring | null
  • discussionstring | null
  • mapExtent | null
  • labelingHintstring | null
  • timeStampstring · date-time

API.Tropical.Accu.Entities.ForecastSummary

  • forecast | null
  • forecastMetadata | null
  • detailsboolean
  • radiiGeometryboolean
  • windowGeometryboolean
  • showMetadataboolean

API.Tropical.Accu.Entities.ImpactPolygon

  • key | null
  • beginValuenumber | null · float
  • endValuenumber | null · float
  • unitsstring | null
  • startDateTimestring | null · date-time
  • endDateTimestring | null · date-time
  • polygon | null
  • metadata | null
  • timeStampstring · date-time

API.Tropical.Accu.Entities.ImpactPolygonKey

  • storm | null
  • categoryType
  • categoryNamestring | null

API.Tropical.Accu.Entities.ImpactPolygonMetadata

  • discussionstring | null
  • forecasterstring | null
  • initializedDateTimestring | null · date-time
  • key | null
  • timeStampstring · date-time

API.Tropical.Accu.Entities.ImpactPolygonSummary

  • key | null
  • startDateTimestring · date-time
  • endDateTimestring · date-time
  • impactPolygonsarray | null
  • showMetadataboolean

API.Tropical.Accu.Entities.MapExtent

  • northLatnumber · float
  • southLatnumber · float
  • eastLonnumber · float
  • westLonnumber · float

API.Tropical.Atcf.Entities.AtcfStorm

  • yearinteger · int32
  • basinIdstring | null
  • atcfIdinteger · int32
  • govIdinteger | null · int32
  • namestring | null
  • isActiveboolean
  • isSubtropicalboolean
  • initTimesarray | null
  • timeStampstring · date-time

API.Tropical.Atcf.Entities.ForecastDetails

  • dateTimestring · date-time
  • position
  • windGustnumber | null · float
  • centralPressurenumber | null · float
  • windSpeednumber | null · float
  • windRadiusnumber | null · float
  • moveDirectionnumber | null · float
  • moveSpeednumber | null · float
  • windDirTextstring | null
  • windDirEnglishstring | null

API.Tropical.Atcf.Entities.StormForecast

  • initTimestring · date-time
  • yearinteger · int32
  • basinIdstring | null
  • atcfIdinteger · int32
  • modelsarray | null
  • timeStampstring · date-time

API.Tropical.Atcf.Entities.StormModel

  • namestring | null
  • forecastsarray | null

API.Tropical.Common.Entities.Forecast

  • storm | null
  • initializedDateTimestring | null · date-time
  • validDateTimestring | null · date-time
  • advisoryIdstring | null
  • position | null
  • maxWindSustainednumber | null · float
  • maxWindGustnumber | null · float
  • statusstring | null
  • statusPhraseCodestring | null
  • statusLocalizedstring | null
  • window | null
  • forecastGeometry | null
  • windRadiiSummaryarray | null
  • hasTropicalPotentialboolean | null
  • isPostTropicalboolean | null
  • timeStampstring · date-time

API.Tropical.Common.Entities.ForecastGeometry

  • storm | null
  • beginDateTimestring | null · date-time
  • endDateTimestring | null · date-time
  • beginStatusstring | null
  • endStatusstring | null
  • segmentIdinteger | null · int32
  • trackGeometry | null
  • windowGeometry | null
  • timeStampstring · date-time

API.Tropical.Common.Entities.GeoPosition

  • longitudenumber | null · float
  • latitudenumber | null · float

API.Tropical.Common.Entities.OpenAPI.ImperialQuantity

  • valueinteger · int32 · required
  • unitstring · minLength: 1 · required
  • unitTypeinteger · int64 · required

API.Tropical.Common.Entities.OpenAPI.Legacy.Advisory

  • IDstring · minLength: 1 · required

    The Advisory ID.

  • DateTimeIssuedstring · date-time

    The date and time at which the advisory was issued, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochDateTimeIssuedinteger · int64

    The date and time at which the advisory was issued, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

API.Tropical.Common.Entities.OpenAPI.Legacy.LandmarkReference

  • Landmarkstring · minLength: 1 · required

    The landmark name, in English.

  • Directionrequired

    An object containing direction to the landmark.

  • Rangerequired

    An object containing distance to the landmark.

API.Tropical.Common.Entities.OpenAPI.Legacy.Movement

  • Directionrequired

    An object containing information about the storm's direction of travel.

  • Speedrequired

    An object containing the speed at which the storm is moving with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

API.Tropical.Common.Entities.OpenAPI.Legacy.QuantityImperial

  • UnitTypeinteger · int64 · required
  • Valueinteger · int32 · required
  • Unitstring · minLength: 1 · required

API.Tropical.Common.Entities.OpenAPI.Legacy.QuantityMeasurementsWind

  • Metricrequired
  • Imperialrequired

API.Tropical.Common.Entities.OpenAPI.Legacy.Storm

  • IsActiveboolean · required

    A boolean flag indicating if the storm has been updated recently.

  • IsSubtropicalboolean · required

    A boolean flag indicating when the depression is classified as a subtropical cyclone.

  • Yearinteger · int32 · required

    The year of origination.

  • BasinIDstring · minLength: 1 · required

    Basin identifier (AL, EP, SI, NI, CP, NP, SP).

  • DepressionNumberinteger · int32 · required

    Government depression number. May be NULL.

  • Namestring · minLength: 1 · required

    The name of the depression.

  • GovIdinteger · int32

    The unique depression number associated with a tropical cyclone. Equivalent to depressionId.

  • GovBaseLinkstring | null

    Link to the specific government storm URL.

API.Tropical.Common.Entities.OpenAPI.Legacy.StormForecast

  • Positionrequired

    An object containing the location details.

  • Statusstring · minLength: 1 · required

    Storm status, in English, including category values of hurricanes and tropical cyclones. Some examples are: Hurricane – Category 3, Tropical Depression, Tropical Cyclone - Category 1, Depression, and Typhoon.

  • DateCreatedstring · date-time

    The date and time at which the forecast was created, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochDateCreatedinteger · int64

    The date and time at which the forecast was created, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • ForecastDateTimestring · date-time

    The date and time at which the forecast is valid, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • ForecastEpochDateTimeinteger · int64

    The date and time at which the forecast is valid, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • Storm | null

    An object containing details about the storm.

  • MaxWindGust | null

    An object containing information about the maximum short-burst wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • SustainedWind | null

    An object containing information about the maximum sustained wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • Window | null

    An object containing information about the forecast window for the storm during the specified time period (not the entire cone). If windowgeometry=true in the request, this object will include geoJSON details for window geometry.

API.Tropical.Common.Entities.OpenAPI.Legacy.StormPosition

  • Advisoryrequired

    An object containg details of the advisory.

  • Positionrequired

    An object containing location details.

  • MaxWindGustrequired

    An object containing information about the maximum short-burst wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • SustainedWindrequired

    An object containing information about the maximum sustained wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • MinimumPressurerequired

    An object containing information about the measured air pressure at ground level with a rounded value for Inches of Mercury and Millibar. The object may be NULL.

  • Movementrequired

    An object containing direction and speed of the storm.

  • Statusstring · minLength: 1 · required

    Storm status, in English, including category values of hurricanes and tropical cyclones. Some examples are: Hurricane – Category 3, Tropical Depression, Tropical Cyclone - Category 1, Depression, and Typhoon.

  • HasTropicalPotentialboolean · required

    A boolean value determining if the storm could be tropical.

  • IsPostTropicalboolean · required

    A boolean value describing if the storm is post tropical.

  • LandmarkReferencesobject[] · required

    A list of objects containing details of surrounding landmarks.

  • Storm | null

    An object containing details about the storm.

  • windRadiiSummaryarray | null

    A list of objects containing containing wind radii information.

API.Tropical.Common.Entities.OpenAPI.Legacy.WindRadiiSummary

  • RadiusSectorDataobject[] · required

    A list of objects containing the information needed to plot wind radius quadrants. Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.

  • ValidDateTimestring · date-time

    The date and time at which the wind radii summary data is valid, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • ValidEpochDateTimeinteger · int64

    The date and time at which the wind radii summary data is valid, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • WindSpeed | null

    An object containing wind speed associated with the radiusSectorData with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • RadiiGeometry | null

    An object containing GeoJSON information. Displayed when radiigeometry=true in request. Describes the outline of the wind radius quadrants.

API.Tropical.Common.Entities.OpenAPI.Legacy.Window

  • Leftrequired

    An object containing the geoposition of the point on the left side of the window at the time of the timeframe (window.endDateTime).

  • Rightrequired

    An object continaing the geoposition of the point on the right side of the window at the end of the timeframe (window.endDateTime).

API.Tropical.Common.Entities.OpenAPI.MetricQuantity

  • valuenumber · float · required
  • unitstring · minLength: 1 · required
  • unitTypeinteger · int64 · required

API.Tropical.Common.Entities.OpenAPI.QuantityMeasurements

  • metricrequired
  • imperialrequired

API.Tropical.Common.Entities.OpenAPI.RadiusSector

  • beginBearingnumber · float · required

    Bearing, in degrees, of the beginning of the quadrant.

  • endBearingnumber · float · required

    Bearing, in degrees, of the end of the quadrant.

  • rangeinteger · int32 · required

    The radius of the quadrant, in nautical miles.

API.Tropical.Common.Entities.OpenAPI.StormBase

  • yearinteger · int64 · required

    The year of origination.

  • basinIdstring · minLength: 1 · required

    Basin identifier (AL, EP, SI, NI, CP, NP, SP).

  • depressionNumberinteger · int32 · required

    Government depression number. May be NULL.

  • namestring · minLength: 1 · required

    The name of the depression.

  • isActiveboolean · required

    A boolean flag indicating if the storm has been updated recently.

  • isSubtropicalboolean · required

    A boolean flag indicating when the depression is classified as a subtropical cyclone.

  • isRetiredboolean

    A boolean flag indicating if the storm name had been retired and false if it has not been retired.

  • govIdinteger | null · int32

    The unique depression number associated with a tropical cyclone. Equivalent to depressionId.

  • accuIdinteger | null · int32

    AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed.

  • atcfIdinteger | null · int32

    ATCF storm ID. May be NULL. If NULL, this parameter will not be displayed.

  • hurdatIdinteger | null · int32

    Hurdat (hurricane database) storm ID. May be NULL. If NULL, this parameter will not be displayed.

  • eventKeystring | null

    A unique identifier in the format BBDDYYYY where BB is the basin code, DD is the depression number, and YYYY is the year.

  • govBaseLinkstring | null

    Link to the specific government storm URL. May be NULL. If NULL, this parameter will not be displayed.

  • accuBaseLinkstring | null

    Link to the specific AccuWeather storm URL. May be NULL. If NULL, this parameter will not be displayed.

  • atcfBaseLinkstring | null

    Link to the specific ATCF storm URL. May be NULL. If NULL, this parameter will not be displayed.

API.Tropical.Common.Entities.PeakIntensity

  • sustainedWindnumber | null · float
  • statusstring | null
  • statusPhraseCodestring | null
  • statusLocalizedstring | null
  • validDatetimestring | null · date-time
  • position | null
  • timeStampstring · date-time

API.Tropical.Common.Entities.Position

  • storm | null
  • validDateTimestring | null · date-time
  • advisoryNumberstring | null
  • advisoryIssuedstring | null · date-time
  • point | null
  • movementDirnumber | null · float
  • movementDirCardinalstring | null · readOnly
  • movementDirCardinalLocalizedstring | null
  • movementSpeednumber | null · float
  • minPressurenumber | null · float
  • maxWindSustainednumber | null · float
  • maxWindGustnumber | null · float
  • isSubtropicalboolean | null
  • statusstring | null
  • statusPhraseCodestring | null
  • statusLocalizedstring | null
  • namestring | null
  • hasTropicalPotentialboolean | null
  • isPostTropicalboolean | null
  • landmarkRefsarray | null
  • timeStampstring · date-time

API.Tropical.Common.Entities.PositionSummary

  • stormPosition | null
  • windRadiiSummaryarray | null
  • detailsboolean
  • geometryboolean
  • isLegacyboolean

API.Tropical.Common.Entities.RadiusSectorData

  • beginBearingnumber | null · float
  • endBearingnumber | null · float
  • rangeinteger | null · int32

API.Tropical.Common.Entities.Storm

  • accuIdinteger | null · int32
  • atcfIdinteger | null · int32
  • hurdatIdinteger | null · int32
  • namestring | null
  • detailsboolean
  • isSubtropicalboolean
  • isActiveboolean
  • isGovStormboolean
  • isLegacyboolean
  • isRetiredboolean
  • govBaseLinkstring | null
  • accuBaseLinkstring | null
  • atcfBaseLinkstring | null
  • eventKeystring | null
  • endDateTimestring | null · date-time
  • startDateTimestring | null · date-time
  • peakIntensity | null
  • impactPolygonTypesarray | null
  • yearinteger · int32
  • basinIdstring | null
  • govIdinteger | null · int32
  • timeStampstring · date-time

API.Tropical.Common.Entities.StormIdentity

  • yearinteger · int32
  • basinIdstring | null
  • govIdinteger | null · int32
  • timeStampstring · date-time

API.Tropical.Common.Entities.WindRadiiData

  • windSpeedinteger | null · int32
  • validDateTimestring | null · date-time

API.Tropical.Common.Entities.WindRadiiSummary

  • storm | null
  • windRadiiData | null
  • radiusSectorDataarray | null
  • radiiGeometry | null

API.Tropical.Common.Entities.Window

  • left | null
  • right | null

API.Tropical.Gov.Entities.LandmarkRef

  • advisoryDateTimestring | null · date-time
  • namestring | null
  • bearingnumber | null · float
  • rangeinteger | null · int32
  • yearinteger · int32
  • basinIdstring | null
  • govIdinteger | null · int32
  • timeStampstring · date-time

API.Tropical.Gov.Entities.OpenAPI.Direction

  • Degreesnumber · float · required
  • Localizedstring · minLength: 1 · required
  • Englishstring · minLength: 1 · required

API.Tropical.Gov.Entities.OpenAPI.Duration

  • startDateTimestring | null · date-time

    The date and time at which the storm began in ISO 8601 format (yyyy-mm-ddThh:mm:ss+hh:mm).

  • startEpochDateTimeinteger | null · int64

    The date and time at which the storm began as a count of the number of seconds that had elapsed since midnight on January 1st, 1970 UTC/GMT.

  • endDateTimestring | null · date-time

    The date and time at which the storm ended in ISO 8601 format (yyyy-mm-ddThh:mm:ss+hh:mm).

  • endEpochDateTimeinteger | null · int64

    The date and time at which the storm ended as a count of the number of seconds that had elapsed since midnight on January 1st, 1970 UTC/GMT.

API.Tropical.Gov.Entities.OpenAPI.ForecastSummary

  • positionrequired

    An object containing the location details.

  • maxWindGustrequired

    An object containing information about the maximum short-burst wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • sustainedWindrequired

    An object containing information about the maximum sustained wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • statusstring · minLength: 1 · required

    Storm status, in English, including category values of hurricanes and tropical cyclones. Some examples are: Hurricane – Category 3, Tropical Depression, Tropical Cyclone - Category 1, Depression, and Typhoon.

  • localizedStatusstring · minLength: 1 · required

    The storm status in the requested language.

  • validDateTimestring · date-time

    The date and time at which the forecast is valid, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • validEpochDateTimeinteger · int64

    The date and time at which the forecast is valid, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • initializedDateTimestring · date-time

    Datetime the forecast was created, displayed in ISO8601 format.

  • epochInitializedDateTimeinteger · int64

    Datetime the forecast was created, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • window | null

    An object containing information about the forecast window for the storm during the specified time period (not the entire cone). If windowgeometry=true in the request, this object will include geoJSON details for window geometry.

  • windRadiiSummaryarray | null

    A list of objects containing wind radii information.

API.Tropical.Gov.Entities.OpenAPI.LandmarkReference

  • landmarkstring · minLength: 1 · required

    The landmark name, in English.

  • direction | null

    An object containing information about the storm's direction of travel.

  • range | null

    An object containing distance to the landmark.

API.Tropical.Gov.Entities.OpenAPI.LandmarkReferenceDirection

  • degreesinteger · int64 · required

    Direction of movmement in azimuth degrees. May be NULL.

  • englishstring · minLength: 1 · required

    Direction abbreviated in English.

API.Tropical.Gov.Entities.OpenAPI.PeakIntensity

  • validDateTimestring | null · date-time

    The date and time at which the peak intensity was observed, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss+hh:mm).

  • validEpochDateTimeinteger | null · int64

    The date and time at which the peak intensity was observed, displayed as a count of the number of seconds that have elapsed since midnight on January 1st, 1970 UTC/GMT.

  • statusstring | null

    Storm status, in English, including category values of hurricanes and tropical cyclones. Some examples are: Hurricane – Category 3, Tropical Depression, Tropical Cyclone - Category 1, Depression, and Typhoon.

  • localizedStatusstring | null

    The storm status in the requested language.

  • position | null

    An object containing the location details.

  • sustainedWind | null

    An object containing information about the maximum sustained wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

API.Tropical.Gov.Entities.OpenAPI.PositionSummary

  • statusstring · minLength: 1 · required

    Storm status, in English, including category values of hurricanes and tropical cyclones. Some examples are: Hurricane – Category 3, Tropical Depression, Tropical Cyclone - Category 1, Depression, and Typhoon.

  • localizedStatusstring · minLength: 1 · required

    The storm status in the requested language.

  • validDateTimestring · date-time

    The date and time at which the forecast is valid, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • validEpochDateTimeinteger · int64

    The date and time at which the forecast is valid, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • position | null

    An object containing the location details.

  • maxWindGust | null

    An object containing information about the maximum short-burst wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • sustainedWind | null

    An object containing information about the maximum sustained wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • minimumPressure | null

    An object containing information about the measured air pressure at ground level with a rounded value for Inches of Mercury and Millibar. The object may be NULL.

  • movement | null

    An object containing information about the depression movement.

  • isSubtropicalboolean | null

    A boolean flag indicating when the depression is classified as a subtropical cyclone.

  • namestring | null

    The name of the depression.

  • hasTropicalPotentialboolean

    A boolean value determining if the storm could be tropical.

  • isPostTropicalboolean

    A boolean value describing if the storm is post tropical.

  • landmarkReferencesarray | null

    A list of objects containing details of surrounding landmarks.

  • windRadiiSummaryarray | null

    A list of objects containing containing wind radii information.

API.Tropical.Gov.Entities.OpenAPI.QuantityMeasures

  • minimumrequired

    An object containing information about the minimum sustained wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • maximumrequired

    An object containing information about the maximum sustained wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

API.Tropical.Gov.Entities.OpenAPI.RadiusSector

  • beginBearingnumber · float · required

    Bearing, in degrees, of the beginning of the quadrant.

  • endBearingnumber · float · required

    Bearing, in degrees, of the end of the quadrant.

  • rangeinteger · int32 · required

    The radius of the quadrant, in nautical miles.

API.Tropical.Gov.Entities.OpenAPI.Storm

  • yearinteger · int64 · required

    The year of origination.

  • basinIdstring · minLength: 1 · required

    Basin identifier (AL, EP, SI, NI, CP, NP, SP).

  • depressionNumberinteger · int32 · required

    Government depression number. May be NULL.

  • namestring · minLength: 1 · required

    The name of the depression.

  • isActiveboolean · required

    A boolean flag indicating if the storm has been updated recently.

  • isSubtropicalboolean · required

    A boolean flag indicating when the depression is classified as a subtropical cyclone.

  • accuIdinteger | null · int32

    AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed.

  • atcfIdinteger | null · int32

    Automated Tropical Cyclone Forecasting (ATCF) storm ID. May be NULL. If NULL, this parameter will not be displayed.

  • duration | null

    An object containing information about the total length of time the storm lasted. Only available after the storm has ended.

  • peakIntensity | null

    An object containing information about the storm's maximum strength.

  • ImpactPolygonTypesarray | null

    The list of impact polygon types.

  • accuBaseLinkstring | null

    Link to the specific AccuWeather storm URL. May be NULL. If NULL, this parameter will not be displayed.

  • isRetiredboolean

    A boolean flag indicating if the storm name had been retired and false if it has not been retired.

  • govIdinteger | null · int32

    The unique depression number associated with a tropical cyclone. Equivalent to depressionId.

  • hurdatIdinteger | null · int32

    Hurdat (hurricane database) storm ID. May be NULL. If NULL, this parameter will not be displayed.

  • eventKeystring | null

    A unique identifier in the format BBDDYYYY where BB is the basin code, DD is the depression number, and YYYY is the year.

  • govBaseLinkstring | null

    Link to the specific government storm URL. May be NULL. If NULL, this parameter will not be displayed.

  • atcfBaseLinkstring | null

    Link to the specific ATCF storm URL. May be NULL. If NULL, this parameter will not be displayed.

API.Tropical.Gov.Entities.OpenAPI.StormStatus

  • basinstring | null

    Basin identifier (NP, SP, NI, SI, AL, EP).

  • statusstring | null

    Storm status, in English, including category values of hurricanes and tropical cyclones. Some examples are: Hurricane – Category 3, Tropical Depression, Tropical Cyclone - Category 1, Depression, and Typhoon.

  • sustainedWinds | null

    An object containing the Maximum and Minimum sustained wind associated with the storm.

API.Tropical.Gov.Entities.OpenAPI.WindMeasurements

  • Speed | null
  • Direction | null

API.Tropical.Gov.Entities.OpenAPI.WindRadiiSummary

  • radiusSectorDataobject[] · required

    A list of objects containing the information needed to plot wind radius quadrants. Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.

  • validDateTimestring · date-time

    The date and time at which the wind radii summary data is valid, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).

  • validEpochDateTimeinteger · int64

    The date and time at which the wind radii summary data is valid, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.

  • windSpeed | null

    An object containing wind speed associated with the radiusSectorData with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.

  • radiiGeometry | null

    An object containing GeoJSON information. Displayed when radiigeometry=true in request. Describes the outline of the wind radius quadrants.

API.Tropical.Gov.Entities.OpenAPI.Window

  • leftrequired

    An object containing the geoposition of the point on the left side of the window at the time of the timeframe (window.endDateTime).

  • rightrequired

    An object continaing the geoposition of the point on the right side of the window at the end of the timeframe (window.endDateTime).

NetTopologySuite.Geometries.Coordinate

  • xnumber · double
  • ynumber · double
  • znumber · double
  • mnumber · double
  • coordinateValue | null

NetTopologySuite.Geometries.CoordinateSequence

  • dimensioninteger · int32 · readOnly
  • measuresinteger · int32 · readOnly
  • spatialinteger · int32 · readOnly
  • ordinatesreadOnly
  • hasZboolean · readOnly
  • hasMboolean · readOnly
  • zOrdinateIndexinteger · int32 · readOnly
  • mOrdinateIndexinteger · int32 · readOnly
  • countinteger · int32 · readOnly

NetTopologySuite.Geometries.CoordinateSequenceFactory

  • ordinatesreadOnly

NetTopologySuite.Geometries.Dimension

integer · enum · int32
Enum values:
0
1
2
-3
-2
-1

NetTopologySuite.Geometries.Envelope

  • isNullboolean · readOnly
  • widthnumber · double · readOnly
  • heightnumber · double · readOnly
  • minXnumber · double · readOnly
  • maxXnumber · double · readOnly
  • minYnumber · double · readOnly
  • maxYnumber · double · readOnly
  • areanumber · double · readOnly
  • minExtentnumber · double · readOnly
  • maxExtentnumber · double · readOnly
  • centre | null · readOnly

NetTopologySuite.Geometries.Geometry

  • factory | null · readOnly
  • userData | null
  • sridinteger · int32
  • geometryTypestring | null · readOnly
  • ogcGeometryTypereadOnly
  • precisionModel | null · readOnly
  • coordinate | null · readOnly
  • coordinatesarray | null · readOnly
  • numPointsinteger · int32 · readOnly
  • numGeometriesinteger · int32 · readOnly
  • isSimpleboolean · readOnly
  • isValidboolean · readOnly
  • isEmptyboolean · readOnly
  • areanumber · double · readOnly
  • lengthnumber · double · readOnly
  • centroid | null · readOnly
  • interiorPoint | null · readOnly
  • pointOnSurface | null · readOnly
  • dimensionreadOnly
  • boundary | null · readOnly
  • boundaryDimensionreadOnly
  • envelope | null · readOnly
  • envelopeInternal | null · readOnly
  • isRectangleboolean · readOnly

NetTopologySuite.Geometries.GeometryFactory

  • precisionModel | null
  • coordinateSequenceFactory | null
  • sridinteger · int32

NetTopologySuite.Geometries.OgcGeometryType

integer · enum · int32
Enum values:
1
2
3
4
5
6
7
8

NetTopologySuite.Geometries.Ordinates

integer · enum · int32
Enum values:
0
1
2
3
4
7
8
16

NetTopologySuite.Geometries.Point

  • coordinateSequence | null · readOnly
  • coordinatesarray | null
  • numPointsinteger · int32 · readOnly
  • isEmptyboolean · readOnly
  • dimensionreadOnly
  • boundaryDimensionreadOnly
  • xnumber · double
  • ynumber · double
  • coordinate | null
  • geometryTypestring | null · readOnly
  • ogcGeometryTypereadOnly
  • boundary | null · readOnly
  • znumber · double
  • mnumber · double
  • factory | null · readOnly
  • userData | null
  • sridinteger · int32
  • precisionModel | null · readOnly
  • numGeometriesinteger · int32 · readOnly
  • isSimpleboolean · readOnly
  • isValidboolean · readOnly
  • areanumber · double · readOnly
  • lengthnumber · double · readOnly
  • centroid | null · readOnly
  • interiorPoint | null · readOnly
  • pointOnSurface | null · readOnly
  • envelope | null · readOnly
  • envelopeInternal | null · readOnly
  • isRectangleboolean · readOnly

NetTopologySuite.Geometries.PrecisionModel

  • isFloatingboolean · readOnly
  • maximumSignificantDigitsinteger · int32 · readOnly
  • scalenumber · double
  • precisionModelTypereadOnly

NetTopologySuite.Geometries.PrecisionModels

integer · enum · int32
Enum values:
0
1
2

System.ValueTuple`2[[System.Single, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Single, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

  • item1number · float
  • item2number · float

API.Alarms.Entities.OpenAPI.Alarm

  • AlarmTypestring · minLength: 1 · required

    Type of alarms in effect: Rain, Ice, Snow, Wind, WindGust or Thunderstorm.

  • Value | null

    Rounded metric and imperial values of the alarms. For Rain, Snow and Ice, this will be the total accumulation for the day. Rain and Ice will be provided in Inch/Millimeter and Snow as Inch/Centimeter. For Wind or WindGust, the value is the maximum speed. Wind and WindGust will be provided in Mile per hour/Kilometer per hour. For Thunderstorm, the value is the maximum thunderstorm probability. Thunderstorm will be provided as a Percentage.

  • Day | null

    Rounded metric and imperial day values of the alarms. Applies to the daytime forecast. For Rain, Snow and Ice, this will be the total accumulation. Rain and Ice will be provided in Inch/Millimeter and Snow as Inch/Centimeter. For Wind or Wind or WindGust, the value is the maximum speed. Wind and WindGust will be provided in Mile per hour/Kilometer per hour. For Thunderstorm, the value is the maximum thunderstorm probability. Thunderstorm will be provided as a Percentage.

  • Night | null

    Rounded metric and imperial night values of the alarms. Applies to the overnight forecast. For Rain, Snow and Ice, this will be the total accumulation. Rain and Ice will be provided in Inch/Millimeter and Snow as Inch/Centimeter. For Wind or Wind or WindGust, the value is the maximum speed. Wind and WindGust will be provided in Mile per hour/Kilometer per hour. For Thunderstorm, the value is the maximum thunderstorm probability. Thunderstorm will be a provided as a Percentage.

API.Alarms.Entities.OpenAPI.DailyAlarm

  • Datestring · date-time · required

    The date for which the alarms exist as displayed in ISO8601 format: (yyyy-mm-ddThh:mm:ss±hh:mm).

  • EpochDateinteger · int64 · required

    Date of the forecast, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  • Alarmsobject[] · required

    A list of alarms that exist for the location on that date.

  • MobileLinkstring · uri · required

    Link to AccuWeather's mobile site.

  • Linkstring · uri · required

    Link to AccuWeather's traditional site.

API.Translations.Entities.OpenAPI.Language

  • IDinteger · int32 · required

    Unique ID for the language

  • Namestring · minLength: 1 · required

    The internal name of the language

  • DisplayNamestring · minLength: 1 · required

    Display Name (English) of the language

  • LocalizedNamestring · minLength: 1 · required

    The translated name of the language

  • ISOstring · minLength: 1 · required

    The culture code for the language

  • LanguageTypeinteger · int32 · required

    The unique ID for the language type

  • MicroSoftNamestring · minLength: 1 · required

    The Microsoft display name of the language

  • MicroSoftCodestring · minLength: 1 · required

    The Microsoft culture code for the language

  • TimeStampstring · date-time · required

API.Translations.Entities.OpenAPI.Phrase

  • Codestring · minLength: 1 · required

    The key to use for translation

  • Idinteger · int32 · required

    A unique ID (integer) for the translation

  • Textrequired

    The object representing the translation

  • AppGroupstring | null

    The type of application used for this translation

  • Typestring | null

    The key used for the translation category

  • Contextstring | null
  • MaxLengthinteger | null · int32

API.Translations.Entities.OpenAPI.Text

  • Englishstring · minLength: 1 · required

    The phrase displayed in English

  • Localizedstring | null

    The translated phrase

  • LanguageCodestring | null

    The culture code for the language to which the phrase is translated

API.Translations.Entities.OpenAPI.Translation

  • LanguageCodestring · minLength: 1 · required

    The culture code for the language to which the phrase is translated

  • PhraseCodestring · minLength: 1 · required

    The word or phrase (without spaces) to use as a key for joining the translations

  • Textstring · minLength: 1 · required

    The translated word or phrase

  • DataCodestring | null

    The key to use for translation

API.Translations.Entities.OpenAPI.TranslationGroup

  • IDinteger · int32 · required

    A unique ID (integer) for the translation group

  • Namestring · minLength: 1 · required

    The translation group name

API.Imagery.Maps.Entities.Enums.ImageSize

integer · enum · int32
Enum values:
1
2
3
4
5
6

API.Imagery.Maps.Entities.OpenAPI.Image

  • Sizestring · minLength: 1 · required

    The resolution of the image.

  • Imagesobject[] · required

    List of image details with links.

API.Imagery.Maps.Entities.OpenAPI.ImageDetails

  • Datestring · date-time · required

    The date/time of the image, displayed in ISO8601 format.

  • Urlstring · minLength: 1 · required

    The url of the image.

  • MobileLinkstring · minLength: 1 · required

    Link to AccuWeather's mobile site for the requested location.

  • Linkstring · minLength: 1 · required

    Link to AccuWeather's traditional site for the requested location.

  • Radar | null

    An object containing the list of available radar images. Radar images are not available for all locations worldwide at this time.

  • Satellite | null

    An object containing the list of available satellite images.