{"openapi":"3.0.2","info":{"title":"Weather API v3","version":"3.0.0","description":"NOTE: Accessing Weather Radar and Weather Alerts requires Weather Premium product permissions.\n\nThe HERE Weather API is a RESTful API that:\n\n- provides weather forecasts and reports on current weather conditions.\n- provides information on severe weather alerts along a specified route or a single car location.\n- provides weather radar images in an area.\n\nExamples of information that may be available in weather reports include:\n\n- Descriptions of the overall weather, temperature, precipitation, and wind in supported languages.\n- Numerical data on temperature, humidity, dew point, precipitation, wind and visibility.\n- Forecast alerts, severe warnings and watches for supported NWS alert types and for supported global alert types.\n- Icon name and link for the report.\n\nA weather report typically contains at least the temperature, comfort level, wind speed and direction, and a description, but there can be variation in the responses. The HERE Destination Weather API provides solutions for the following high-level use cases:\n\n- Get current weather reports or weather forecasts for a specific location.\n- Check for severe weather alerts at a specific location.\n- Check when the sun and moon rise and set at a specific location.\n\nWeather data is intended to be used by connected in-vehicle infotainment systems to provide weather information to drivers.\n\nWeather premium is restricted to automotive use cases only.\n"},"externalDocs":{"description":"The developer guide and release notes are available here.","url":"https://www.here.com/docs/category/destination-weatherv3"},"security":[{"Bearer":[]},{"ApiKey":[]}],"tags":[{"name":"Weather Report","description":"Destination weather report (current weather conditions, forecasts, severe weather alerts)."},{"name":"Weather Radar","description":"Doppler radar images"},{"name":"Weather Alerts","description":"Weather alerts issued by country goverment"},{"name":"API Information","description":"API Information"}],"paths":{"/report":{"get":{"tags":["Weather Report"],"summary":"Weather report","description":"Retrieves weather reports, weather forecasts, severe weather alerts.","operationId":"Weather API v3 weatherReport","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"name":"products","in":"query","description":"A parameter identifying the type of report to obtain. Comma separated values.","required":true,"explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/WeatherProduct"}}},{"name":"q","in":"query","description":"Enter a free-text query.\nExamples:\n\"125, Berliner, berlin\",\n\"Beacon, Boston\"","required":false,"schema":{"type":"string"}},{"name":"zipCode","in":"query","description":"ZIP code of the location. This parameter is supported only for locations in the United States of America. Latitude and longitude, name, or zipcode must be present.","required":false,"schema":{"type":"string"}},{"name":"location","in":"query","description":"Geographical location in WGS-84-compliant format.\nSpecifying the area covered by the weather report.\nFormat: `{lat},{lng}`\n","required":false,"schema":{"$ref":"#/components/schemas/LocationString"}},{"name":"units","description":"Units of measurement used. The default is `metric`.","in":"query","schema":{"type":"string","default":"metric","enum":["metric","imperial"]}},{"name":"oneObservation","in":"query","description":"Boolean, if set to true, the response only includes the closest location. Only available when the product parameter is set to observation. The default is `false`.","required":false,"schema":{"type":"boolean","default":false}},{"name":"hourlyDate","in":"query","description":"Date for which hourly forecasts are to be retrieved. The format is YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.","required":false,"schema":{"$ref":"#/components/schemas/DateOrTime"}},{"name":"lang","in":"query","description":"Defines the language used in the descriptions in the response. For example, the response for a query with lang=de-DE has descriptions in German. The default is `en-US`.","required":false,"schema":{"type":"string","default":"en-US"}},{"name":"politicalView","in":"query","description":"Specify the political view. Available territories are seen through the point of view of this country. If this parameter is not specified, the neutral international view is made available, where territories may have unresolved claims. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political view is `CHN`. Any political view that is unsupported falls back to the default view. For example, politicalView=USA or politicalView=FRA does not impact a response in any way.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherReport"},"examples":{"observation":{"$ref":"#/components/examples/WeatherReportObservationExample"},"forecastDailyDetailed":{"$ref":"#/components/examples/WeatherReportForecastExample"},"forecastDailySimple":{"$ref":"#/components/examples/WeatherReportForecastSimpleExample"},"forecastHourly":{"$ref":"#/components/examples/WeatherReportForecastHourlyExample"},"forecastAstronomy":{"$ref":"#/components/examples/WeatherReportForecastAstronomyExample"},"forecastedAlerts":{"$ref":"#/components/examples/WeatherReportForecastedAlerstExample"},"nwsAlerts":{"$ref":"#/components/examples/WeatherReportNWSAlerstExample"}}}}},"400":{"$ref":"#/components/responses/Error400ReportResponse"},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"429":{"$ref":"#/components/responses/Error429Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}},"/tile/{zoom}/{x}/{y}/{imageType}":{"get":{"tags":["Weather Radar"],"summary":"Weather radar image","description":"Retrieves a Doppler radar image","operationId":"Weather API v3 weatherRadarImage","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"name":"zoom","in":"path","description":"Zoom level. Value can be in range:\n* for imageTye=`radar` from 3 to 11, \n* for imageType=`precipitation` from 4 to 9\n","required":true,"schema":{"type":"integer","format":"int32","minimum":3,"maximum":11}},{"name":"x","in":"path","description":"x coordinate for the tile, can be any number between 0 and 2^zoom - 1.","required":true,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2047}},{"name":"y","in":"path","description":"y coordinate for the tile, can be any number between 0 and 2^zoom - 1.","required":true,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2047}},{"name":"imageType","in":"path","description":"Type of image. Currently, there are two valid image types identifying the Doppler radar images and Global precipitation images. Other image types might be added in future versions of the API.","required":true,"schema":{"type":"string","enum":["radar","precipitation"]}},{"name":"time","in":"query","description":"The time in ISO 8601 format. By default, current time is being considered. You can specify a time in the past to get archived radar images or future to retrieve precipitation forecasts.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"format","in":"query","description":"The desired image output format. Currently, the output format is PNG, but other formats might be supported in the future. The default is `png`.","required":false,"schema":{"type":"string","enum":["png"]}},{"name":"Accept","description":"Specify certain media types which are acceptable for the response.","in":"header","required":true,"schema":{"type":"string","enum":["image/png"]}}],"responses":{"200":{"description":"OK","content":{"image/png":{"schema":{"type":"string","format":"binary"}}},"headers":{"Last-Modified":{"description":"radar image timestamp.","schema":{"type":"string"}},"X-Radar-Covered":{"description":"Area is covered by radar images. True or False.","schema":{"type":"boolean"}},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}}},"400":{"$ref":"#/components/responses/Error400TileResponse"},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}},"/alerts":{"post":{"tags":["Weather Alerts"],"summary":"Weather alerts","description":"Weather alerts along the route or around a single location.","operationId":"Weather API v3 weatherAlert","parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherAlertRequestGeoJson"},"examples":{"singleLocationExample":{"$ref":"#/components/examples/WeatherAlertsSingleLocationRequestExample"},"routeExample":{"$ref":"#/components/examples/WeatherAlertsRouteRequestExample"}}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherAlertGeoJson"},"examples":{"alertExample":{"$ref":"#/components/examples/WeatherAlertsResponseExample"}}}}},"400":{"$ref":"#/components/responses/Error400AlertsResponse"},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}},"/openapi":{"get":{"summary":"This API specification","description":"Returns this API specification in YAML format.","operationId":"Weather API v3 getOpenapi","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"responses":{"200":{"description":"Open API specification of this service.\nIf Accept header is specified as `application/x-yaml` or `text/x-yaml`, then the API is returned in YAML format.\nBy default (or if not Accept header is specified) the return format is JSON.\n","content":{"application/json":{"schema":{"type":"object"}},"application/x-yaml":{"schema":{"type":"string"}},"text/x-yaml":{"schema":{"type":"string"}}},"headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-Id"}}},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}},"/health":{"get":{"tags":["API Information"],"operationId":"Weather API v3 getHealth","parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"summary":"Health","description":"Returns the health status of the service.","security":[],"responses":{"200":{"$ref":"#/components/responses/HealthResponseOk"},"503":{"$ref":"#/components/responses/Error503Response"},"default":{"$ref":"#/components/responses/HealthResponseFail"}}}},"/version":{"get":{"tags":["API Information"],"operationId":"Weather API v3 getVersion","parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"summary":"Version","description":"Returns the version of the service.","security":[],"responses":{"200":{"$ref":"#/components/responses/VersionResponseOk"},"500":{"$ref":"#/components/responses/Error500Response"},"503":{"$ref":"#/components/responses/Error503Response"}}}}},"servers":[{"url":"https://weather.hereapi.com/v3","description":"Production environment URL"}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request.\n\nFor more information on how to get a bearer token, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html.\n"},"ApiKey":{"type":"apiKey","in":"query","name":"apiKey","description":"A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html.\n"}},"headers":{"X-Correlation-Id":{"description":"Auto-generated unique identifier to identify this request.","schema":{"type":"string"},"example":"4d173a1e-6f1b-459b-b74f-23686354aaea"},"X-Request-Id":{"description":"User-provided token that can be used to trace a request or a group of requests sent to the service.\n","schema":{"type":"string"}}},"parameters":{"X-Request-Id":{"name":"X-Request-Id","in":"header","description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","schema":{"type":"string"}}},"responses":{"HealthResponseFail":{"description":"API response in case of failure.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"},"example":{"status":"fail"}}}},"HealthResponseOk":{"description":"API response in case of success.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"},"example":{"status":"OK"}}}},"VersionResponseOk":{"description":"API response in case of success","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}},"Error400ReportResponse":{"description":"Invalid parameters were provided","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"badRequestExample":{"$ref":"#/components/examples/BadRequestExample"}}}}},"Error400TileResponse":{"description":"Invalid parameters were provided.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"badRequestExample":{"$ref":"#/components/examples/BadRequestTileExample"}}}}},"Error400AlertsResponse":{"description":"Invalid parameters were provided.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"badRequestExample":{"$ref":"#/components/examples/BadRequestAlertExample"}}}}},"Error401Response":{"description":"API response in case of lacking valid authorization credentials.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthError"},"example":{"error":"Unauthorized","error_description":"No credentials found"}}}},"Error403Response":{"description":"API response in case of insufficient credentials for access to the requested resource.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthError"},"example":{"error":"Forbidden","error_description":"These credentials do not authorize access"}}}},"Error429Response":{"description":"API response in case of too many requests","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":429,"code":"E611125","title":"Too many requests","cause":"Request rate limit reached","action":"Retry later, lower the request rate","correlationId":"efefe455-d2e3-4e23-86aa-4e9a8a1680d4"}}}},"Error500Response":{"description":"API response in case of internal server error","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/InternalServerErrorExample"}}}}},"Error502Response":{"description":"API response in case of bad gateway","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/502errorResponseExample"}}}}},"Error503Response":{"description":"API response in case of service unavailable","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":503,"code":"E611001","title":"Service not available","cause":"Service current not available","action":"Retry later","correlationId":"efefe455-d2e3-4e23-86aa-4e9a8a1680d4"}}}},"Error504Response":{"description":"API response in case of gateway timeout.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/504errorResponseExample"}}}}}},"schemas":{"HealthResponse":{"type":"object","description":"Returns the health of the service.","properties":{"status":{"description":"Health status of the service:\n* `ok` - the service is operating normally\n* `fail` - the service is currently encountering a failure\n","type":"string"}}},"VersionResponse":{"type":"object","description":"Returns the version of the service.","properties":{"apiVersion":{"type":"string","example":"X.Y.Z","description":"The current version of the service."}},"required":["apiVersion"]},"DateOrTime":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}]},"WeatherReport":{"description":"Weather report","type":"object","properties":{"places":{"type":"array","items":{"type":"object","properties":{"observations":{"type":"array","items":{"$ref":"#/components/schemas/ObservationWeatherItem"},"description":"Actual weather conditions."},"extendedDailyForecasts":{"type":"array","items":{"$ref":"#/components/schemas/ForecastWeatherItem"},"description":"Weather seven days detailed forecasts.\nmorning, afternoon, evening and night weather forecasts for the next seven days.\n"},"dailyForecasts":{"type":"array","items":{"$ref":"#/components/schemas/ForecastWeatherItem"},"description":"Daily weather forecasts for the next seven days."},"hourlyForecasts":{"type":"array","items":{"$ref":"#/components/schemas/ForecastWeatherItem"},"description":"Hourly weather forecasts for the next seven days."},"astronomyForecasts":{"type":"array","items":{"$ref":"#/components/schemas/AstronomyForecastItem"},"description":"Astronomy forecasts.\n\nInformation on when the sun and moon rise and set, and on the phase of the moon for the next seven days.\n"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AlertItem"},"description":"Forecasted weather alerts for the next 24 hours."},"nwsAlerts":{"allOf":[{"$ref":"#/components/schemas/NWSAlertsType"}],"description":"All active watches and warnings for the US and Canada issued by National Weather Service."}}}}}},"Feature":{"description":"Feature object.","properties":{"geometry":{"$ref":"#/components/schemas/Geometry"},"id":{"type":"string","example":"w-1234","description":"Unique weather alert ID."},"properties":{"$ref":"#/components/schemas/FeatureProperties"},"type":{"enum":["Feature"],"type":"string"}},"required":["type","geometry"],"title":"Feature","type":"object","example":{"type":"Feature"}},"FeatureRequest":{"description":"Feature object for alerts request body.","properties":{"geometry":{"$ref":"#/components/schemas/GeometryRequest"},"properties":{"$ref":"#/components/schemas/FeatureRequestProperties"},"type":{"enum":["Feature"],"type":"string"}},"required":["type","geometry"],"title":"Feature","type":"object","example":{"type":"Feature"}},"WeatherAlertGeoJson":{"description":"Weather alerts geojson response.","properties":{"features":{"items":{"$ref":"#/components/schemas/Feature"},"type":"array"}},"title":"FeatureCollection","type":"object"},"WeatherAlertRequestGeoJson":{"description":"Weather alerts geojson request.","properties":{"features":{"items":{"$ref":"#/components/schemas/FeatureRequest"},"type":"array"}},"title":"FeatureCollection","type":"object"},"Geometry":{"description":"Geometry object.","oneOf":[{"$ref":"#/components/schemas/GeoJsonPolygonType"},{"$ref":"#/components/schemas/GeoJsonMultiPolygonType"}],"title":"Geometry","type":"object","discriminator":{"propertyName":"type","mapping":{"Polygon":"#/components/schemas/GeoJsonPolygonType","MultiPolygon":"#/components/schemas/GeoJsonMultiPolygonType"}}},"GeometryRequest":{"description":"Geometry object.","oneOf":[{"$ref":"#/components/schemas/GeoJsonPointType"},{"$ref":"#/components/schemas/GeoJsonLineStringType"}],"title":"Geometry","type":"object"},"GeoJsonPointType":{"description":"GeoJson geometry.","properties":{"type":{"enum":["Point"],"type":"string"},"coordinates":{"items":{"$ref":"#/components/schemas/Point2D"},"type":"array","maxItems":1,"minItems":1}},"required":["type"],"title":"Point","type":"object","example":[11.125,23.456]},"GeoJsonLineStringType":{"description":"GeoJson geometry.","properties":{"type":{"enum":["LineString"],"type":"string"},"coordinates":{"items":{"$ref":"#/components/schemas/Point2D"},"type":"array"}},"required":["type"],"title":"LineString","type":"object","example":[[19.122004508972168,48.72310386355342],[19.123892784118652,48.72324541933301],[19.125652313232422,48.72313217474119],[19.125566482543945,48.72259425944797],[19.12621021270752,48.72267919382413]]},"GeoJsonPolygonType":{"description":"GeoJson geometry.","properties":{"type":{"enum":["Polygon"],"type":"string"},"coordinates":{"items":{"items":{"$ref":"#/components/schemas/Point2D"},"type":"array"},"type":"array"}},"required":["type"],"title":"Polygon","type":"object","example":[[[148.2204,-36.6264],[148.214811,-36.638078],[148.210563,-36.646957],[148.208364,-36.651551],[148.199408,-36.670267]]]},"GeoJsonMultiPolygonType":{"description":"GeoJson geometry.","properties":{"type":{"enum":["MultiPolygon"],"type":"string"},"coordinates":{"items":{"items":{"items":{"$ref":"#/components/schemas/Point2D"},"type":"array"},"type":"array"},"type":"array"}},"required":["type"],"title":"MultiPolygon","type":"object"},"NumberItems":{"title":"NumberItems","type":"number"},"Point2D":{"description":"Point in 2D space","items":{"$ref":"#/components/schemas/NumberItems"},"maxItems":2,"minItems":2,"title":"Point2D","type":"array"},"FeatureProperties":{"type":"object","properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}},"FeatureRequestProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32","example":3000,"default":50000,"minimum":1000,"maximum":100000}}},"Warning":{"description":"Warning details","type":"object","properties":{"severity":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5],"example":2,"description":"The severity of the event. One of:\n- 0 Event doesn't have significance by nature.\n- 1 There are no alerts for the location.\n- 2 Minor Severity, the event is potentially dangerous but not usual.\n- 3 Medium Severity, the event is dangerous.\n- 4 High Severity, The event is very dangerous.\n- 5 Emergency. Take immediate action to protect life.\n"},"type":{"type":"integer","format":"int32","example":3,"description":"Event type\n|Event Type|Description|\n|---|---|\n|1|Extremely high temperature|\n|2|Extremely low temperature|\n|3|Fog|\n|4|Ice or freezing rain|\n|5|Rain|\n|6|Snow|\n|7|Thunderstorm|\n|8|Wind|\n|9|Air quality|\n|10|Volcanic ashfall|\n|11|Avalanche|\n|12|Tsunami|\n|13|Dust storm or sandstorm|\n|14|Earthquake|\n|15|Fire danger|\n|16|Flood|\n|17|High waves|\n|18|High UV index|\n|19|Low water|\n|20|Smoke or smog|\n|21|Volcano|\n|22|Ice in waterway|\n|23|Coastal event|\n|24|Civil danger|\n|25|Evacuation|\n|26|Hazardous materials|\n|27|Radiological hazard|\n|28|Shelter in place|\n|29|Warning|\n"},"country":{"type":"string","example":"JP","description":"ISO-3166-1 2-letter country code."},"startTime":{"type":"integer","format":"int32","example":1598510460,"description":"Start time of the event in UNIX time."},"endTime":{"type":"integer","format":"int32","example":1598536800,"description":"End time of the event in UNIX time. \nIf not present, warning is valid until it is not removed from the feed by national weather institutes (valid until warning is present in the response).\n"},"messages":{"description":"An array of localized textual descriptions of the event.","type":"array","items":{"$ref":"#/components/schemas/Message"}}}},"Message":{"description":"Warning message.","type":"object","properties":{"language":{"type":"string","example":"en-AU","description":"Language code."},"text":{"type":"string","example":"Minor Flood Warning","description":"Human readable weather warning description."}}},"PlaceMetadata":{"type":"object","properties":{"id":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"location":{"$ref":"#/components/schemas/Location"},"distance":{"type":"number","format":"double","example":11.4}}},"ObservationWeatherItem":{"type":"object","allOf":[{"type":"object"},{"properties":{"place":{"$ref":"#/components/schemas/PlaceMetadata"}}},{"$ref":"#/components/schemas/WeatherItem"}]},"ForecastWeatherItem":{"type":"object","properties":{"place":{"$ref":"#/components/schemas/PlaceMetadata"},"forecasts":{"type":"array","items":{"$ref":"#/components/schemas/WeatherItem"}}}},"WeatherItem":{"type":"object","properties":{"daylight":{"type":"string","enum":["day","night"],"example":"day","description":"Part of the day (D=day or N=night)."},"daySegment":{"type":"string","enum":["morning","afternoon","evening","night"],"example":"morning","description":"Day segment"},"description":{"type":"string","example":"Passing clouds. Mild.","description":"Human-readable weather description"},"skyInfo":{"type":"integer","format":"int32","example":7,"description":"Sky descriptor value.\nIf the element is in the response and it contains a value, there is an Integer in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe available values are as follows: \n\n    1 - Sunny\n    2 - Clear\n    3 - Mostly Sunny\n    4 - Mostly Clear\n    5 - Hazy Sunshine\n    6 - Haze\n    7 - Passing Clouds\n    8 - More Sun than Clouds\n    9 - Scattered Clouds\n    10 - Partly Cloudy\n    11 - A Mixture of Sun and Clouds\n    12 - High Level Clouds\n    13 - More Clouds than Sun\n    14 - Partly Sunny\n    15 - Broken Clouds\n    16 - Mostly Cloudy\n    17 - Cloudy\n    18 - Overcast\n    19 - Low Clouds\n    20 - Light Fog\n    21 - Fog\n    22 - Dense Fog\n    23 - Ice Fog\n    24 - Sandstorm\n    25 - Duststorm\n    26 - Increasing Cloudiness\n    27 - Decreasing Cloudiness\n    28 - Clearing Skies\n    29 - Breaks of Sun Later\n    30 - Early Fog Followed by Sunny Skies\n    31 - Afternoon Clouds\n    32 - Morning Clouds\n    33 - Smoke\n    34 - Low Level Haze\n"},"skyDesc":{"type":"string","example":"Passing clouds","description":"Description of sky conditions.\nSee the text descriptions associated with the skyInfo element above.\n"},"temperature":{"type":"number","format":"double","example":24.39,"description":"Temperature in Celsius/Fahrenheit.\n\nThe value depends on the units parameter value. The default is Celsius.\n"},"temperatureDesc":{"type":"string","example":"Mild","description":"Temperature description.\n\nThe available values are as follows:\n\n    Extremely Cold\n    Frigid\n    Cold\n    Chilly\n    Nippy\n    Cool\n    Refreshing Cool\n    Mild\n    Pleasantly Warm\n    Warm\n    Hot\n    Extremely Hot\n    Breezy\n    Windy\n    Gusty\n    Blustery\n    Very Windy\n    Extremely Windy\n    High Winds\n    Beautiful\n    Very Nice\n    Nice\n    Dreary\n    Smoggy\n    Low Level Pollution\n    Blowing Snow\n    Blowing Spray\n    Dry\n    Comfortable\n    Crisp\n    Raw\n    Damp\n    Humid\n    Muggy\n    Sultry\n    Steamy\n"},"comfort":{"type":"string","example":"24.31","description":"Comfort level in degrees. This value indicates what the temperature feels like, depending on a variety of environmental factors such as wind speed and humidity.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n"},"highTemperature":{"type":"string","example":"31.40","description":"The Highest temperature for the day in Celsius/Fahrenheit.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value. The default is Celsius.\n"},"lowTemperature":{"type":"string","example":"24.6","description":"The lowest temperature for the day in Celsius/Fahrenheit.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value. The default is Celsius.\n"},"humidity":{"type":"string","example":"91","description":"Humidity as a percentage (%)\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n"},"dewPoint":{"type":"number","format":"double","example":22.78,"description":"Dew point in Celsius/Fahrenheit.\n\nThe value used depends on the units parameter value. The default is Celsius.\n"},"precipitation1H":{"type":"number","format":"double","example":1,"description":"Precipitation over 1 hour in cm/in.\n\nThe value used depends on the units parameter value.\n"},"precipitation3H":{"type":"number","format":"double","example":2,"description":"Precipitation over 3 hour in cm/in.\n\nThe value used depends on the units parameter value.\n"},"precipitation6H":{"type":"number","format":"double","example":4,"description":"Precipitation over 6 hour in cm/in.\n\nThe value used depends on the units parameter value.\n"},"precipitation12H":{"type":"number","format":"double","example":5,"description":"Precipitation over 12 hour in cm/in.\n\nThe value used depends on the units parameter value.\n"},"precipitation24H":{"type":"number","format":"double","example":11,"description":"Precipitation over 24 hour in cm/in.\n\nThe value used depends on the units parameter value.\n"},"precipitationProbability":{"type":"integer","format":"int32","example":22,"description":"Precipitation probability percentage (%).\n"},"precipitationDesc":{"type":"string","example":"Strong thunderstorms","description":"Precipitation description.\n\nThe possible values are:\n\n    Drizzle\n    Sprinkles\n    Scattered Showers\n    A Few Showers\n    Light Showers\n    Passing Showers\n    Light Rain\n    Rain Showers\n    Rain\n    Numerous Showers\n    Showery\n    Heavy Rain\n    Lots of Rain\n    Tons of Rain\n    Flash Floods\n    Widely Scattered TStorms\n    Isolated TStorms\n    A Few TStorms\n    Thundershowers\n    Thunderstorms\n    Strong Thunderstorms\n    Severe Thunderstorms\n    Hail\n    Tornado\n    Tropical Storm\n    Hurricane\n    Light Freezing Rain\n    Light Mixture of Precip\n    Sleet\n    Icy Mix\n    Freezing Rain\n    Mixture of Precip\n    Heavy Mixture of Precip\n    Snow Changing to Rain\n    Snow Changing to an Icy Mix\n    An Icy Mix Changing to Snow\n    An Icy Mix Changing to Rain\n    Rain Changing to Snow\n    Rain Changing to an Icy Mix\n    Scattered Flurries\n    Snow Flurries\n    Light Snow Showers\n    Snow Showers\n    Light Snow\n    Snow\n    Moderate Snow\n    Heavy Snow\n    Snowstorm\n    Blizzard\n    Sprinkles Early\n    Showers Early\n    Light Rain Early\n    Rain Early\n    Heavy Rain Early\n    TStorms Early\n    Flurries Early\n    Snow Showers Early\n    Light Snow Early\n    Snow Early\n    Heavy Snow Early\n    Light Icy Mix Early\n    Icy Mix Early\n    Sprinkles Late\n    Showers Late\n    Light Rain Late\n    Rain Late\n    Heavy Rain Late\n    Isolated TStorms Late\n    Scattered TStorms Late\n    TStorms Late\n    Flurries Late\n    Snow Showers Late\n    Light Snow Late\n    Snow Late\n    Heavy Snow Late\n    Light Icy Mix Late\n    Icy Mix Late\n"},"rainFall":{"type":"number","format":"double","example":11,"description":"Amount of rain in cm/in.\n\nThe value used depends on the units parameter value.\n"},"snowFall":{"type":"number","format":"double","example":0,"description":"Amount of snow in cm/in.\n\nThe value used depends on the metric parameter value.\n"},"airInfo":{"type":"integer","format":"int32","example":7,"description":"Air description value\n\nThe possible values are as follows:\n\n    1 - Extremely Cold\n    2 - Frigid\n    3 - Cold\n    4 - Chilly\n    5 - Nippy\n    6 - Cool\n    7 - Refreshing Cool\n    8 - Mild\n    9 - Pleasantly Warm\n    10 - Warm\n    11 - Hot\n    12 - Extremely Hot\n    13 - Breezy\n    14 - Windy\n    15 - Gusty\n    16 - Blustery\n    17 - Very Windy\n    18 - Extremely Windy\n    19 - High Winds\n    20 - Beautiful\n    21 - Very Nice\n    22 - Nice\n    23 - Dreary\n    24 - Smoggy\n    25 - Low Level Pollution\n    26 - Blowing Snow\n    27 - Blowing Spray\n    28 - Dry\n    29 - Comfortable\n    30 - Crisp\n    31 - Raw\n    32 - Damp\n    33 - Humid\n    34 - Muggy\n    35 - Sultry\n    36 - Steamy\n"},"airDesc":{"type":"string","example":"Refreshing Cool","description":"Air description.\n\nSee the text descriptions associated with the airInfo element above.\n"},"windSpeed":{"type":"number","format":"double","example":14.83,"description":"Wind speed in km/h or mph.\n\nThe value used depends on the units parameter value.\n"},"windDirection":{"type":"number","format":"double","example":200,"description":"Wind direction in degrees.\n"},"windDesc":{"type":"string","example":"Northwest","description":"Human readable description of the direction of the wind.\n"},"windDescShort":{"type":"string","example":"NW","description":"Abbreviation of the direction the wind is coming from.\n"},"beaufortScale":{"type":"integer","format":"int32","example":0,"description":"Wind speed on the Beaufort scale.\n\nThe possible values are:\n\n    0 - Calm\n    1 - Light Air\n    2 - Light Breeze\n    3 - Gentle Breeze\n    4 - Moderate Breeze\n    5 - Fresh Breeze\n    6 - Strong Breeze\n    7 - Near Gale\n    8 - Gale\n    9 - Severe Gale\n    10 - Storm\n    11 - Violent Storm\n    12 - Hurricane\n"},"beaufortDesc":{"type":"string","example":"Calm","description":"Beaufort scale conditions description.\n\nSee the text descriptions associated with the beaufortScale element above.\n"},"uvIndex":{"type":"integer","format":"int32","example":3,"description":"UV Index value.\n\nThe possible values are:\n\n    0 - Minimal\n    3 - Low\n    5 - Moderate\n    7 - High\n    10 - Extreme\n"},"uvDesc":{"type":"string","example":"Low","description":"UV conditions description.\n\nSee the text descriptions associated with the uvIndex element above.\n"},"barometerPressure":{"type":"number","format":"double","example":1006.1,"description":"Barometric pressure in mbar/in. Value is corrected to the mean sea-level pressure (MSLP)\n"},"barometerTrend":{"type":"string","example":"Falling","description":"Description of the trend in the barometric pressure.\n"},"visibility":{"type":"number","format":"double","example":150,"description":"Visibility in km/mi.\n\nThe value used depends on the units parameter value.\n"},"snowCover":{"type":"number","format":"double","example":0,"description":"Amount of snow on the ground in cm/in.\n\nThe value used depends on the units parameter value.\n"},"iconId":{"type":"integer","format":"int32","example":3,"description":"Icon number.\n\nThe possible values are in range 1 to 36 and depends on weather conditions and day segment. One number can represent multiple weather conditions.\n\nValue 36 means wether station does not report any information about weather conditions like sky description, cloudiness, precipitation etc. so is unknown which icon best describes weather conditions.\nLink to blank image is in `iconLink` field in this case.\n\n    1 - Sunny\n    2 - Mostly Sunny\n    3 - Haze\n    4 - Partly Cloudy\n    5 - High Clouds\n    6 - Mostly Cloudy\n    7 - Cloudy\n    8 - Light Fog\n    9 - Dense Fog\n    10 - Ice Fog\n    11 - Sand Storm\n    12 - Early Fog\n    13 - Night Clear\n    14 - Night Mostly Clear\n    15 - Night Partly Cloudy\n    16 - Night High Clouds\n    17 - Night Mostly Cloudy\n    18 - Sprinkles\n    19 - Rain\n    20 - Heavy Rain\n    21 - Scattered Thunderstorms\n    22 - Thunderstorms\n    23 - Severe Thunderstorms\n    24 - Hail\n    25 - Tornado\n    26 - Hurricane\n    27 - Sleet\n    28 - Snow and Rain Mix\n    29 - Light Snow\n    30 - Snow\n    31 - Heavy Snow\n    32 - Flood\n    33 - Showers\n    34 - Night Sprinkles\n    35 - Night Thunderstorms\n    36 - No Report\n"},"iconName":{"type":"string","example":"severeTstorms","description":"Icon name.\n\nThe possible values are:\n\n    sunny\n    clear\n    mostlySunny\n    mostlyClear\n    passingClounds\n    moreSunThanClouds\n    scatteredClouds\n    partlyCloudy\n    aMixtureOfSunAndClouds\n    increasingCloudiness\n    breaksOfSunLate\n    afternoonClouds\n    morningClouds\n    partlySunny\n    highLevelClouds\n    decreasingCloudiness\n    clearingSkies\n    highClouds\n    rainEarly\n    heavyRainEarly\n    strongThunderstorms\n    severeThunderstorms\n    thundershowers\n    thunderstorms\n    tstormsEarly\n    isolatedTstormsLate\n    scatteredTstormsLate\n    tstormsLate\n    tstorms\n    iceFog\n    moreCloudsThanSun\n    brokenClouds\n    scatteredShowers\n    aFewShowers\n    lightShowers\n    passingShowers\n    rainShowers\n    showers\n    widelyScatteredTstorms\n    isolatedTstorms\n    aFewTstorms\n    scatteredTstorms\n    hazySunshine\n    haze\n    smoke\n    lowLevelHaze\n    earlyFogFollowedBySunnySkies\n    earlyFog\n    lightFog\n    fog\n    denseFog\n    nightHaze\n    nightSmoke\n    nightLowLevelHaze\n    nightWidelyScatteredTstorms\n    nightIsolatedTstorms\n    nightFewTstorms\n    nightScatteredTstorms\n    nightTstorms\n    nightClear\n    mostlyCloudy\n    cloudy\n    overcast\n    lowClouds\n    hail\n    sleet\n    lightMixtureOfPrecip\n    icyMix\n    mixtureOfPrecip\n    heavyMixtureOfPrecip\n    snowChangingToRain\n    snowChangingToAnIcyMix\n    anIcyMixChangingToSnow\n    anIcyMixChangingToRain\n    rainChangingToSnow\n    rainCangingToAnIcyMix\n    lightIcyMixEarly\n    icyMixEarly\n    lightIcyMixLate\n    icyMixLate\n    snowRainMix\n    scatteredFlurries\n    snowFlurries\n    lightSnowShowers\n    snowShowers\n    lightSnow\n    flurriesEarly\n    snowShowersEarly\n    lightSnowEarly\n    flurriesLate\n    snowShowersLate\n    lightSnowLate\n    nightDecreasingCloudiness\n    nightClearingSkies\n    nightHighLevelClouds\n    nightHighClouds\n    nightScatteredShowers\n    nightAFewShowers\n    nightLightShowers\n    nightPassingShowers\n    nightRainShowers\n    nightSprinkles\n    nightShowers\n    nightMostlyClear\n    nightPassingClouds\n    nightScatteredClouds\n    nightPartlyCloudy\n    increasingCloudiness\n    nightAfternoonClouds\n    nightMorningClouds\n    nightBrokenClouds\n    nightMostlyCloudy\n    lightFreezingRain\n    freezingRain\n    heavyRain\n    lotsOfRain\n    tonsOfRain\n    heavyRainEarly\n    heavyRainLate\n    flashFloods\n    flood\n    drizzle\n    sprinkles\n    lightRain\n    sprinklesEarly\n    lightRainEarly\n    sprinklesLate\n    lightRainLate\n    rain\n    numerousShowers\n    showery\n    showersEarly\n    rainEarly\n    showersLate\n    rainLate\n    snow\n    moderateSnow\n    snowEarly\n    snowLate\n    heavySnow\n    heavySnowEarly\n    heavySnowLate\n    tornado\n    tropicalStorm\n    hurricane\n    sandStorm\n    dustStorm\n    snowStorm\n    blizzard\n    noReportIcon\n"},"iconLink":{"type":"string","example":"https://weather.hereapi.com/static/weather/icon/6.png","description":"Link to icon resource file.\n\nAn individual icon may be used for more than one of the iconName values given above and image file name may be different from icon field value.\n"},"ageMinutes":{"type":"integer","format":"int32","example":33,"description":"Data age in minutes.\n"},"activeAlerts":{"type":"integer","format":"int32","example":0,"description":"Number of active weather alerts.\n"},"weekday":{"$ref":"#/components/schemas/WeekDayType"},"time":{"type":"string","format":"date-time","example":"2020-08-28T00:00:00.000-05:00","description":"Date and time the forecast was issued. The format is either YYYY-MM-DDThh:mm:ss.SSS + the timezone offset, unless the forecast is for a location in the UTC zone, in which the date and time is terminated by a Z.\n\nNote: If daylight saving time is in effect for a specified location, times are adjusted for daylight saving time.\n"}}},"WeekDayType":{"type":"string","example":"th","description":"Day of week\n","enum":["mo","tu","we","th","fr","sa","su"]},"AlertItem":{"type":"object","properties":{"place":{"$ref":"#/components/schemas/PlaceMetadata"},"timeSegments":{"type":"array","items":{"type":"object","properties":{"segment":{"type":"string","enum":["morning","afternoon","evening","night"],"description":"Day segment."},"weekday":{"$ref":"#/components/schemas/WeekDayType"}}}},"type":{"type":"integer","format":"int32","example":1,"description":"Type of alert.\n\n|ID| Description|\n|---|---|\n|1|Strong Thunderstorms Anticipated - Strong thunderstorms anticipated during the next 24 hours.|\n|2|Severe Thunderstorms Anticipated - Severe thunderstorms anticipated during the next 24 hours (supersedes the strong thunderstorm alert).|\n|3|Tornadoes Possible - Conditions are favorable for the formation of tornadoes (supersedes the severe thunderstorm alert).|\n|4|Heavy Rain Anticipated - More than 1 inch of rain in the next 24 hours (and less than 2 inches).|\n|5|Floods Anticipated - More than 2 inches of rain in the next 24 hours.|\n|6|Flash Floods Anticipated - More than 1 inch of rain in any 6 hour time period (supersedes Flood Alert and Heavy Rain Alert).|\n|7|High Winds Anticipated - Winds greater than 35 mph.|\n|8|Heavy Snow Anticipated - More than 6 inches of snow in a 12-hour period (anytime during the next 24 hours).|\n|9|Blizzard Conditions Anticipated - More than 6 inches of snow anticipated with winds greater than 35 mph.|\n|10|Blowing Snow Anticipated - High winds anticipated with fresh snow on the ground (superseded by Blizzard Alert).|\n|11|Freezing Rain Anticipated - Light freezing rain and/or sleet anticipated.|\n|12|Ice Storm Anticipated - Heavy freezing rain anticipated along with hazardous driving conditions.|\n|13|Snow Advisory - More than 1 inch of snow anticipated during the next 24 hours (and less than 6 inches).|\n|14|Winter Weather Advisory - A mixture of winter-like conditions anticipated.\n|15|Heat Advisory - Comfort indices exceeding 110F.|\n|16|Excessive Heat Alert - comfort indices above 115F with dew points above 80F (supersedes heat advisory).|\n|17|Wind Chill Alert - Issued when the wind chill is 20 below zero or lower with a minimum of a 10 mph wind|\n|18|Frost Advisory - Freezing temperatures and light winds (only issued during the Spring and Fall for low latitude/ low elevation locations).|\n|19|Freeze Advisory - A hard freeze anticipated (only issued during the Spring and Fall for low latitude/ low elevation locations).|\n|20|Fog Anticipated - Visibility expected to drop below 1/4 mile|\n|21|Dense Fog Anticipated - Visibility expected to drop below 1/8 mile (superSedes Fog Alert).|\n|22|Smog Anticipated - Low visibilities and warm temperatures|\n|30|Tropical Cyclone Conditions Anticipated - Winds greater than 40 mph with temperatures above 80F and heavy rain.|\n|31|Hurricane Conditions Anticipated - Winds greater than 75 mph with temperatures above 80F and heavy rain.|\n|32|Small Craft Advisory Anticipated - Winds greater than 25 mph anticipated.|\n|33|Gale Warning Anticipated - Winds greater than 35 mph anticipated.|\n|34|Winds greater than 35 mph anticipated - Winds greater than 50 mph anticipated.|\n|35|Heavy Surf Advisory - Waves over 15 feet high.|\n"},"description":{"type":"string","example":"Strong Thunderstorms Anticipated - Strong thunderstorms anticipated during the next 24 hours","description":"Description of the alert."}}},"AstronomyForecastItem":{"type":"object","properties":{"place":{"$ref":"#/components/schemas/PlaceMetadata"},"forecasts":{"type":"array","items":{"$ref":"#/components/schemas/AstronomyItem"}}}},"AstronomyItem":{"type":"object","properties":{"sunRise":{"type":"string","format":"partialTime","example":"06:37:00","description":"Time when the sun rises."},"sunSet":{"type":"string","format":"partialTime","example":"18:48:00","description":"Time when the sun sets."},"moonRise":{"type":"string","format":"partialTime","example":"02:57:00","description":"Time when the mmoon rises."},"moonSet":{"type":"string","format":"partialTime","example":"17:47:00","description":"Time when the moon sets."},"moonPhase":{"type":"number","format":"double","minimum":-1,"maximum":1,"example":-0.15,"description":"The moon phase expressed as floating point number between -1 and 1.\n\nThe following logic should be used for displaying moonphase information:\n\n|Moon phase value|Description|\n|---|---|\n|-0.1 <= moonphase <= 0.1|New moon.|\n|0.1 < moonphase < 0.4|Waxing crescent.|\n|0.4 <= moonphase <= 0.6|First Quarter.|\n|0.6 < moonphase < 0.9|Waxing gibbous.|\n|0.9 <= moonphase or moonphase <= -0.9|Full moon.|\n|-0.9 < moonphase < -0.6|Waning gibbous.|\n|-0.6 <= moonphase <= -0.4|Last Quarter.|\n|-0.4 < moonphase < -0.1|Waning crescent.|\n"},"moonPhaseDescription":{"type":"string","example":"Waning crescent","description":"Description of the phase of the moon."},"moonIconName":{"type":"string","example":"cw_waning_crescent","description":"Name of the icon for moon phase from the reporting service."},"time":{"type":"string","format":"date-time","example":"2020-08-28T00:00:00.000-05:00","description":"Date and time the forecast was issued. The format is either YYYY-MM-DDThh:mm:ss.SSS + the timezone offset, unless the forecast is for a location in the UTC zone, in which the date and time is terminated by a Z.\n\nNote: If daylight saving time is in effect for a specified location, times will be adjusted for daylight savings time.\n"}}},"NWSAlertsType":{"type":"object","properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/NWSAlertItems"},"description":"Warnings issued for location.\n\nThese alerts require immediate notification and are extremely time sensitive. Severe weather warnings are sorted by county id and should generally only be sent to locations within that particular county. Customer may wish to include warnings from counties within a certain distance threshold, such as 25 or 50 kilometers.\n"},"watches":{"type":"array","items":{"$ref":"#/components/schemas/NWSAlertItems"},"description":"Watches issued for location.\n\nIncludes watches, advisories, special weather statements, and marine warnings.\n\nThese alerts cover an extended time frame from several minutes to several hours; immediate activation is not always necessary for these alerts, although it is highly recommended. Severe Weather Watches are listed by zone and should be sent to all locations within a reasonable distance of the respective zone.\n"}}},"NWSAlertItems":{"type":"object","properties":{"counties":{"type":"array","items":{"$ref":"#/components/schemas/AlertZoneCountyType"}},"zones":{"type":"array","items":{"$ref":"#/components/schemas/AlertZoneCountyType"}},"provinces":{"type":"array","items":{"$ref":"#/components/schemas/AlertProvinceType"}},"type":{"type":"integer","format":"int32","example":5,"description":"Type of alert.\n\n|ID|Description|\n|---|---|\n|0|Aviation Weather Warning.|\n|1|Civil Emergency Message [1].|\n|2|Coastal Flood Warning, Watch, or Statement.|\n|3|Flash Flood Watch.|\n|4|Flash Flood Statement.|\n|5|Flash Flood Warning [1].|\n|6|Flood Statement.|\n|7|Flood Warning [1].|\n|8|Urban and Small Stream Flood Advisory [1].|\n|9|Hurricane Local Statement [1].|\n|10|Lakeshore Warning or Statement [1].|\n|11|Marine Weather Statement.|\n|12|Non Precipitation Warning, Watch, or Statement.|\n|13|Public Severe Weather Alert [1].|\n|14|Red Flag Warning.|\n|15|River Ice Statement.|\n|16|River Recreation Statement.|\n|17|River Statement.|\n|18|Snow Avalanche Bulletin.|\n|19|Preliminary Notice of Watch Cancellation - Aviation Message.|\n|20|Special Dispersion Statement.|\n|21|Severe Local Storm Watch or Watch Cancellation.|\n|22|SPC Watch Point Information Message.|\n|23|Severe Local Storm Watch and Areal Outline.|\n|24|Marine Subtropical Storm Advisory.|\n|25|Special Marine Warning [1].|\n|26|Storm Strike Probability Bulletin from the TPC.|\n|27|Special Weather Statement [2].|\n|28|Severe Thunderstorm Warning [1].|\n|29|Severe Weather Statement.|\n|30|Tropical Cyclone Advisory.|\n|31|Tropical Cyclone Advisory for Marine and Aviation Interests.|\n|32|Public Tropical Cyclone Advisory.|\n|33|Tropical Cyclone Update.|\n|34|Tornado Warning [1].|\n|35|Tsunami Watch or Warning [1].|\n|36|Volcanic Activity Advisory.|\n|37|Winter Weather Warning, Watch, or Advisory [1].|\n|38|Air Stagnation Advisory.|\n\n[1] Watch and Warning Types highly recommended for immediate activation.\n\n[2] Watch and Warning description can be more detailed for this type, such as 'Frost advisory in effect'.\n"},"description":{"type":"string","example":"Flash Flood Warning","description":"Short description of alert.\n"},"severity":{"type":"integer","format":"int32","example":3,"description":"The severity of alerts from 1-100 with 1 being the most severe.\n"},"message":{"type":"string","example":"FLASH FLOOD WARNING REMAINS IN EFFECT UNTIL 1115 PM MST THIS EVENING FOR MARICOPA COUNTY","description":"The warning or watch text is a long string of words describing the warning or watch in detail.\n"},"name":{"type":"string","example":"Saint Johns Mission","description":"Location name.\n"},"validFromTimeLocal":{"type":"string","format":"date-time","example":"2020-10-11T03:35:00.000-04:00","description":"Date and time at the location the alert was issued by National Weather Service. The format is either YYYY-MM-DDThh:mm:ss.SSS + the timezone offset, unless the forecast is for a location in the UTC zone, in which case the date and time is terminated by a Z.\n"},"validUntilTimeLocal":{"type":"string","format":"date-time","example":"2020-10-12T20:00:00.000-04:00","description":"Alert expiration date and time at the location. The format is either YYYY-MM-DDThh:mm:ss.SSS + the timezone offset, unless the forecast is for a location in the UTC zone, in which case the date and time is terminated by a Z.\n"}}},"AlertZoneCountyType":{"type":"object","properties":{"value":{"type":"string","example":"AZC013","description":"Location code (zone code, county code, province code).\nThe shape file information for zones, counties and provinces can be found here in National Weather Service GIS - AWIPS Shapefile Database (http://www.nws.noaa.gov/geodata/).\n"},"country":{"type":"string","example":"US","description":"2-letters ISO country code."},"countryName":{"type":"string","example":"United States","description":"Full country name."},"state":{"type":"string","example":"IL","description":"2-letters US-state abbreviation."},"stateName":{"type":"string","example":"Illinois","description":"Full US-state name."},"name":{"type":"string","example":"Maricopa","description":"Location name."},"location":{"$ref":"#/components/schemas/Location"}}},"AlertProvinceType":{"type":"object","properties":{"value":{"type":"string","example":"AZC013","description":"Location code (zone code, county code, province code).\nThe shape file information for zones, counties and provinces can be found here in National Weather Service GIS - AWIPS Shapefile Database (http://www.nws.noaa.gov/geodata/).\n"},"country":{"type":"string","example":"US","description":"2-letters ISO country code."},"countryName":{"type":"string","example":"United States","description":"Full country name."},"province":{"type":"string","example":true,"description":"2-letters province code. Canada only."},"provinceName":{"type":"string","example":"Ontario","description":"Full province name. Canada only."},"name":{"type":"string","example":"Maricopa"},"location":{"$ref":"#/components/schemas/Location"}}},"WeatherProduct":{"type":"string","enum":["observation","forecast7days","forecast7daysSimple","forecastHourly","forecastAstronomy","alerts","nwsAlerts"]},"LocationString":{"type":"string","example":"52.5251,13.3694"},"Address":{"type":"object","properties":{"label":{"type":"string","description":"Requested address.","example":"Schulstrasse 4, 32547 Bad Oeynhausen, Germany"},"countryCode":{"type":"string","description":"A three-letter country code.","example":"DEU"},"countryName":{"type":"string","description":"The localised country name.","example":"Deutschland"},"state":{"type":"string","description":"A code/abbreviation for the state division of a country.","example":"North Rhine-Westphalia"},"county":{"type":"string","description":"A division of a state; typically, a secondary-level administrative division of a country or equivalent.","example":"Mitte"},"city":{"type":"string","description":"The name of the primary locality of the place.","example":"Bad Oyenhausen"},"district":{"type":"string","description":"A division of city; typically an administrative unit within a larger city or a customary name of a city's neighborhood.","example":"Bad Oyenhausen"},"subdistrict":{"type":"string","description":"A subdivision of a district.","example":"Minden-Lubbecke"},"street":{"type":"string","description":"Name of street.","example":"Schulstrasse"},"postalCode":{"type":"string","description":"An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code.","example":"32547"},"houseNumber":{"type":"string","description":"House number.","example":"4"}}},"Location":{"type":"object","description":"Location on the Earth.","properties":{"lat":{"description":"Location of a point on Earth north or south of the equator in decimal degrees.","type":"number","format":"double","example":52.531677},"lng":{"description":"Location of a place on Earth, east or west of the prime meridian. in decimal degrees.","type":"number","format":"double","example":13.381777},"elv":{"description":"The elevation of a point above mean sea level in meters.","type":"number","example":512.5}},"example":{"lat":52.531677,"lng":13.381777},"required":["lat","lng"]},"ErrorResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32","description":"The HTTP status code."},"title":{"type":"string","description":"Human-readable error description."},"code":{"type":"string","description":"Error code"},"cause":{"type":"string","description":"Human-readable explanation for the error."},"action":{"type":"string","description":"Human-readable action for the user."},"correlationId":{"type":"string","description":"Auto-generated ID univocally identifying this request."}},"required":["status","title","code","cause","action","correlationId"]},"AuthError":{"description":"Error object reported in case of authentication or authorization errors.","type":"object","properties":{"error":{"type":"string","description":"Error message."},"error_description":{"type":"string","description":"Detailed information about the error."}},"example":{"Type":"Unauthorized","Message":"ApiKey invalid. ApiKey not found."}}},"examples":{"WeatherAlertsResponseExample":{"value":{"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[148.2204,-36.6264],[148.214811,-36.638078],[148.210563,-36.646957],[148.208364,-36.651551],[148.199408,-36.670267]]]},"properties":{"warnings":[{"severity":3,"startTime":1602043140,"country":"AU","endTime":1602162000,"type":29,"messages":[{"language":"en-AU","text":"Warning to Sheep Graziers for Mallee, Wimmera, Northern Country, North Central, North East, South West, Central and West and South Gippsland forecast districts"}]}]}}]}},"WeatherAlertsSingleLocationRequestExample":{"value":{"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"Point","coordinates":[15.256,23.456]},"properties":{"width":30000}}]}},"WeatherAlertsRouteRequestExample":{"value":{"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"LineString","coordinates":[[-87.64652354220011,41.87554760399442],[-87.70047592527803,41.87510123848884],[-87.74084030076565,1.87197659266343],[-87.80778122050994,41.87346453829784],[-87.87771949486996,41.87033981245949],[-87.90609445189584,41.873613330956374],[-87.93866570538339,41.8490578559865],[-87.94865688743465,41.84474107094087]]},"properties":{"width":3000}}]}},"WeatherReportObservationExample":{"value":{"places":[{"observations":[{"place":{"address":{"countryName":"United States","state":"Massachusetts","city":"Boston"},"location":{"lat":42.35843,"lng":-71.05977},"distance":1.4},"daylight":"night","description":"Passing clouds. Mild.","skyInfo":7,"skyDesc":"Passing clouds","temperature":24.39,"temperatureDesc":"Mild","comfort":"24.31","highTemperature":"31.4","lowTemperature":"24.6","humidity":"91","dewPoint":22.78,"precipitation1H":1,"precipitation3H":2,"precipitation6H":4,"precipitation12H":5,"precipitation24H":11,"precipitationProbability":22,"precipitationDesc":"Strong thunderstorms","rainFall":11,"snowFall":0,"airInfo":7,"airDesc":"Refreshing Cool","windSpeed":14.83,"windDirection":200,"windDesc":"Northwest","windDescShort":"NW","barometerPressure":1006.1,"barometerTrend":"Falling","visibility":150,"snowCover":0,"iconId":23,"iconName":"severeTstorms","iconLink":"https://weather.hereapi.com/static/weather/icon/6.png","ageMinutes":33,"activeAlerts":13,"time":"2020-10-12T01:54:00.000-04:00"}]}]}},"WeatherReportForecastExample":{"value":{"places":[{"extendedDailyForecasts":[{"place":{"address":{"countryName":"United States","state":"Massachusetts","city":"Boston"},"location":{"lat":42.35843,"lng":-71.05977},"distance":1.4},"forecasts":[{"daylight":"night","daySegment":"night","description":"Clear. Cool.","skyInfo":2,"skyDesc":"Clear","temperature":10,"temperatureDesc":"Cool","comfort":"7.43","humidity":"62","dewPoint":3,"precipitationProbability":1,"precipitationDesc":"","rainFall":0,"snowFall":0,"airInfo":7,"airDesc":"","windSpeed":19.44,"windDirection":56,"windDesc":"Northeast","windDescShort":"NE","beaufortScale":4,"beaufortDesc":"Moderate breeze","visibility":11.69,"iconName":"nightClear","iconId":13,"iconLink":"https://weather.hereapi.com/static/weather/icon/16.png","weekday":"su","time":"2020-10-12T00:00:00.000-04:00"},{"daylight":"day","daySegment":"morning","description":"High level clouds. Cool.","skyInfo":12,"skyDesc":"High level clouds","temperature":10.1,"temperatureDesc":"Cool","comfort":"7.26","humidity":"66","dewPoint":3.9,"precipitationProbability":3,"precipitationDesc":"","windSpeed":22.68,"windDirection":62,"windDesc":"Northeast","windDescShort":"NE","beaufortScale":4,"beaufortDesc":"Moderate breeze","visibility":12.31,"iconName":"highClouds","iconId":5,"iconLink":"https://weather.hereapi.com/static/weather/icon/4.png","weekday":"mo","time":"2020-10-12T06:00:00.000-04:00"}]}]}]}},"WeatherReportForecastSimpleExample":{"value":{"places":[{"dailyForecasts":[{"place":{"address":{"countryName":"United States","state":"Massachusetts","city":"Boston"},"location":{"lat":42.35843,"lng":-71.05977},"distance":1.4},"forecasts":[{"daylight":"day","description":"Sprinkles late. Increasing cloudiness. Cool.","skyInfo":26,"skyDesc":"Increasing cloudiness","temperatureDesc":"Cool","comfort":"10.68","highTemperature":"13.20","lowTemperature":"10.00","humidity":"67","dewPoint":6.89,"precipitationProbability":47,"precipitationDesc":"Sprinkles late","rainFall":0.02,"snowFall":0,"airDesc":"","windSpeed":26.23,"windDirection":70,"windDesc":"East","windDescShort":"E","beaufortScale":4,"beaufortDesc":"Moderate breeze","uvIndex":0,"uvDesc":"Minimal","barometerPressure":1024.82,"iconName":"sprinkles","iconId":18,"iconLink":"https://weather.hereapi.comm/static/weather/icon/27.png","weekday":"mo","time":"2020-10-12T00:00:00.000-04:00"},{"daylight":"day","description":"Rain. Low clouds. Cool.","skyInfo":19,"skyDesc":"Low clouds","temperatureDesc":"Cool","comfort":"15.93","highTemperature":"16.50","lowTemperature":"12.80","humidity":"91","dewPoint":14.5,"precipitationProbability":99,"precipitationDesc":"Rain","rainFall":1.93,"snowFall":0.26,"airInfo":32,"airDesc":"Damp","windSpeed":18.26,"windDirection":96,"windDesc":"East","windDescShort":"E","beaufortScale":4,"beaufortDesc":"Moderate breeze","uvIndex":0,"uvDesc":"Minimal","barometerPressure":1011.64,"iconName":"rain","iconId":19,"iconLink":"https://weather.hereapi.com/static/weather/icon/27.png","weekday":"tu","time":"2020-10-13T00:00:00.000-04:00"}]}]}]}},"WeatherReportForecastHourlyExample":{"value":{"places":[{"hourlyForecasts":[{"place":{"address":{"countryName":"United States","state":"Massachusetts","city":"Boston"},"location":{"lat":42.35843,"lng":-71.05977},"distance":1.4},"forecasts":[{"daylight":"night","description":"Mostly cloudy. Cool.","skyInfo":16,"skyDesc":"Mostly cloudy","temperature":10.3,"temperatureDesc":"Cool","comfort":"7.84","humidity":"63","dewPoint":3.4,"precipitationProbability":1,"precipitationDesc":"","rainFall":0,"snowFall":1,"airInfo":5,"airDesc":"","windSpeed":19.08,"windDirection":63,"windDesc":"Northeast","windDescShort":"NE","visibility":11.4,"iconName":"nightMostlyCloudy","iconId":17,"iconLink":"https://weather.hereapi.com/static/weather/icon/24.png","weekday":"mo","time":"2020-10-12T05:00:00.000-04:00"},{"daylight":"day","description":"Partly sunny. Cool.","skyInfo":14,"skyDesc":"Partly sunny","temperature":10.1,"temperatureDesc":"Cool","comfort":"7.59","humidity":"64","dewPoint":3.5,"precipitationProbability":2,"precipitationDesc":"","windSpeed":19.08,"windDirection":62,"windDesc":"Northeast","windDescShort":"NE","visibility":12.36,"iconName":"mostlyCloudy","icon":6,"iconLink":"https://weather.hereapi.com/static/weather/icon/17.png","weekday":"mo","time":"2020-10-12T06:00:00.000-04:00"}]}]}]}},"WeatherReportForecastAstronomyExample":{"value":{"places":[{"astronomyForecasts":[{"place":{"address":{"countryCode":"USA","countryName":"United States","state":"Massachusetts","city":"Boston"},"location":{"lat":42.35843,"lng":-71.05977}},"forecasts":[{"sunRise":"06:44:00","sunSet":"18:37:00","moonRise":"09:40:00","moonSet":"20:07:00","moonPhase":0.049,"moonPhaseDescription":"Waxing crescent","iconName":"cw_waxing_crescent","time":"2022-09-28T00:00:00.000-05:00"},{"sunRise":"06:45:00","sunSet":"18:36:00","moonRise":"10:53:00","moonSet":"20:38:00","moonPhase":0.107,"moonPhaseDescription":"Waxing crescent","iconName":"cw_waxing_crescent","time":"2022-09-29T00:00:00.000-05:00"}]}]}]}},"WeatherReportForecastedAlerstExample":{"value":{"places":[{"alerts":[{"place":{"address":{"countryName":"United States","state":"Massachusetts","city":"Boston"},"location":{"lat":42.35843,"lng":-71.05977},"distance":1.4},"timeSegments":[{"segment":"morning","weekday":"th"}],"type":1,"description":"Strong Thunderstorms Anticipated - Strong thunderstorms anticipated during the next 24 hours"}]}]}},"WeatherReportNWSAlerstExample":{"value":{"places":[{"nwsAlerts":{"warnings":[{"zones":[{"value":"ANZ231","country":"US","countryName":"United States","state":"IL","stateName":"Illinois","name":"Cape Cod Bay","location":{"lat":41.88063,"lng":-70.32472}}]},{"type":11,"description":"Small Craft Advisory","severity":70,"message":"SMALL CRAFT ADVISORY NOW IN EFFECT FROM 2 PM THIS AFTERNOON TO 8 PM EDT TUESDAY...","name":"Saint Johns Mission","validFromTimeLocal":"2020-10-12T07:32:00.000Z","validUntilTimeLocal":"2020-10-14T00:00:00.000Z"}],"watches":[{"provinces":[{"value":"AZC013","country":"US","countryName":"United States","province":"ON","provinceName":"Ontario","name":"Maricopa","location":{"lat":52.531677,"lng":13.381777}}]},{"type":5,"description":"Flash Flood Warning","severity":3,"message":"FLASH FLOOD WARNING REMAINS IN EFFECT UNTIL 1115 PM MST THIS EVENING FOR MARICOPA COUNTY","name":"Saint Johns Mission","validFromTimeLocal":"2020-10-11T03:35:00.000-04:00","validUntilTimeLocal":"2020-10-12T20:00:00.000-04:00"}]}}]}},"BadRequestExample":{"value":{"status":400,"title":"Invalid Request","cause":"All weather product names in 'products' parameter must be valid.","action":"Please provide valid poduct in the request.","code":"E611119","correlationId":"dfe3b1a5-214f-49a9-b8a0-d78bd623bac0"}},"BadRequestAlertExample":{"value":{"status":400,"title":"Invalid Request","cause":"Request body is empty.","action":"Please provide valid json request body.","code":"E611310","correlationId":"dfe3b1a5-214f-49a9-b8a0-d78bd623bac0"}},"BadRequestTileExample":{"value":{"status":400,"title":"Invalid Request","cause":"imageType 'temperature' is invalid. Only imageType=radar is allowed.","action":"Please provide valid imageType in the request.","code":"E611206","correlationId":"dfe3b1a5-214f-49a9-b8a0-d78bd623bac0"}},"InternalServerErrorExample":{"value":{"status":500,"title":"Internal Server Error","cause":"There was some issue processing the request.","action":"Please retry after some time.","code":"E611101","correlationId":"dfe3b1a5-214f-49a9-b8a0-d78bd623bac0"}},"502errorResponseExample":{"value":{"title":"Bad Gateway","status":502,"code":"E611201","cause":"Bad Gateway","action":"Failure of communication with external system.","correlationId":"dfe3b1a5-214f-49a9-b8a0-d78bd623bac0"}},"504errorResponseExample":{"value":{"title":"Gateway timeout","status":504,"code":"E611101","cause":"Gateway Timeout","action":"Did not receive a timely response from an upstream server","correlationId":"dfe3b1a5-214f-49a9-b8a0-d78bd623bac0"}}}}}