HERE Weather API v3

{"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",

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-destination-weather-v3-openapi.yml