{"openapi":"3.1.0","info":{"title":"meteoblue - Image API","description":"\n# Overview\n\nThe Image API provides access to ready-to-use meteoblue weather visualisations. It is designed for applications that need to retrieve location-specific weather charts without building custom visualisations from raw weather data.\n\nUnlike data APIs that return structured numerical values, the Image API returns generated weather graphics. This makes it suitable when the required output is a standardised meteoblue chart that can be embedded or displayed directly.\n\n## Credits and Call Limits\n\n### API Keys and access\n\nAccess to the Images API is controlled via an API key. API keys are associated with a user account and are used to authenticate API requests.\n\nA user account may own multiple API keys, for example to separate usage across applications or environments. All API usage performed with an API key is attributed to the owning account.\n\nThe API key itself has to be provided as a URL query parameter (`apikey=YOUR_API_KEY`).\n\nAPI keys should be stored securely and must not be exposed publicly.\n\n### Usage accounting and limits\n\nAPI usage is accounted for based on credits, not on fixed call limits per image.\n\nEach API request consumes credits based on the requested image.\n\n<details><summary><b>List of per image accounted credits</b></summary>\n\n| Image | Credits |\n| - | - |\n| Normal Images | 16000 |\n| Special Images (meteogram_solar_season,crop_climate_risk,crop_weather_risk_monitoring) | 128000 |\n\n</details>\n\n","contact":{"name":"meteoblue","email":"support@meteoblue.com"},"version":"2.0","x-logo":{"url":"/images/static/meteoblue_logo_v2.0.svg"}},"paths":{"/meteogram":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"5-Day Meteogram","description":"The 5-Day Meteogram visualises forecast weather conditions for the selected coordinates, including temperature, precipitation, and wind.\n\n![Example output](/images/static/doc_examples/meteogram.png)","operationId":"5_Day_Meteogram_meteogram_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":5},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_one":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"All-In-One Meteogram","description":"The All-In-One Meteogram combines various weather elements, including temperature, precipitation, wind, and cloud cover, into a single comprehensive forecast.\n\n![Example output](/images/static/doc_examples/meteogram_one.png)","operationId":"All_In_One_Meteogram_meteogram_one_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":7},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_extended":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"7-Day Meteogram","description":"The 7-Day Meteogram provides a seven-day forecast of weather conditions, offering a broader view compared to the 5-day version.\n\n![Example output](/images/static/doc_examples/meteogram_extended.png)","operationId":"7_Day_Meteogram_meteogram_extended_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":7},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_air":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Air Meteogram","description":"The Air Meteogram visualises aviation-related weather forecast information, including CAPE, CIN, and approximate altitude.\n\n![Example output](/images/static/doc_examples/meteogram_air.png)","operationId":"Air_Meteogram_meteogram_air_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":3},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_thermal":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Thermal Forecast Meteogram","description":"The Thermal Forecast Meteogram visualises air temperature changes at different altitudes, supporting the assessment of conditions that may affect aircraft performance and flight planning.\n\n![Example output](/images/static/doc_examples/meteogram_thermal.png)","operationId":"Thermal_Forecast_Meteogram_meteogram_thermal_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":3,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":3},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"wind_symbol","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindSymbol","title":"Representation of the wind","description":"Specifies what symbol (if any) should be used to represent wind. Barbs show direction and speed, arrows show direction only and are somewhat less of a visual clutter, and none shows neither.","default":"arrow"},"description":"Specifies what symbol (if any) should be used to represent wind. Barbs show direction and speed, arrows show direction only and are somewhat less of a visual clutter, and none shows neither."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_snow":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Snow Meteogram","description":"The Snow Meteogram visualises snow-specific information such as snowfall amounts, snow depth, and freezing levels for the selected location.\n\n![Example output](/images/static/doc_examples/meteogram_snow.png)","operationId":"Snow_Meteogram_meteogram_snow_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":7},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_14day":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"14-Day Meteogram","description":"The 14-Day Meteogram extends the forecast view beyond the usual 7-day range, offering a longer-term perspective.\n\n![Example output](/images/static/doc_examples/meteogram_14day.png)","operationId":"14_Day_Meteogram_meteogram_14day_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_multimodel":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Multimodel Meteogram","description":"The Multimodel Meteogram presents forecasts from multiple weather models for comparison, allowing users to analyse potential forecast variations. The number of models shown may vary by location and day. There is no guarantee that a specific model will be present at any time, so the image size may also vary by location and day.\n\n![Example output](/images/static/doc_examples/meteogram_multimodel.png)","operationId":"MultiModel_Meteogram_meteogram_multimodel_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":3},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_multimodelensemble":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Multimodel Ensemble Meteogram","description":"The MultiModel Ensemble Meteogram combines forecasts from multiple models to create a single, statistically representative forecast.\n\n![Example output](/images/static/doc_examples/meteogram_multimodelensemble.png)","operationId":"MultiModel_Ensemble_Meteogram_meteogram_multimodelensemble_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":14,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":7},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_multimodelwind":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Multimodel Wind Meteogram","description":"The MultiModel Wind Meteogram focuses on wind speed and wind direction predictions from multiple models for a more comprehensive view.\n\n![Example output](/images/static/doc_examples/meteogram_multimodelwind.png)","operationId":"MultiModel_Wind_Meteogram_meteogram_multimodelwind_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":1},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","default":"kn"}},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_agro":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Agro Meteogram","description":"The Agro Meteogram visualises weather information relevant for agricultural forecasts, including various options such as spraying, temperature, precipitation, and wind.\n\n![Example output](/images/static/doc_examples/meteogram_agro.png)","operationId":"Agro_Meteogram_meteogram_agro_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":7},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_sowing":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Sowing Windows Meteogram","description":"The Sowing Windows Meteogram visualises weather information relevant for optimal planting times and germination conditions.\n\n![Example output](/images/static/doc_examples/meteogram_sowing.png)","operationId":"Sowing_Windows_Meteogram_meteogram_sowing_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":7},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"crops","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/Crops"}},{"type":"null"}],"title":"Crops","description":"List of crops to display.","default":["maize","wheat","barley","rapseed","potato","sugarbeets"]},"description":"List of crops to display."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_spraying":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Spraying Window Meteogram","description":"The Meteogram Spraying Window visualises weather conditions that affect the effectiveness and safety of applying pesticides and fertilizers. Spraying conditions are calculated from wind, precipitation, temperature, and humidity forecasts, and the recommendation should be verified shortly before application using current actual weather conditions.\n\n![Example output](/images/static/doc_examples/meteogram_spraying.png)","operationId":"Spraying_Window_Meteogram_meteogram_spraying_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":7},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_soiltraffic":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Soil Trafficability Meteogram","description":"The Soil Trafficability Meteogram assesses the ground's suitability for machinery movement based on weather conditions and water content in the topsoil from 0 to 10 cm.\n\n![Example output](/images/static/doc_examples/meteogram_soiltraffic.png)","operationId":"Soil_Trafficability_Meteogram_meteogram_soiltraffic_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":6,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":5},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_stueve":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Atmospheric Stueve Diagram","description":"The Stueve Upper-Air Diagram visualises upper-air forecasts, including wind speed, wind direction, and temperature, for aviation weather analysis.\n\n![Example output](/images/static/doc_examples/meteogram_stueve.png)","operationId":"Atmospheric_Stueve_Diagram_meteogram_stueve_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"min_pressure","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StueveMinPressure","default":250}},{"$ref":"#/components/parameters/date"},{"$ref":"#/components/parameters/hour"},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_sounding":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Atmospheric Sounding Diagram","description":"The Atmospheric Sounding Diagram visualises vertical profiles of atmospheric variables, including temperature and dew point temperature, for flight planning and safety.\n\n![Example output](/images/static/doc_examples/meteogram_sounding.png)","operationId":"Atmospheric_Sounding_Diagram_meteogram_sounding_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"This diagram is only available in English","default":"en","title":"Lang"},"description":"This diagram is only available in English"},{"$ref":"#/components/parameters/date"},{"$ref":"#/components/parameters/hour"},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_sea":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Sea Meteogram","description":"The Sea Meteogram visualises marine weather forecast information for the selected location, including wave heights, sea state, wind, and sea-level pressure. Only available for coastal and offshore locations.\n\n![Example output](/images/static/doc_examples/meteogram_sea.png)","operationId":"Sea_Meteogram_meteogram_sea_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":7,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":1},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","default":"kn"}},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_sea_7day":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Sea 7-Day Meteogram","description":"The Sea 7-Day Meteogram provides a seven-day marine weather forecast for the selected location. Only available for locations at least 20 km from the coast.\n\n![Example output](/images/static/doc_examples/meteogram_sea_7day.png)","operationId":"Sea_7_Day_Meteogram_meteogram_sea_7day_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","default":"kn"}},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_surf":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Surf Meteogram","description":"The Surf Meteogram provides surf-related marine weather forecast information for the selected location. Only available for locations at least 20 km from the coast.\n\n![Example output](/images/static/doc_examples/meteogram_surf.png)","operationId":"Surf_Meteogram_meteogram_surf_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":1},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","default":"kn"}},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_history":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Weather History Meteogram","description":"The Weather History Meteogram visualises simulated temperature, relative humidity, precipitation, cloud cover, wind speed, and wind direction for a selected period and location.\n\n![Example output](/images/static/doc_examples/meteogram_history.png)","operationId":"Weather_History_Meteogram_meteogram_history_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"date_start","in":"query","required":false,"schema":{"type":"string","title":"Start date","description":"Starting date of desired temporal interval, in ISO format YYYY-MM-DD","examples":["2019-03-31"],"default":"2026-08-28"},"description":"Starting date of desired temporal interval, in ISO format YYYY-MM-DD"},{"name":"date_end","in":"query","required":false,"schema":{"type":"string","title":"End date","description":"End date of desired temporal interval, in ISO format YYYY-MM-DD","examples":["2019-03-31"],"default":"2026-09-27"},"description":"End date of desired temporal interval, in ISO format YYYY-MM-DD"},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_solar_forecast":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Solar Forecast Meteogram","description":"The Solar Forecast Meteogram predicts PV power, supporting solar energy applications and planning.\n\n![Example output](/images/static/doc_examples/meteogram_solar_forecast.png)","operationId":"Solar_Forecast_Meteogram_meteogram_solar_forecast_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"forecast_days","in":"query","required":false,"schema":{"type":"integer","maximum":8,"minimum":0,"title":"Forecast days","description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":5},"description":"To limit the number of days in the returned visual, set this parameter to the number of days which your application requires. If this parameter is not set, the API returns as many forecast days as it can. When the selected number of forecast days is greater than the number of available days, only the maximum number of days is returned.\n\nThe resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":4,"minimum":0,"title":"History days","description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day.","default":0},"description":"Specifies how many past days the returned visual should contain. By default, no historical data are returned.\n\nData from the past is processed slightly differently than the data for the future, depending on how many days have passed:\n\n- For processing, satellite data and model data are used regardless of the days in the past\n- Measurement data is only considered up to 3 days into the past\n- Radar data is only considered up to 1 day into the past\n- The resulting time range of `history_days` and `forecast_days` must contain at least one day."},{"$ref":"#/components/parameters/kwp"},{"$ref":"#/components/parameters/facing"},{"$ref":"#/components/parameters/slope"},{"$ref":"#/components/parameters/power_efficiency"},{"$ref":"#/components/parameters/tracker"},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_solar_season":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Solar Season Meteogram","description":"The Solar Season Meteogram visualises seasonal photovoltaic power information for a selected location and system configuration.\n\n![Example output](/images/static/doc_examples/meteogram_solar_season.png)","operationId":"Solar_Season_Meteogram_meteogram_solar_season_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"$ref":"#/components/parameters/kwp"},{"$ref":"#/components/parameters/facing"},{"$ref":"#/components/parameters/slope"},{"$ref":"#/components/parameters/power_efficiency"},{"$ref":"#/components/parameters/tracker"},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_verify":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Verify Meteogram","description":"The Verify Meteogram compares recent model forecasts against weather station observations for temperature, wind speed, and relative humidity, and displays error statistics.\n\n![Example output](/images/static/doc_examples/meteogram_verify.png)","operationId":"Verify_Meteogram_meteogram_verify_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"history_days","in":"query","required":false,"schema":{"type":"integer","maximum":10,"minimum":1,"title":"History days","description":"Number of past days to include.","default":3},"description":"Number of past days to include."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/risk_assessment":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Weather Risk Assessment Diagram","description":"The Weather Risk Assessment Diagram visualises the risk of selected weather events for a defined period and location. \n\n<iframe src=\"/images/static/doc_examples/risk_assessment.html\" width=\"100%\" height=\"1350\" style=\"border:none;\"></iframe>","operationId":"Weather_Risk_Assessment_Diagram_risk_assessment_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"default":1,"title":"Png Scale"}},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"event","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Event","title":"Event type","description":"Type of weather event to analyse.","default":"cold_event"},"description":"Type of weather event to analyse."},{"name":"threshold","in":"query","required":false,"schema":{"type":"number","title":"Threshold","description":"Threshold value in the variable's units above (or below) which the event is counted.","default":0},"description":"Threshold value in the variable's units above (or below) which the event is counted."},{"name":"duration","in":"query","required":false,"schema":{"type":"integer","title":"Duration","description":"For cold, warm, wind speed, and wind gust events: minimum number of hours per day the threshold must be exceeded to count the day as an event. Not used for precipitation, soil water, and cloud cover events.","default":1},"description":"For cold, warm, wind speed, and wind gust events: minimum number of hours per day the threshold must be exceeded to count the day as an event. Not used for precipitation, soil water, and cloud cover events."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputInteractive","title":"Output format","default":"highcharts"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_climate_comparison":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Climate Comparison Meteogram","description":"The Historical Climate Comparison Diagram compares weather variables of the current season to the 30-year mean climate.\n\n![Example output](/images/static/doc_examples/meteogram_climate_comparison.png)","operationId":"Climate_Comparison_Meteogram_meteogram_climate_comparison_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","maximum":2026,"minimum":1979,"title":"Start year","description":"First year of the climatological period.","default":1995},"description":"First year of the climatological period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","maximum":2026,"minimum":1979,"title":"End year","description":"Last year of the climatological period.","default":2025},"description":"Last year of the climatological period."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/meteogram_climate_observed":{"get":{"tags":["Meteograms & Core Diagrams"],"summary":"Observed Climate Meteogram","description":"The Observed Climate Diagram visualises the annual course of temperature, precipitation amount, rainy days, and wind measurements from the closest weather station. The displayed weather variables depend on the availability of complete and consistent measurement data and are aggregated on a weekly or monthly basis.\n\n![Example output](/images/static/doc_examples/meteogram_climate_observed.png)","operationId":"Observed_Climate_Meteogram_meteogram_climate_observed_get","parameters":[{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","maximum":2026,"minimum":1979,"title":"Start year","description":"First year of the climatological period.","default":1995},"description":"First year of the climatological period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","maximum":2026,"minimum":1979,"title":"End year","description":"Last year of the climatological period.","default":2025},"description":"Last year of the climatological period."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FormatOutputImage","title":"Output format","default":"png"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/climate_model/temp_precip":{"get":{"tags":["Climate Modelled Diagrams"],"summary":"Temperature And Precipitation","description":"The Climate Modelled - Temperature and Precipitation Diagram visualises modelled climate information for temperature and precipitation at a selected location.\n\n<iframe src=\"/images/static/doc_examples/climate_model_temp_precip.html\" width=\"100%\" height=\"500\" style=\"border:none;\"></iframe>","operationId":"Temperature_and_Precipitation_climate_model_temp_precip_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"default":1,"title":"Png Scale"}},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","title":"Start year","description":"First year of the climatological period.","default":1980},"description":"First year of the climatological period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","title":"End year","description":"Last year of the climatological period.","default":2020},"description":"Last year of the climatological period."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/climate_model/cloud_coverage":{"get":{"tags":["Climate Modelled Diagrams"],"summary":"Cloud Coverage","description":"The Climate Modelled - Cloud Coverage Diagram visualises historical and projected average cloud cover at a selected location.\n\n<iframe src=\"/images/static/doc_examples/climate_model_cloud_coverage.html\" width=\"100%\" height=\"500\" style=\"border:none;\"></iframe>","operationId":"Cloud_Coverage_climate_model_cloud_coverage_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"default":1,"title":"Png Scale"}},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","title":"Start year","description":"First year of the climatological period.","default":1980},"description":"First year of the climatological period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","title":"End year","description":"Last year of the climatological period.","default":2020},"description":"Last year of the climatological period."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/climate_model/max_temperatures":{"get":{"tags":["Climate Modelled Diagrams"],"summary":"Maximum Temperatures","description":"The Climate Modelled - Maximum Temperatures Diagram visualises modelled maximum temperature information at a selected location.\n\n<iframe src=\"/images/static/doc_examples/climate_model_max_temperatures.html\" width=\"100%\" height=\"500\" style=\"border:none;\"></iframe>","operationId":"Maximum_Temperatures_climate_model_max_temperatures_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"default":1,"title":"Png Scale"}},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","title":"Start year","description":"First year of the climatological period.","default":1980},"description":"First year of the climatological period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","title":"End year","description":"Last year of the climatological period.","default":2020},"description":"Last year of the climatological period."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/climate_model/total_precipitation":{"get":{"tags":["Climate Modelled Diagrams"],"summary":"Total Precipitation","description":"The Climate Modelled - Total Precipitation Diagram visualises historical and projected total precipitation at a selected location.\n\n<iframe src=\"/images/static/doc_examples/climate_model_total_precipitation.html\" width=\"100%\" height=\"500\" style=\"border:none;\"></iframe>","operationId":"Total_Precipitation_climate_model_total_precipitation_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"default":1,"title":"Png Scale"}},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","title":"Start year","description":"First year of the climatological period.","default":1980},"description":"First year of the climatological period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","title":"End year","description":"Last year of the climatological period.","default":2020},"description":"Last year of the climatological period."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/climate_model/wind_speeds":{"get":{"tags":["Climate Modelled Diagrams"],"summary":"Wind Speeds","description":"The Climate Modelled - Wind Speeds Diagram visualises historical and projected wind speed patterns at a selected location.\n\n<iframe src=\"/images/static/doc_examples/climate_model_wind_speeds.html\" width=\"100%\" height=\"500\" style=\"border:none;\"></iframe>","operationId":"Wind_Speeds_climate_model_wind_speeds_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"default":1,"title":"Png Scale"}},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","title":"Start year","description":"First year of the climatological period.","default":1980},"description":"First year of the climatological period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","title":"End year","description":"Last year of the climatological period.","default":2020},"description":"Last year of the climatological period."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/climate_model/wind_rose":{"get":{"tags":["Climate Modelled Diagrams"],"summary":"Wind Rose","description":"The Climate Modelled - Wind Rose Diagram visualises the frequency and direction of winds at a selected location based on climate models.\n\n<iframe src=\"/images/static/doc_examples/climate_model_wind_rose.html\" width=\"100%\" height=\"500\" style=\"border:none;\"></iframe>","operationId":"Wind_Rose_climate_model_wind_rose_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"default":1,"title":"Png Scale"}},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"name":"lang","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Language","title":"Language","description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`).","default":"en"},"description":"Language used for text labels in the generated image. Accepts 2-letter ISO 639-1 codes (e.g. `en`, `de`, `fr`) or 4-letter locale codes (e.g. `en_GB`, `de_DE`, `fr_FR`)."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","title":"Start year","description":"First year of the climatological period.","default":1980},"description":"First year of the climatological period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","title":"End year","description":"Last year of the climatological period.","default":2020},"description":"Last year of the climatological period."},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/monthly_climate":{"get":{"tags":["Climate Change Diagrams"],"summary":"Monthly Climate Change","description":"The Monthly Climate Change Diagram visualises monthly climate change information for a selected location.\n\n<iframe src=\"/images/static/doc_examples/monthly_climate.html\" width=\"100%\" height=\"500\" style=\"border:none;\"></iframe>","operationId":"Monthly_Climate_Change_monthly_climate_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"type":"number","title":"PNG scale","description":"Scale factor applied to the default image resolution. Values above 1 produce larger, higher-resolution images.","default":1},"description":"Scale factor applied to the default image resolution. Values above 1 produce larger, higher-resolution images."},{"$ref":"#/components/parameters/png_width"},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"This diagram is only available in English","default":"en","title":"Lang"},"description":"This diagram is only available in English"},{"name":"variable1","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SelectWeatherVariableClimate","title":"Variable 1","description":"First weather variable to plot.","default":"temperature"},"description":"First weather variable to plot."},{"name":"variable2","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SelectWeatherVariableClimate","title":"Variable 2","description":"Second weather variable to plot.","default":"precipitation"},"description":"Second weather variable to plot."},{"name":"visualization","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Visualization","title":"Visualization type","description":"Determines whether to show a single month or the full-year overview.","default":"single_month"},"description":"Determines whether to show a single month or the full-year overview."},{"name":"month","in":"query","required":false,"schema":{"type":"integer","maximum":12,"minimum":1,"title":"Month","description":"Month of interest (1 = January … 12 = December). Used only when `visualization` is set to single month.","default":5},"description":"Month of interest (1 = January … 12 = December). Used only when `visualization` is set to single month."},{"$ref":"#/components/parameters/year_start"},{"$ref":"#/components/parameters/year_end"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/yearly_climate":{"get":{"tags":["Climate Change Diagrams"],"summary":"Yearly Climate Change","description":"The Yearly Climate Change Diagram visualises yearly climate change information for a selected location.\n\n<iframe src=\"/images/static/doc_examples/yearly_climate.html\" width=\"100%\" height=\"500\" style=\"border:none;\"></iframe>","operationId":"Yearly_Climate_Change_yearly_climate_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"type":"number","title":"PNG scale","description":"Scale factor applied to the default image resolution. Values above 1 produce larger, higher-resolution images.","default":1},"description":"Scale factor applied to the default image resolution. Values above 1 produce larger, higher-resolution images."},{"$ref":"#/components/parameters/png_width"},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__helper__diagram__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"era5"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"This diagram is only available in English","default":"en","title":"Lang"},"description":"This diagram is only available in English"},{"name":"variable","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SelectWeatherVariableClimate","title":"Variable","description":"Weather variable to plot.","default":"temperature"},"description":"Weather variable to plot."},{"$ref":"#/components/parameters/year_start"},{"$ref":"#/components/parameters/year_end"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/crop_climate_risk":{"get":{"tags":["Crop Risk Analysis Diagrams"],"summary":"Crop Climate Risk","description":"The Crop Climate Risk Diagram visualises climate-related risk information for crops at a selected location.\n\n<iframe src=\"/images/static/doc_examples/crop_climate_risk.html\" width=\"100%\" height=\"700\" style=\"border:none;\"></iframe>","operationId":"Crop_Climate_Risk_crop_climate_risk_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"type":"number","title":"PNG scale","description":"Scale factor applied to the default image resolution. Values above 1 produce larger, higher-resolution images.","default":1},"description":"Scale factor applied to the default image resolution. Values above 1 produce larger, higher-resolution images."},{"$ref":"#/components/parameters/png_width"},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__core__climate_risk__main_crop_risk__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"nemsglobal"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"This diagram is only available in English","default":"en","title":"Lang"},"description":"This diagram is only available in English"},{"$ref":"#/components/parameters/risk"},{"$ref":"#/components/parameters/crop"},{"name":"years_start","in":"query","required":false,"schema":{"type":"integer","maximum":2025,"minimum":1985,"title":"Start year","description":"First year of the analysis period.","default":2016},"description":"First year of the analysis period."},{"name":"years_end","in":"query","required":false,"schema":{"type":"integer","maximum":2025,"minimum":1985,"title":"End year","description":"Last year of the analysis period.","default":2025},"description":"Last year of the analysis period."},{"$ref":"#/components/parameters/month_start"},{"$ref":"#/components/parameters/month_end"},{"$ref":"#/components/parameters/day_start"},{"$ref":"#/components/parameters/t_base"},{"$ref":"#/components/parameters/t_max"},{"$ref":"#/components/parameters/soil_water_capacity"},{"$ref":"#/components/parameters/drought_threshold"},{"$ref":"#/components/parameters/frost_threshold"},{"name":"frost_duration","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Frost duration","description":"Minimum number of consecutive days below `frost_threshold` to count as a frost event."},"description":"Minimum number of consecutive days below `frost_threshold` to count as a frost event."},{"$ref":"#/components/parameters/heat_threshold"},{"name":"heat_duration","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Heat duration","description":"Minimum number of consecutive days above `heat_threshold` to count as a heat event."},"description":"Minimum number of consecutive days above `heat_threshold` to count as a heat event."},{"$ref":"#/components/parameters/stages_name"},{"$ref":"#/components/parameters/stages_gdd"},{"$ref":"#/components/parameters/stages_impact_drought"},{"$ref":"#/components/parameters/stages_impact_frost"},{"$ref":"#/components/parameters/stages_impact_heat"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}},"/crop_weather_risk_monitoring":{"get":{"tags":["Crop Risk Analysis Diagrams"],"summary":"Crop Weather Risk Monitoring","description":"The Crop Weather Risk Monitoring Diagram visualises weather-related risk monitoring information for crops at a selected location.\n\n<iframe src=\"/images/static/doc_examples/crop_weather_risk_monitoring.html\" width=\"100%\" height=\"900\" style=\"border:none;\"></iframe>","operationId":"Crop_Weather_Risk_Monitoring_crop_weather_risk_monitoring_get","parameters":[{"name":"png_scale","in":"query","required":false,"schema":{"type":"number","title":"PNG scale","description":"Scale factor applied to the default image resolution. Values above 1 produce larger, higher-resolution images.","default":1},"description":"Scale factor applied to the default image resolution. Values above 1 produce larger, higher-resolution images."},{"$ref":"#/components/parameters/png_width"},{"$ref":"#/components/parameters/lat"},{"$ref":"#/components/parameters/lon"},{"$ref":"#/components/parameters/asl"},{"$ref":"#/components/parameters/tz"},{"$ref":"#/components/parameters/temperature_units"},{"$ref":"#/components/parameters/precipitation_units"},{"name":"windspeed_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WindspeedUnitsImageApi","title":"Wind speed units","description":"Specifies the unit used for wind speed values in the response.","default":"ms-1"},"description":"Specifies the unit used for wind speed values in the response."},{"$ref":"#/components/parameters/location_name"},{"$ref":"#/components/parameters/dpi"},{"$ref":"#/components/parameters/download"},{"$ref":"#/components/parameters/no_logo"},{"name":"domain","in":"query","required":false,"schema":{"$ref":"#/components/schemas/app__core__climate_risk__main_crop_risk__SelectDomain","title":"Domain","description":"Weather model domain. NOTE: not all domains are available for all locations.","default":"nemsglobal"},"description":"Weather model domain. NOTE: not all domains are available for all locations."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"This diagram is only available in English","default":"en","title":"Lang"},"description":"This diagram is only available in English"},{"$ref":"#/components/parameters/risk"},{"$ref":"#/components/parameters/crop"},{"name":"years_clima_start","in":"query","required":false,"schema":{"type":"integer","maximum":2025,"minimum":1985,"title":"Climate start year","description":"Start year of the climatological reference period.","default":1985},"description":"Start year of the climatological reference period."},{"name":"years_clima_end","in":"query","required":false,"schema":{"type":"integer","maximum":2025,"minimum":1985,"title":"Climate end year","description":"End year of the climatological reference period.","default":2025},"description":"End year of the climatological reference period."},{"name":"years_actual_start","in":"query","required":false,"schema":{"type":"integer","maximum":2025,"minimum":1985,"title":"Actual period start year","description":"Start year of the recent period to compare against the climatology.","default":2016},"description":"Start year of the recent period to compare against the climatology."},{"name":"years_actual_end","in":"query","required":false,"schema":{"type":"integer","maximum":2025,"minimum":1985,"title":"Actual period end year","description":"End year of the recent period to compare against the climatology.","default":2025},"description":"End year of the recent period to compare against the climatology."},{"$ref":"#/components/parameters/month_start"},{"$ref":"#/components/parameters/month_end"},{"$ref":"#/components/parameters/day_start"},{"$ref":"#/components/parameters/t_base"},{"$ref":"#/components/parameters/t_max"},{"$ref":"#/components/parameters/soil_water_capacity"},{"$ref":"#/components/parameters/drought_threshold"},{"$ref":"#/components/parameters/frost_threshold"},{"$ref":"#/components/parameters/heat_threshold"},{"$ref":"#/components/parameters/stages_name"},{"$ref":"#/components/parameters/stages_gdd"},{"$ref":"#/components/parameters/stages_impact_drought"},{"$ref":"#/components/parameters/stages_impact_frost"},{"$ref":"#/components/parameters/stages_impact_heat"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FormatOutputImage"},{"$ref":"#/components/schemas/FormatOutputInteractive"}],"title":"Output format","default":"highchartshtml"}}],"responses":{"200":{"description":"Successful Response","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Access to the image API expired for this user"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean","const":true,"description":"Flag indicating that an error has occurred."},"error_message":{"type":"string","description":"Message describing the error."}}},"example":{"error":"true","error_message":"Available credits exceeded for this API key"}}}}}}}},"components":{"schemas":{"CropType":{"type":"string","enum":["cotton","maize","soybeans","spring_barley","winter_barley","summer_wheat","sunflower","vineyards","winter_wheat","potatoes"],"title":"CropType"},"Crops":{"type":"string","enum":["all","barley","cotton","maize","potato","rapseed","riceindica","ricejaponi","sorghum","soybean","sugarbeets","wheat"],"title":"Crops"},"ElevationUnits":{"type":"string","enum":["m","ft"],"title":"ElevationUnits"},"Event":{"type":"string","enum":["cold_event","warm_event","precipitation_event","soil_water_event","cloud_cover_event","wind_speed_event","wind_gust_event"],"title":"Event"},"FormatOutputImage":{"type":"string","enum":["png","webp"],"title":"FormatOutputImage","x-enumDescriptions":{"png":"PNG image","webp":"WebP image (smaller file size than PNG)"}},"FormatOutputInteractive":{"type":"string","enum":["highchartshtml"],"title":"FormatOutputInteractive","x-enumDescriptions":{"highchartshtml":"Self-contained HTML page with an embedded Highcharts chart"}},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImageDpi":{"type":"integer","enum":[50,72,80,100,300],"title":"ImageDpi"},"Language":{"type":"string","enum":["ar","bg","cs","de","el","en","es","fr","hr","hu","it","ka","nl","pl","pt","ro","ru","sk","sl","sr","tr","uk","ar_SA","bg_BG","ca_ES","cs_CZ","de_DE","el_GR","en_GB","es_ES","fr_FR","hr_HR","hu_HU","it_IT","ka_GE","nl_NL","pl_PL","pt_PT","ro_RO","ru_RU","sk_SK","sr_RS","tr_TR","uk_UA"],"title":"Language"},"PanelNum":{"type":"string","enum":["first","second"],"title":"PanelNum"},"PrecipitationUnitsImageApi":{"type":"string","enum":["mm","inch"],"title":"PrecipitationUnitsImageApi","x-enumDescriptions":{"inch":"Inch","mm":"Millimeter"}},"SelectEvent":{"type":"string","enum":["drought","frost","heat"],"title":"SelectEvent"},"SelectWeatherVariableClimate":{"type":"string","enum":["temperature","precipitation"],"title":"SelectWeatherVariableClimate"},"StueveMinPressure":{"type":"integer","enum":[250,550],"title":"StueveMinPressure"},"TemperatureUnitsImageApi":{"type":"string","enum":["C","F"],"title":"TemperatureUnitsImageApi","x-enumDescriptions":{"C":"Celsius","F":"Fahrenheit"}},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Visualization":{"type":"string","enum":["single_month","all_months"],"title":"Visualization"},"WindSymbol":{"type":"string","enum":["barb","arrow","none"],"title":"WindSymbol"},"WindspeedUnitsImageApi":{"type":"string","enum":["kmh","ms-1","mph","kn","bft"],"title":"WindspeedUnitsImageApi","description":"used by image API","x-enumDescriptions":{"bft":"Beaufort","kmh":"Kilometers per hour","kn":"Knots","mph":"Miles per hour","ms-1":"Meters per second"}},"app__core__climate_risk__main_crop_risk__SelectDomain":{"type":"string","enum":["nemsglobal"],"title":"SelectDomain"},"app__helper__diagram__SelectDomain":{"type":"string","enum":["nemsglobal","era5","era5t","icon13","nems4","mffr","nmm4","nemsaf","nemsas","nemssa","nemsnz","nemscam","nemsin","nam12","af01","as01","sa01"],"title":"SelectDomain","description":"These domains are used for historical diagrams. Therefore only those available in dataset API and with > 7 years available are enabled."}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"query","name":"apikey","description":"A meteoblue API access key. [Get a key](https://www.meteoblue.com/en/weather-api/apikey/index)"}},"parameters":{"risk":{"name":"risk","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SelectEvent","title":"Risk type","description":"Type of weather risk to analyse.","default":"drought"},"description":"Type of weather risk to analyse."},"month_end":{"name":"month_end","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":12,"minimum":1},{"type":"null"}],"title":"End month","description":"Last month of the growing season (1 = January … 12 = December)."},"description":"Last month of the growing season (1 = January … 12 = December)."},"stages_impact_heat":{"name":"stages_impact_heat","in":"query","required":false,"schema":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"null"}]},"title":"Heat impact per stage","description":"Heat impact multiplier for each growth stage (0 = no impact, 1 = full loss).","default":[]},"description":"Heat impact multiplier for each growth stage (0 = no impact, 1 = full loss)."},"tracker":{"name":"tracker","in":"query","required":false,"schema":{"type":"integer","maximum":5,"minimum":0,"title":"Sun tracker type","description":"For solar panels using a sun tracker. 0: no tracker, 1: daily vertical axis tracker, 2: daily 2-axis tracker, 3: yearly horizontal tracker, 4: daily DNI tracker, 5: daily horizontal axis tracker","default":0},"description":"For solar panels using a sun tracker. 0: no tracker, 1: daily vertical axis tracker, 2: daily 2-axis tracker, 3: yearly horizontal tracker, 4: daily DNI tracker, 5: daily horizontal axis tracker"},"download":{"name":"download","in":"query","required":false,"schema":{"type":"integer","maximum":1,"minimum":0,"title":"Download","description":"Controls the `Content-Disposition` header in the response. 0: `inline`, 1: `attachment`","default":0},"description":"Controls the `Content-Disposition` header in the response. 0: `inline`, 1: `attachment`"},"lat":{"name":"lat","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":-90,"title":"Latitude","description":"Latitude of location (WGS 84)"},"description":"Latitude of location (WGS 84)"},"no_logo":{"name":"no_logo","in":"query","required":false,"schema":{"type":"boolean","title":"No logo","description":"If true, returns the image without the meteoblue logo.","default":false},"description":"If true, returns the image without the meteoblue logo."},"slope":{"name":"slope","in":"query","required":true,"schema":{"type":"number","maximum":90,"minimum":0,"title":"Panel inclination","description":"Inclination of solar panel (°)"},"description":"Inclination of solar panel (°)"},"precipitation_units":{"name":"precipitation_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/PrecipitationUnitsImageApi","title":"Precipitation units","description":"Specifies the unit used for precipitation values in the response.","default":"mm"},"description":"Specifies the unit used for precipitation values in the response."},"crop":{"name":"crop","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CropType","title":"Crop type","description":"Crop type to analyse.","default":"maize"},"description":"Crop type to analyse."},"lon":{"name":"lon","in":"query","required":true,"schema":{"type":"number","maximum":180,"minimum":-180,"title":"Longitude","description":"Longitude of location (WGS 84)"},"description":"Longitude of location (WGS 84)"},"soil_water_capacity":{"name":"soil_water_capacity","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Soil water capacity","description":"Maximum plant-available soil water capacity (mm). Used to compute drought stress."},"description":"Maximum plant-available soil water capacity (mm). Used to compute drought stress."},"drought_threshold":{"name":"drought_threshold","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Drought threshold","description":"Soil water level (mm) below which drought stress begins."},"description":"Soil water level (mm) below which drought stress begins."},"dpi":{"name":"dpi","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ImageDpi","title":"DPI","description":"Resolution of the generated image in dots per inch. Higher values produce sharper images at the cost of larger file sizes.","default":72},"description":"Resolution of the generated image in dots per inch. Higher values produce sharper images at the cost of larger file sizes."},"stages_impact_drought":{"name":"stages_impact_drought","in":"query","required":false,"schema":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"null"}]},"title":"Drought impact per stage","description":"Drought impact multiplier for each growth stage (0 = no impact, 1 = full loss).","default":[]},"description":"Drought impact multiplier for each growth stage (0 = no impact, 1 = full loss)."},"temperature_units":{"name":"temperature_units","in":"query","required":false,"schema":{"$ref":"#/components/schemas/TemperatureUnitsImageApi","title":"Temperature units","description":"Specifies the unit used for temperature values in the response.","default":"C"},"description":"Specifies the unit used for temperature values in the response."},"year_start":{"name":"year_start","in":"query","required":false,"schema":{"type":"integer","maximum":2026,"minimum":1979,"title":"Start year","description":"First year of the analysis period.","default":1985},"description":"First year of the analysis period."},"kwp":{"name":"kwp","in":"query","required":true,"schema":{"type":"number","exclusiveMinimum":0,"title":"Peak power","description":"Rated peak power of the solar installation in kilowatt-peak (kWp)."},"description":"Rated peak power of the solar installation in kilowatt-peak (kWp)."},"png_width":{"name":"png_width","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"PNG width","description":"Output image width in pixels. Overrides `png_scale` when provided."},"description":"Output image width in pixels. Overrides `png_scale` when provided."},"location_name":{"name":"location_name","in":"query","required":false,"schema":{"type":"string","title":"Location name","description":"Custom label displayed as the location name in the image.","default":""},"description":"Custom label displayed as the location name in the image."},"day_start":{"name":"day_start","in":"query","required":false,"schema":{"type":"integer","title":"Start day","description":"Day of the month on which the season starts.","default":1},"description":"Day of the month on which the season starts."},"power_efficiency":{"name":"power_efficiency","in":"query","required":false,"schema":{"type":"number","maximum":1,"minimum":0,"title":"Power efficiency","description":"Power conversion efficiency of the PV module as a fraction between 0 and 1 (e.g. 0.85 = 85%).","default":0.85},"description":"Power conversion efficiency of the PV module as a fraction between 0 and 1 (e.g. 0.85 = 85%)."},"heat_threshold":{"name":"heat_threshold","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Heat threshold","description":"Temperature (°C) above which heat stress occurs."},"description":"Temperature (°C) above which heat stress occurs."},"asl":{"name":"asl","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":10000,"minimum":-500},{"type":"null"}],"title":"Elevation","description":"The elevation above sea level in metres for the location of interest. If not specified, an elevation is inferred from the given location using an 80 metre resolution digital elevation model (DEM). Specifying an elevation can improve forecast accuracy, as the API applies elevation corrections to the returned variables. Especially in complex alpine terrain, the Forecast API behaves differently for coordinates in a valley and on the mountain."},"description":"The elevation above sea level in metres for the location of interest. If not specified, an elevation is inferred from the given location using an 80 metre resolution digital elevation model (DEM). Specifying an elevation can improve forecast accuracy, as the API applies elevation corrections to the returned variables. Especially in complex alpine terrain, the Forecast API behaves differently for coordinates in a valley and on the mountain."},"tz":{"name":"tz","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","description":"Time zone identifier as specified in the time zone database.\n\nIf no time zone is specified, the API will detect the time zone automatically. For coordinates at sea, the API attempts to determine a nearby coastal time zone (up to approximately 50 km), otherwise UTC is used.\n\nFor automated systems and further data processing, the use of UTC without local time zone offsets or seasonal time changes is recommended.\n\nFor time zones with daylight saving time, only the time-offset at the time of the API call will be used. There will be no daylight saving time switches in the actual data. So if a place switches from Summertime to Wintertime on Sunday (20.11.2019) and the API is called on Saturday (19.11.2019), all days of the forecasts will use Summertime.\n\nFor time zones with fractional hour offsets (for example, Asia/Kolkata at UTC+05:30), the offset is rounded to a full hour internally.\n\n[List of time zones which are included in the time zone database.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)","examples":["Europe/zurich","GMT-02:00","utc"]},"description":"Time zone identifier as specified in the time zone database.\n\nIf no time zone is specified, the API will detect the time zone automatically. For coordinates at sea, the API attempts to determine a nearby coastal time zone (up to approximately 50 km), otherwise UTC is used.\n\nFor automated systems and further data processing, the use of UTC without local time zone offsets or seasonal time changes is recommended.\n\nFor time zones with daylight saving time, only the time-offset at the time of the API call will be used. There will be no daylight saving time switches in the actual data. So if a place switches from Summertime to Wintertime on Sunday (20.11.2019) and the API is called on Saturday (19.11.2019), all days of the forecasts will use Summertime.\n\nFor time zones with fractional hour offsets (for example, Asia/Kolkata at UTC+05:30), the offset is rounded to a full hour internally.\n\n[List of time zones which are included in the time zone database.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"},"hour":{"name":"hour","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":23,"minimum":0},{"type":"null"}],"title":"Hour","description":"Desired hour of the day (local time in the selected timezone) in 24-hour format. Defaults to the current hour."},"description":"Desired hour of the day (local time in the selected timezone) in 24-hour format. Defaults to the current hour."},"facing":{"name":"facing","in":"query","required":true,"schema":{"type":"number","maximum":360,"minimum":0,"title":"Panel orientation","description":"Azimuth angle of the solar panel in degrees (0° = North, 90° = East, 180° = South, 270° = West)."},"description":"Azimuth angle of the solar panel in degrees (0° = North, 90° = East, 180° = South, 270° = West)."},"stages_impact_frost":{"name":"stages_impact_frost","in":"query","required":false,"schema":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"null"}]},"title":"Frost impact per stage","description":"Frost impact multiplier for each growth stage (0 = no impact, 1 = full loss).","default":[]},"description":"Frost impact multiplier for each growth stage (0 = no impact, 1 = full loss)."},"frost_threshold":{"name":"frost_threshold","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Frost threshold","description":"Temperature (°C) below which frost damage occurs."},"description":"Temperature (°C) below which frost damage occurs."},"month_start":{"name":"month_start","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":12,"minimum":1},{"type":"null"}],"title":"Start month","description":"First month of the growing season (1 = January … 12 = December)."},"description":"First month of the growing season (1 = January … 12 = December)."},"t_base":{"name":"t_base","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base temperature","description":"Base temperature for GDD accumulation (°C). Temperatures below this value do not contribute to GDD."},"description":"Base temperature for GDD accumulation (°C). Temperatures below this value do not contribute to GDD."},"date":{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Date in ISO format YYYY-MM-DD. Accepted range: up to 3 days in the past to 7 days in the future. Defaults to today's date.","examples":["2024-03-19"]},"description":"Date in ISO format YYYY-MM-DD. Accepted range: up to 3 days in the past to 7 days in the future. Defaults to today's date."},"stages_gdd":{"name":"stages_gdd","in":"query","required":false,"schema":{"type":"array","items":{"anyOf":[{"type":"integer"},{"type":"null"}]},"title":"Stage GDD thresholds","description":"Accumulated GDD required to complete each growth stage.","default":[]},"description":"Accumulated GDD required to complete each growth stage."},"stages_name":{"name":"stages_name","in":"query","required":false,"schema":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":"Stage names","description":"Names of the crop growth stages.","default":[]},"description":"Names of the crop growth stages."},"year_end":{"name":"year_end","in":"query","required":false,"schema":{"type":"integer","maximum":2026,"minimum":1979,"title":"End year","description":"Last year of the analysis period.","default":2020},"description":"Last year of the analysis period."},"t_max":{"name":"t_max","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Maximum temperature","description":"Upper temperature threshold for GDD accumulation (°C). Temperatures above this value are capped."},"description":"Upper temperature threshold for GDD accumulation (°C). Temperatures above this value are capped."}}},"security":[{"ApiKeyAuth":[]}],"servers":[{"url":"/images"}]}