# openmeteo.flood

**stable** **Advanced**

River discharge forecast (GloFAS) for the nearest river cell.

`GET /v1/openmeteo/flood`

## What you get

One Openmeteo record in Onekey's unified shape, in `data`. If the record does not exist you get a `404 not_found` and are not charged.

## What it costs

- **Advanced · 5 credits** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `lat` | string | yes | (required) | Latitude in decimal degrees (-90..90) | max 10 chars; must match `-?(?:[0-8]?\d(?:\.\d{1,6})?\|90(?:\.0{1,6})?)`; trimmed |
| `lon` | string | yes | (required) | Longitude in decimal degrees (-180..180) | max 11 chars; must match `-?(?:1[0-7]\d(?:\.\d{1,6})?\|\d{1,2}(?:\.\d{1,6})?\|180(?:\.0{1,6})?)`; trimmed |
| `days` | string | no | `7` | Forecast days (1-92) | max 2 chars; must match `[1-9]\d?`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/openmeteo/flood?lat=52.52&lon=13.41" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/openmeteo/flood",
    params={"lat": "52.52", "lon": "13.41"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ lat: "52.52", lon: "13.41" });
const res = await fetch(`https://api.onekey.dev/v1/openmeteo/flood?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Openmeteo response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "ext": {
      "dates": [
        "2026-09-28",
        "2026-09-29",
        "2026-09-30",
        "2026-10-01",
        "2026-10-02",
        "2026-10-03",
        "2026-10-04"
      ],
      "dischargeM3s": [
        0.53,
        0.51,
        0.49,
        0.49,
        0.48,
        0.48,
        0.49
      ],
      "dischargeMeanM3s": [
        0.53,
        0.51,
        0.49,
        0.49,
        0.48,
        0.49,
        0.5
      ],
      "dischargeMaxM3s": [
        0.53,
        0.51,
        0.49,
        0.49,
        0.48,
        0.78,
        0.82
      ]
    }
  },
  "metadata": {
    "platform": "openmeteo",
    "endpoint": "flood",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `daily.time` | `ext.dates` | - |
| `daily.river_discharge` | `ext.dischargeM3s` | - |
| `daily.river_discharge_mean` | `ext.dischargeMeanM3s` | - |
| `daily.river_discharge_max` | `ext.dischargeMaxM3s` | - |

## Caching and freshness

- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
- A "not found" is remembered for 1 minute and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | That record does not exist. Free; do not retry. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).