/openmeteo/flood

POST /api/openmeteo/flood

Price: 1 credit

Get daily river-discharge (flood) data for a geographic point

How to use it

Get daily river-discharge data (GloFAS global flood model) for a point by latitude and longitude. List the discharge variables you want in 'daily' (mean, median, min, max, and 25th and 75th percentiles). Supports forecast days, past days, an explicit start_date/end_date interval (data from 1984 onward), and an ensemble flag to return every forecast member. Returns point metadata plus a daily block of per-date records with their units.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• latitude number required — Latitude in WGS84 coordinates (examples: 52.52; min: -90; max: 90)
• longitude number required — Longitude in WGS84 coordinates (examples: 13.41; min: -180; max: 180)
• daily array required — Daily river-discharge variables to return (one of: "river_discharge", "river_discharge_mean", "river_discharge_median", "river_discharge_max", "river_discharge_min", "river_discharge_p25", "river_discharge_p75")
• forecast_days integer nullable — Number of forecast days to return, counting from today (min: 0; max: 210)
• past_days integer nullable — Number of past days to include before today (min: 0; max: 92)
• start_date string nullable — Start of an explicit date interval (YYYY-MM-DD) (examples: "2024-01-01")
• end_date string nullable — End of an explicit date interval (YYYY-MM-DD) (examples: "2024-01-31")
• ensemble boolean — Return each individual ensemble forecast member instead of a single series (default: false)
• timeformat string — Representation of time values in the response (default: "iso8601"; one of: "iso8601", "unixtime")

Response

• @type string (default: "OpenmeteoWeather")
• latitude number required
• longitude number required
• generation_time_ms number nullable
• utc_offset_seconds integer nullable
• timezone string nullable
• timezone_abbreviation string nullable
• elevation number nullable
• current object nullable
  • @type string (default: "OpenmeteoCurrentConditions")
  • units object (default: {})
    • * string
  • values object (default: {})
• minutely_15 object nullable
  • @type string (default: "OpenmeteoTimeSeries")
  • units object (default: {})
    • * string
  • records array (default: [])
• hourly object nullable
  • @type string (default: "OpenmeteoTimeSeries")
  • units object (default: {})
    • * string
  • records array (default: [])
• daily object nullable
  • @type string (default: "OpenmeteoTimeSeries")
  • units object (default: {})
    • * string
  • records array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No data available for the location Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.