UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 94.1 kB
{"openapi":"3.0.2","servers":[{"url":"/api/v1/premium"}],"info":{"description":"\n\nThis interactive documentation is using your API key which is filled in automatically, you can find and change this in [your dashboard](https://www.meteosource.com/client).\n\nUsing the `GET` button, open your selected endpoint and read the introduction. You will find a detailed description of available parameters. You can complete the `Parameters` section and hit `Execute` to view a full API response. You can then inspect the JSON response, copy the `curl` command to run it on your machine, or obtain a URL of the request. In this way, you can easily build request command for the data you need.\n","title":"Interactive documentation for your Premium plan","version":"v1","x-logo":{"url":"https://meteosource.com/static/img/apple-touch-icon.png"},"x-origin":[{"format":"openapi","url":"https://www.meteosource.com/api/v1/premium/openapi.json","version":"3.0"}],"x-providerName":"meteosource.com"},"paths":{"/air_quality":{"get":{"description":"## Air quality forecast for a single location\n\n### Location specification\nThe location of the weather data is the only parameter that is required and must be specified. There are two ways to do this:\n1. Specify the GPS coordinates of the location using the parameters `lat` and `lon`.\n2. **OR** specify the name of the place using the parameter `place_id`. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).\n\n### Notes\n* **For a detailed description of variables, please consult ⚠️ <a href=\"https://www.meteosource.com/documentation#description_aq\" target=\"_blank\">description of variables</a> ⚠️ in Documentation or `Schema` of the response (link next to Example value in the Responses section below).**\n* Do **not** make any assumptions about the number and ordering of the variables. New variables and sections may be introduced in the future. Always check the data are present before you try to use them.\n* The response contains an `Expires` header, which defines the point at which the API response will not change for the same request. We highly recommend using this to avoid unnecessary requests and **increase the performance of your app**.\n* Meteosource API supports HTTP compression. To enable it, simply add an `Accept-Encoding: gzip` header to your request.\n* When daylight saving time starts, one hourly record will be missing (typically `2:00:00 AM`). When daylight saving time ends, the hourly forecast will contain two records with duplicate times (typically `2:00:00 AM`).","operationId":"air_quality_air_quality_get","parameters":[{"description":"Identifier of a place. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).","in":"query","name":"place_id","required":false,"schema":{"description":"Identifier of a place. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).","title":"Place Id","type":"string"}},{"description":"Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4","in":"query","name":"lat","required":false,"schema":{"description":"Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4","title":"Lat","type":"string"}},{"description":"Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4","in":"query","name":"lon","required":false,"schema":{"description":"Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4","title":"Lon","type":"string"}},{"description":"Timezone to be used for the date fields. If not specified, local timezone of the forecast location will be used.\nThe format is according to the tzinfo database, so values like `Europe/Prague` or `UTC` can be used.\nAlternatively you may use the value ``auto`` in which case the local timezone of the location is used.\nThe full list of valid timezone strings can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\n","in":"query","name":"timezone","required":false,"schema":{"description":"Timezone to be used for the date fields. If not specified, local timezone of the forecast location will be used.\nThe format is according to the tzinfo database, so values like `Europe/Prague` or `UTC` can be used.\nAlternatively you may use the value ``auto`` in which case the local timezone of the location is used.\nThe full list of valid timezone strings can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\n","title":"Timezone","type":"string"}},{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","in":"query","name":"key","required":false,"schema":{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","title":"Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AirQuality_PointData"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Error in passed parameter."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per day limit exceeded."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"API key not not specified or invalid."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per minute limit exceeded."}},"security":[{"APIKeyHeader":[]}],"summary":"Returns air quality data for a single point (geographic name or GPS)","tags":["Point weather"]}},"/find_places":{"get":{"description":"## Search for places\n\nYou can use this endpoint to obtain `place_id` of the location you want, to be used in `point` endpoint.\nThe response also contains detailed information about the location, such as coordinates, timezone and the country the place belongs to.\n\nUnlike the `/find_place_prefix` endpoint, complete words are required here. You can search for cities,\nmountains, lakes, countries, ZIP codes, etc. The response can contain multiple places, sorted by relevance.\nYou can then identify the one you want by coordinates, country, or the administrative area.","operationId":"find_places_find_places_get","parameters":[{"description":"Place name or ZIP code","in":"query","name":"text","required":true,"schema":{"description":"Place name or ZIP code","title":"Text","type":"string"}},{"description":"The language of text summaries and place names (variable names are never translated). Available languages are:\n\n * ``en``: English\n * ``es``: Spanish\n * ``fr``: French\n * ``de``: German\n * ``pl``: Polish\n * ``pt``: Portuguese\n * ``cs``: Czech\n","in":"query","name":"language","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Language"}],"default":"en","description":"The language of text summaries and place names (variable names are never translated). Available languages are:\n\n * ``en``: English\n * ``es``: Spanish\n * ``fr``: French\n * ``de``: German\n * ``pl``: Polish\n * ``pt``: Portuguese\n * ``cs``: Czech\n"}},{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","in":"query","name":"key","required":false,"schema":{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","title":"Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FindPlacesModel"},"title":"Response Find Places Find Places Get","type":"array"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Error in passed parameter."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per day limit exceeded."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"API key not not specified or invalid."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per minute limit exceeded."}},"security":[{"APIKeyHeader":[]}],"summary":"Search for places. Complete words required.","tags":["Location endpoints"]}},"/find_places_prefix":{"get":{"description":"## Search for places by prefix\n\nYou can use this endpoint to obtain `place_id` of the location you want, to be used in `point` endpoint. The response also contains detailed information about the location, such as coordinates, timezone and the country the place belongs to.\n\nUnlike the `/find_places` endpoint, you should only specify the prefix of the place you are looking for. This is particularly useful for autocomplete forms. You can search for cities, mountains, lakes, countries, ZIP codes, etc. The response can contain multiple places, sorted by relevance. You can then identify the one you want by coordinates, country, or the administrative area.","operationId":"find_places_prefix_find_places_prefix_get","parameters":[{"description":"Place name or ZIP code","in":"query","name":"text","required":true,"schema":{"description":"Place name or ZIP code","title":"Text","type":"string"}},{"description":"The language of text summaries and place names (variable names are never translated). Available languages are:\n\n * ``en``: English\n * ``es``: Spanish\n * ``fr``: French\n * ``de``: German\n * ``pl``: Polish\n * ``pt``: Portuguese\n * ``cs``: Czech\n","in":"query","name":"language","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Language"}],"default":"en","description":"The language of text summaries and place names (variable names are never translated). Available languages are:\n\n * ``en``: English\n * ``es``: Spanish\n * ``fr``: French\n * ``de``: German\n * ``pl``: Polish\n * ``pt``: Portuguese\n * ``cs``: Czech\n"}},{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","in":"query","name":"key","required":false,"schema":{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","title":"Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FindPlacesModel"},"title":"Response Find Places Prefix Find Places Prefix Get","type":"array"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Error in passed parameter."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per day limit exceeded."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"API key not not specified or invalid."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per minute limit exceeded."}},"security":[{"APIKeyHeader":[]}],"summary":"Prefix search for places. Useful for autocomplete forms.","tags":["Location endpoints"]}},"/map":{"get":{"description":"## PNG weather forecast maps for given area and variable\n\n### Area specification\nThere are two ways to specify geographical area you need for your map:\n1. Specify `X` and `Y` coordinates and zoom level `Z` of desired tile in <a href=\"https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection/\" rel=\"nofollow\" target=\"_blank\">Google Maps Tile notation</a>.\n2. Specify latitude and longitude bounds of the area you want to cover.\n\n### Notes\n* The resulting PNG maps are **always** in <a href=\"https://epsg.io/3857\" rel=\"nofollow\" target=\"_blank\">Google Mercator projection (EPSG:3857)</a>.\n* As Meteosource only covers areas between latitudes 80° and -80°, you can only request maps within these bounds, when specifying the latitude and longitude boundaries. When specifying the area using Google Maps Tile notation, the regions outside our supported latitudes will be fully transparent.\n* The finest resolution is not available for maps covering very large regions. The resulting map will be automatically downscaled in this case, to guarantee high-speed responses.\n* Weather maps are only supported for forecasts, not for archive data.","operationId":"map_map_get","parameters":[{"description":"The X coordinate of Google Maps tile","in":"query","name":"tile_x","required":false,"schema":{"description":"The X coordinate of Google Maps tile","title":"Tile X","type":"integer"}},{"description":"The Y coordinate of Google Maps tile","in":"query","name":"tile_y","required":false,"schema":{"description":"The Y coordinate of Google Maps tile","title":"Tile Y","type":"integer"}},{"description":"The zoom level of Google Maps tile","in":"query","name":"tile_zoom","required":false,"schema":{"description":"The zoom level of Google Maps tile","title":"Tile Zoom","type":"integer"}},{"description":"Minimal latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.2\n","in":"query","name":"min_lat","required":false,"schema":{"description":"Minimal latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.2\n","title":"Min Lat","type":"string"}},{"description":"Minimal longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.2\n","in":"query","name":"min_lon","required":false,"schema":{"description":"Minimal longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.2\n","title":"Min Lon","type":"string"}},{"description":"Maximal latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.2.\n","in":"query","name":"max_lat","required":false,"schema":{"description":"Maximal latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.2.\n","title":"Max Lat","type":"string"}},{"description":"Maximal longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.2\n","in":"query","name":"max_lon","required":false,"schema":{"description":"Maximal longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.2\n","title":"Max Lon","type":"string"}},{"description":"Name of the variable for your map. Available values are:\n\n* `temperature`: Temperature 2 metres above ground\n* `feels_like_temperature`: Feels like temperature\n* `clouds`: Percentage of sky covered by clouds\n* `precipitation`: Total precipitation amount accumulated since last hour\n* `wind_speed`: Wind speed 10 metres above the ground\n* `wind_gust`: Wind gust speed\n* `pressure`: Atmospheric pressure at mean sea level\n* `humidity`: Relative humidity\n* `wave_height`: Wave height\n* `wave_period`: Wave period\n* `sea_temperature`: Sea temperature (available only for +-24 hours)\n* `air_quality`: Air quality index\n* `ozone_surface`: Ozone at surface level\n* `ozone_total`: Total column ozone\n* `no2`: Nitrogen dioxide at surface level\n* `pm2.5`: Particulate matter d < 2.5 µm (PM2.5)\n","in":"query","name":"variable","required":true,"schema":{"description":"Name of the variable for your map. Available values are:\n\n* `temperature`: Temperature 2 metres above ground\n* `feels_like_temperature`: Feels like temperature\n* `clouds`: Percentage of sky covered by clouds\n* `precipitation`: Total precipitation amount accumulated since last hour\n* `wind_speed`: Wind speed 10 metres above the ground\n* `wind_gust`: Wind gust speed\n* `pressure`: Atmospheric pressure at mean sea level\n* `humidity`: Relative humidity\n* `wave_height`: Wave height\n* `wave_period`: Wave period\n* `sea_temperature`: Sea temperature (available only for +-24 hours)\n* `air_quality`: Air quality index\n* `ozone_surface`: Ozone at surface level\n* `ozone_total`: Total column ozone\n* `no2`: Nitrogen dioxide at surface level\n* `pm2.5`: Particulate matter d < 2.5 µm (PM2.5)\n","title":"Variable","type":"string"}},{"description":"There are two ways to specify date and time for your map:\n\n1. Datetime in `YYYY-MM-DDTHH:MM` format and `UTC` timezone, e.g. `2021-08-24T12:00`\n2. Offset from current time in `[+-]<minutes|hours|days>` format, e.g. `+10minutes`, `-2hours` or `+1days`\n","in":"query","name":"datetime","required":true,"schema":{"description":"There are two ways to specify date and time for your map:\n\n1. Datetime in `YYYY-MM-DDTHH:MM` format and `UTC` timezone, e.g. `2021-08-24T12:00`\n2. Offset from current time in `[+-]<minutes|hours|days>` format, e.g. `+10minutes`, `-2hours` or `+1days`\n","title":"Datetime","type":"string"}},{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","in":"query","name":"key","required":false,"schema":{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","title":"Key","type":"string"}}],"responses":{"200":{"content":{"image/png":{"schema":{"type":"string"}}},"description":"Successful Response"},"400":{"content":{"image/png":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Error in passed parameter."},"402":{"content":{"image/png":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per day limit exceeded."},"403":{"content":{"image/png":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"API key not not specified or invalid."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"image/png":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per minute limit exceeded."}},"security":[{"APIKeyHeader":[]}],"summary":"Returns PNG weather map for given area and variable","tags":["Weather maps"]}},"/nearest_place":{"get":{"description":"## Search for nearest place by coordinates\n\nYou can use this endpoint to find the nearest place from given coordinates.\n\n*Note: If you specify coordinates of a secluded place (e.g. middle of the ocean), the nearest point can be very far from the coordinates.*","operationId":"nearest_place_nearest_place_get","parameters":[{"description":"Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4","in":"query","name":"lat","required":true,"schema":{"description":"Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4","title":"Lat","type":"string"}},{"description":"Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4","in":"query","name":"lon","required":true,"schema":{"description":"Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4","title":"Lon","type":"string"}},{"description":"The language of text summaries and place names (variable names are never translated). Available languages are:\n\n * ``en``: English\n * ``es``: Spanish\n * ``fr``: French\n * ``de``: German\n * ``pl``: Polish\n * ``pt``: Portuguese\n * ``cs``: Czech\n","in":"query","name":"language","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Language"}],"default":"en","description":"The language of text summaries and place names (variable names are never translated). Available languages are:\n\n * ``en``: English\n * ``es``: Spanish\n * ``fr``: French\n * ``de``: German\n * ``pl``: Polish\n * ``pt``: Portuguese\n * ``cs``: Czech\n"}},{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","in":"query","name":"key","required":false,"schema":{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","title":"Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindPlacesModel"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Error in passed parameter."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per day limit exceeded."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"API key not not specified or invalid."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per minute limit exceeded."}},"security":[{"APIKeyHeader":[]}],"summary":"Returns the nearest named location for a given GPS coordinates.","tags":["Location endpoints"]}},"/point":{"get":{"description":"## Current weather and forecast for single location\n\n### Location specification\nThe location of the weather data is the only parameter that is required and must be specified. There are two ways to do this:\n1. Specify the GPS coordinates of the location using the parameters `lat` and `lon`.\n2. **OR** specify the name of the place using the parameter `place_id`. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).\n\n*Note: For mountains, it is usually better to specify the `place_id` rather than the `lat` and `lon`. When you use `place_id`, you are guaranteed to receive forecasts for the precise elevation of the peak. When you specify the coordinates, the elevation can be less precise.*\n\n### Sections\nThe endpoint can return multiple sections of data. To obtain the best performance, we advise only requesting the sections you actually need. The available sections are as follows:\n\n* Current weather situation\n* Hourly forecast (for 24/48/96/168 hours, depending on the tier)\n* Daily forecast (for 7/10/30 days, depending on the tier)\n* Minutely precipitation forecast (for 60 minutes in the following hour, only for higher tiers)\n* Weather alerts (only for higher tiers)\n\nBy default, only the current and hourly sections are returned. The division into daily parts (morning, afternoon and evening) is only available for the first 7 days of the forecast. For details regarding available parameters, see the parameter description below.\n\n### Notes\n* **For a detailed description of variables (e.g. icons), please consult ⚠️ <a href=\"https://www.meteosource.com/documentation#description\" target=\"_blank\">description of variables</a> ⚠️ in Documentation or `Schema` of the response (link next to Example value in the Responses section below).**\n* Variables can be instantaneous, averaged, or accumulated over certain time. For example, `precipitation` forecast provides the precipitation accumulated until the next hour (data with timestamp as `12:00:00` is rain accumulated from `12:00:00` to `13:00:00`).\n* Do **not** make any assumptions about the number and ordering of the variables. New variables and sections may be introduced in the future. Always check the data are present before you try to use them.\n* The response contains an `Expires` header, which defines the point at which the API response will not change for the same request. We highly recommend using this to avoid unnecessary requests and **increase the performance of your app**.\n* Meteosource API supports HTTP compression. To enable it, simply add an `Accept-Encoding: gzip` header to your request.\n* When daylight saving time starts, one hourly record will be missing (typically `2:00:00 AM`). When daylight saving time ends, the hourly forecast will contain two records with duplicate times (typically `2:00:00 AM`).\n* The detailed description of weather alerts is only available in English. The alert category is translated into selected language.","operationId":"point_point_get","parameters":[{"description":"Identifier of a place. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).","in":"query","name":"place_id","required":false,"schema":{"description":"Identifier of a place. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).","title":"Place Id","type":"string"}},{"description":"Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4","in":"query","name":"lat","required":false,"schema":{"description":"Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4","title":"Lat","type":"string"}},{"description":"Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4","in":"query","name":"lon","required":false,"schema":{"description":"Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4","title":"Lon","type":"string"}},{"description":"Sections to be included in the response. You can specify more section by separating the values with a comma. The available values are:\n\n* ``current``: Current weather situation\n* ``daily``: Forecasts for each whole day, without the daily parts\n* ``daily-parts``: Forecasts for each whole day, morning, afternoon and evening\n * Important: forecast for the morning, afternoon and evening is available only for the first\n 7 days in the forecast\n* ``hourly``: Forecasts with hourly resolution\n* ``minutely``: Precipitation forecast with 1 minute resolution\n* ``alerts``: The weather alerts\n* ``all``: All sections\n","in":"query","name":"sections","required":false,"schema":{"default":"current,hourly","description":"Sections to be included in the response. You can specify more section by separating the values with a comma. The available values are:\n\n* ``current``: Current weather situation\n* ``daily``: Forecasts for each whole day, without the daily parts\n* ``daily-parts``: Forecasts for each whole day, morning, afternoon and evening\n * Important: forecast for the morning, afternoon and evening is available only for the first\n 7 days in the forecast\n* ``hourly``: Forecasts with hourly resolution\n* ``minutely``: Precipitation forecast with 1 minute resolution\n* ``alerts``: The weather alerts\n* ``all``: All sections\n","title":"Sections","type":"string"}},{"description":"Timezone to be used for the date fields. If not specified, local timezone of the forecast location will be used.\nThe format is according to the tzinfo database, so values like `Europe/Prague` or `UTC` can be used.\nAlternatively you may use the value ``auto`` in which case the local timezone of the location is used.\nThe full list of valid timezone strings can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\n","in":"query","name":"timezone","required":false,"schema":{"description":"Timezone to be used for the date fields. If not specified, local timezone of the forecast location will be used.\nThe format is according to the tzinfo database, so values like `Europe/Prague` or `UTC` can be used.\nAlternatively you may use the value ``auto`` in which case the local timezone of the location is used.\nThe full list of valid timezone strings can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\n","title":"Timezone","type":"string"}},{"description":"The language of text summaries and place names (variable names are never translated). Available languages are:\n\n * ``en``: English\n * ``es``: Spanish\n * ``fr``: French\n * ``de``: German\n * ``pl``: Polish\n * ``pt``: Portuguese\n * ``cs``: Czech\n","in":"query","name":"language","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Language"}],"default":"en","description":"The language of text summaries and place names (variable names are never translated). Available languages are:\n\n * ``en``: English\n * ``es``: Spanish\n * ``fr``: French\n * ``de``: German\n * ``pl``: Polish\n * ``pt``: Portuguese\n * ``cs``: Czech\n"}},{"description":"Unit system to be used. The available values are:\n\n* `auto`: Select the system automatically, based on the forecast location.\n* `metric`: Metric (SI) units (`°C`, `mm/h`, `m/s`, `cm`, `km`, `hPa`).\n* `us`: Imperial units (`°F`, `in/h`, `mph`, `in`, `mi`, `Hg`).\n* `uk`: Same as ``metric``, except that visibility is in `miles` and wind speeds are in `mph`.\n* `ca`: Same as ``metric``, except that wind speeds are in `km/h` and pressure is in `kPa`.\n","in":"query","name":"units","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Units"}],"default":"auto","description":"Unit system to be used. The available values are:\n\n* `auto`: Select the system automatically, based on the forecast location.\n* `metric`: Metric (SI) units (`°C`, `mm/h`, `m/s`, `cm`, `km`, `hPa`).\n* `us`: Imperial units (`°F`, `in/h`, `mph`, `in`, `mi`, `Hg`).\n* `uk`: Same as ``metric``, except that visibility is in `miles` and wind speeds are in `mph`.\n* `ca`: Same as ``metric``, except that wind speeds are in `km/h` and pressure is in `kPa`.\n"}},{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","in":"query","name":"key","required":false,"schema":{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","title":"Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Point_PointData"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Error in passed parameter."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per day limit exceeded."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"API key not not specified or invalid."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per minute limit exceeded."}},"security":[{"APIKeyHeader":[]}],"summary":"Returns weather data for a single point (geographic name or GPS)","tags":["Point weather"]}},"/time_machine":{"get":{"description":"## Actual weather data for a single location and day in the past\n\nThe output contains actual weather data for each day up to 20 years in the past, and long-term statistics of selected weather variables aggregated over 40 years.\n\n### Location specification\nThe location of the weather data must be specified. There are two ways to do this:\n1. Specify the GPS coordinates of the location using the parameters `lat` and `lon`.\n2. **OR** specify the name of the place using the parameter `place_id`. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).\n\n*Note: For mountains, it is usually better to specify the `place_id` rather than the `lat` and `lon`. When you use `place_id`, you are guaranteed to receive data for the precise elevation of the peak. When you specify the coordinates, the elevation can be less precise.*","operationId":"time_machine_time_machine_get","parameters":[{"description":"Identifier of a place. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).","in":"query","name":"place_id","required":false,"schema":{"description":"Identifier of a place. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).","title":"Place Id","type":"string"}},{"description":"Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4","in":"query","name":"lat","required":false,"schema":{"description":"Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4","title":"Lat","type":"string"}},{"description":"Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4","in":"query","name":"lon","required":false,"schema":{"description":"Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4","title":"Lon","type":"string"}},{"description":"The day of the data in the past. Specify in `YYYY-MM-DD` format, e.g. `2021-08-24`.\n","in":"query","name":"date","required":true,"schema":{"description":"The day of the data in the past. Specify in `YYYY-MM-DD` format, e.g. `2021-08-24`.\n","format":"date","title":"Date","type":"string"}},{"description":"Timezone to be used for the date fields. If not specified, local timezone of the location will be used.\nThe format is according to the tzinfo database, so values like `Europe/Prague` or `UTC` can be used.\nAlternatively you may use the value ``auto`` in which case the local timezone of the location is used.\nThe full list of valid timezone strings can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\n","in":"query","name":"timezone","required":false,"schema":{"description":"Timezone to be used for the date fields. If not specified, local timezone of the location will be used.\nThe format is according to the tzinfo database, so values like `Europe/Prague` or `UTC` can be used.\nAlternatively you may use the value ``auto`` in which case the local timezone of the location is used.\nThe full list of valid timezone strings can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\n","title":"Timezone","type":"string"}},{"description":"Unit system to be used. The available values are:\n\n* `auto`: Select the system automatically, based on the forecast location.\n* `metric`: Metric (SI) units (`°C`, `mm/h`, `m/s`, `cm`, `km`, `hPa`).\n* `us`: Imperial units (`°F`, `in/h`, `mph`, `in`, `mi`, `Hg`).\n* `uk`: Same as ``metric``, except that visibility is in `miles` and wind speeds are in `mph`.\n* `ca`: Same as ``metric``, except that wind speeds are in `km/h` and pressure is in `kPa`.\n","in":"query","name":"units","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Units"}],"default":"auto","description":"Unit system to be used. The available values are:\n\n* `auto`: Select the system automatically, based on the forecast location.\n* `metric`: Metric (SI) units (`°C`, `mm/h`, `m/s`, `cm`, `km`, `hPa`).\n* `us`: Imperial units (`°F`, `in/h`, `mph`, `in`, `mi`, `Hg`).\n* `uk`: Same as ``metric``, except that visibility is in `miles` and wind speeds are in `mph`.\n* `ca`: Same as ``metric``, except that wind speeds are in `km/h` and pressure is in `kPa`.\n"}},{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","in":"query","name":"key","required":false,"schema":{"description":"Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header.","title":"Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeMachine_TimeMachine"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Error in passed parameter."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per day limit exceeded."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"API key not not specified or invalid."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralRequestError"}}},"description":"Maximum requests per minute limit exceeded."}},"security":[{"APIKeyHeader":[]}],"summary":"Returns weather data for a single location and given day in the past","tags":["Time machine - historical weather"]}}},"components":{"schemas":{"AirQuality_PointData":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AirQuality_PointHourlyData"},"title":"Data","type":"array"},"elevation":{"description":"Elevation above sea level in metres (for units 'metric', 'uk', 'ca') or feet (for units 'us')","title":"Elevation","type":"integer"},"lat":{"description":"Latitude of the point, always in the format <float><N/S>, for example ``23.5S``","title":"Lat","type":"string"},"lon":{"description":"Longitude of the point, always in the format <float><E/W>, for example ``23.5W``","title":"Lon","type":"string"},"timezone":{"description":"Name of the timezone in format like 'Europe/London'. Available only when the place is specified through place ID.","title":"Timezone","type":"string"}},"required":["lat","lon","elevation","data"],"title":"AirQuality_PointData","type":"object"},"AirQuality_PointHourlyData":{"properties":{"aerosol_550":{"description":"Total aerosol optical depth at 550 nm.\nUnit: dimensionless","title":"Aerosol 550","type":"number"},"air_quality":{"description":"Air quality index. The following values can appear:\n\n* 1 - Very good\n* 2 - Good\n* 3 - Medium\n* 4 - Poor\n* 5 - Very poor\n* 6 - Extremely poor\n\nUnit: index","title":"Air Quality","type":"number"},"co_surface":{"description":"Carbon monoxide at surface level.\nUnit: µg/m3","title":"Co Surface","type":"number"},"date":{"description":"Datetime in YYYY-MM-DDTHH:MM:SS format.","example":"2025-06-15T13:47:55.811Z","format":"date-time","title":"Date","type":"string"},"dust_550nm":{"description":"Dust aerosol optical depth at 550 nm.\nUnit: dimensionless","title":"Dust 550Nm","type":"number"},"dust_mixing_ratio_05":{"description":"Dust aerosol (0.55 - 0.9 µm) mixing ratio.\nUnit: kg/kg","title":"Dust Mixing Ratio 05","type":"number"},"no2_surface":{"description":"Nitrogen dioxide at surface level.\nUnit: µg/m3","title":"No2 Surface","type":"number"},"no_surface":{"description":"Nitrogen monoxide at surface level.\nUnit: µg/m3","title":"No Surface","type":"number"},"ozone_surface":{"description":"Ozone.\nUnit: µg/m3","title":"Ozone Surface","type":"number"},"ozone_total":{"description":"Total column ozone.\nUnit: Dobson","title":"Ozone Total","type":"number"},"pm10":{"description":"Particulate matter d < 10 µm (PM10).\nUnit: µg/m3","title":"Pm10","type":"number"},"pm25":{"description":"Particulate matter d < 2.5 µm (PM2.5).\nUnit: µg/m3","title":"Pm25","type":"number"},"so2_surface":{"description":"Sulphur dioxide at surface level.\nUnit: µg/m3","title":"So2 Surface","type":"number"}},"title":"AirQuality_PointHourlyData","type":"object"},"FindPlacesModel":{"properties":{"adm_area1":{"default":"England","description":"first-level administrative area (a US state, for example)","title":"Adm Area1","type":"string"},"adm_area2":{"default":"Greater London","description":"second-level administrative area (a US county, for example)","title":"Adm Area2","type":"string"},"country":{"default":"United Kingdom","description":"name of the country","title":"Country","type":"string"},"lat":{"default":"23.2N","description":"Latitude of the point, always in the format \\<float><N/S>, for example ``23.5S``","title":"Lat","type":"string"},"lon":{"default":"15.3E","description":"Longitude of the point, always in format \\<float><E/W>, for example ``23.5W``","title":"Lon","type":"string"},"name":{"default":"London","description":"name of the place","title":"Name","type":"string"},"place_id":{"default":"london","description":"unique identifier of the place, which can be used in /point and /map endpoints","title":"Place Id","type":"string"},"timezone":{"default":"Europe/London","description":"Timezone of the point in tzinfo format.","title":"Timezone","type":"string"},"type":{"default":"settlement","description":"The character of the place. May be one of the following values:\n\n* administrative areas (states, counties, districts...): ``administrative_area``\n* country: ``country``\n* a different political entity from a country (for example, a dependent teritory): ``political_entity``\n* villages, towns and cities: ``settlement``\n* air industry locations: ``airbase``, ``airfield``, ``heliport``, ``airport``, ``airport_terminal``\n* places related to water: ``bay``, ``channel``, ``fjord``, ``lake``, ``pond``, ``falls``, ``gulf``,\n ``harbor``, ``reservoir``, ``sea``, ``dam``, ``cape``, ``island``, ``peninsula``\n* places related to mountain areas: ``hill``, ``mountain``, ``peak``, ``valley``, ``volcano``, ``canyon``\n* other places related to nature: ``park``, ``reserve``, ``resort``, ``desert``\n* places based on postcodes: ``postcode``\n ","title":"Type","type":"string"}},"title":"FindPlacesModel","type":"object"},"GeneralRequestError":{"properties":{"detail":{"title":"Detail","type":"string"}},"required":["detail"],"title":"GeneralRequestError","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"Language":{"description":"An enumeration.","enum":["cs","en","de","es","fr","pl","pt"],"title":"Language","type":"string"},"Point_PointAlerts":{"properties":{"data":{"title":"Data","type":"string"}},"title":"Point_PointAlerts","type":"object"},"Point_PointCurrentData":{"properties":{"cloud_cover":{"description":"Percentage of sky covered by clouds.\nUnit: \\%","title":"Cloud Cover","type":"number"},"dew_point":{"description":"Current dew point temperature.\nUnits: metric = °C, us = °F, uk = °C, ca = °C","title":"Dew Point","type":"number"},"feels_like":{"description":"Feels like temperature.\nUnits: metric = °C, us = °F, uk = °C, ca = °C","title":"Feels Like","type":"number"},"humidity":{"description":"Relative humidity.\nUnit: \\%","title":"Humidity","type":"integer"},"icon":{"description":"String identifier of current weather icon, e.g. `light_rain`.","title":"Icon","type":"string"},"icon_num":{"description":"Numeric identifier of current weather icon. The following values can appear:\n\n* 1 - Not available\n* 2 - Sunny\n* 3 - Mostly sunny\n* 4 - Partly sunny\n* 5 - Mostly cloudy\n* 6 - Cloudy\n* 7 - Overcast\n* 8 - Overcast with low clouds\n* 9 - Fog\n* 10 - Light rain\n* 11 - Rain\n* 12 - Possible rain\n* 13 - Rain shower\n* 14 - Thunderstorm\n* 15 - Local thunderstorms\n* 16 - Light snow\n* 17 - Snow\n* 18 - Possible snow\n* 19 - Snow shower\n* 20 - Rain and snow\n* 21 - Possible rain and snow\n* 22 - Rain and snow\n* 23 - Freezing rain\n* 24 - Possible freezing rain\n* 25 - Hail\n* 26 - Clear (night)\n* 27 - Mostly clear (night)\n* 28 - Partly clear (night)\n* 29 - Mostly cloudy (night)\n* 30 - Cloudy (night)\n* 31 - Overcast with low clouds (night)\n* 32 - Rain shower (night)\n* 33 - Local thunderstorms (night)\n* 34 - Snow shower (night)\n* 35 - Rain and snow (night)\n* 36 - Possible freezing rain (night)\n\nUnit: weather_ico0_36","title":"Icon Num","type":"integer"},"irradiance":{"description":"Global downward short-wave radiation flux.\nUnit: W/m2","title":"Irradiance","type":"number"},"ozone":{"description":"Total column of ozone.\nUnit: Dobson","title":"Ozone","type":"number"},"precipitation":{"$ref":"#/components/schemas/Point_PointCurrentPrecipitationData"},"pressure":{"description":"Atmospheric pressure at mean sea level.\nUnits: metric = hPa, us = Hg, uk = hPa, ca = kPa","title":"Pressure","type":"number"},"summary":{"description":"Short text summary of current weather, e.g. `Light rain`.","title":"Summary","type":"string"},"temperature":{"description":"Current temperature 2 metres above ground.\nUnits: metric = °C, us = °F, uk = °C, ca = °C","title":"Temperature","type":"number"},"uv_index":{"description":"UV index, values from zero (low risk of harm) to 11+ (extreme risk of harm).\nUnit: uv_index","title":"Uv Index","type":"number"},"visibility":{"description":"Visibility.\nUnits: metric = km, us = mi, uk = mi, ca = km","title":"Visibility","type":"number"},"wind":{"$ref":"#/components/schemas/Point_PointCurrentWindData"},"wind_chill":{"description":"Windchill temperature.\nUnits: metric = °C, us = °F, uk = °C, ca = °C","title":"Wind Chill","type":"number"}},"required":["wind","precipitation"],"title":"Point_PointCurrentData","type":"object"},"Point_PointCurrentPrecipitationData":{"properties":{"total":{"description":"Current amount of precipitation.\nUnits: metric = mm/h, us = inches per hour, uk = mm/h, ca = mm/h","title":"Total","type":"number"},"type":{"description":"Precipitation type, may be one of:\n\n* `none`, it there is no precipitation\n* `rain`\n* `snow`\n* `rain_snow`\n* `ice pellets`\n* `frozen rain`\n\nUnit: prec_str","format":"binary","title":"Type","type":"string"}},"title":"Point_PointCurrentPrecipitationData","type":"object"},"Point_PointCurrentWindData":{"properties":{"angle":{"description":"Wind direction angle in degrees, 180° means wind from the south.\nUnit: degrees","title":"Angle","type":"number"},"dir":{"description":"Wind direction in `N`, `NNE`, `NE`, ..., `NNW` format.\nUnit: 16dir","format":"binary","title":"Dir","type":"string"},"gusts":{"description":"Wind gust speed.\nUnits: metric = m/s, us = mph, uk = mph, ca = km/h","title":"Gusts","type":"number"},"speed":{"description":"Wind speed 10 metres above the ground.\nUnits: metric = m/s, us = mph, uk = mph, ca = km/h","title":"Speed","type":"number"}},"title":"Point_PointCurrentWindData","type":"object"},"Point_PointDaily":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Point_PointDailyData"},"title":"Data","type":"array"}},"required":["data"],"title":"Point_PointDaily","type":"object"},"Point_PointDailyAfternoonCloudCoverData":{"properties":{"high":{"description":"Percentage of sky covered by high clouds. (afternoon avg)\nUnit: \\%","title":"High","type":"number"},"low":{"description":"Percentage of sky covered by low clouds. (afternoon avg)\nUnit: \\%","title":"Low","type":"number"},"middle":{"description":"Percentage of sky covered by middle clouds. (afternoon avg)\nUnit: \\%","title":"Middle","type":"number"},"total":{"description":"Percentage of sky covered by clouds. (afternoon avg)\nUnit: \\%","title":"Total","type":"number"}},"title":"Point_PointDailyAfternoonCloudCoverData","type":"object"},"Point_PointDailyAfternoonData":{"properties":{"cloud_cover":{"$ref":"#/components/schemas/Point_PointDailyAfternoonCloudCoverData"},"dew_point":{"description":"Units: metric = °C, us = °F, uk = °C, ca = °C","title":"Dew Point","type":"number"},"feels_like":{"description":"Units: metric = °C, us = °F, uk = °C, ca = °C","title":"Feels Like","type":"number"},"humidity":{"description":"Relative humidity. (afternoon avg)\nUnit: \\%","title":"Humidity","type":"integer"},"icon":{"description":"Afternoon umeric identifier of the weather icon. The following values can appear:\n\n* 1 - Not available\n* 2 - Sunny\n* 3 - Mostly sunny\n* 4 - Partly sunny\n* 5 - Mostly cloudy\n* 6 - Cloudy\n* 7 - Overcast\n* 8 - Overcast with low clouds\n* 9 - Fog\n* 10 - Light rain\n* 11 - Rain\n* 12 - Possible rain\n* 13 - Rain shower\n* 14 - Thunderstorm\n* 15 - Local thunderstorms\n* 16 - Light snow\n* 17 - Snow\n* 18 - Possible snow\n* 19 - Snow shower\n* 20 - Rain and snow\n* 21 - Possible rain and snow\n* 22 - Rain and snow\n* 23 - Freezing rain\n* 24 - Possible freezing rain\n* 25 - Hail\n* 26 - Clear (night)\n* 27 - Mostly clear (night)\n* 28 - Partly clear (night)\n* 29 - Mostly cloudy (night)\n* 30 - Cloudy (night)\n* 31 - Overcast with low clouds (night)\n* 32 - Rain shower (night)\n* 33 - Local thunderstorms (night)\n* 34 - Snow shower (night)\n* 35 - Rain and snow (night)\n* 36 - Possible freezing rain (night)\n\nUnit: icon","title":"Icon","type":"integer"},"ozone":{"description":"Total column of ozone. (afternoon avg)\nUnit: Dobson","title":"Ozone","type":"number"},"precipitation":{"$ref":"#/components/schemas/Point_PointDailyAfternoonPrecipitationData"},"pressure":{"description":"Atmospheric pressure at mean sea level. (afternoon avg)\nUnits: metric = hPa, us = Hg, uk = hPa, ca = kPa","title":"Pressure","type":"number"},"probability":{"$ref":"#/components/schemas/Point_PointDailyAfternoonProbData"},"snow_depth":{"description":"Snow depth. (afternoon avg)\nUnits: metric = cm, us = inch, uk = cm, ca = cm","title":"Snow Depth","type":"number"},"soil_temperature":{"description":"Units: metric = °C, us = °F, uk = °C, ca = °C","title":"Soil Temperature","type":"number"},"surface_temperature":{"description":"Units: metric = °C, us = °F, uk = °C, ca = °C","title":"Surface Temperature","type":"number"},"temperature":{"description":"Temperature 2 metres above ground. (afternoon avg)\nUnits: metric = °C, us = °F, uk = °C, ca = °C","title":"Temperature","type":"number"},"visibility":{"description":"Visibility. (afternoon avg)\nUnits: metric = km, us = mi, uk = mi, ca = km","title":"Visibility","type":"number"},"weather":{"description":"Afternoon day string identifier of the weather icon, e.g. `light_rain`.","title":"Weather","type":"string"},"wind":