Endpoints et exemples d'utilisation

Deux endpoints permettent d'obtenir la liste des sites disponibles et d'interroger les hauteurs d'eau au format JSON.

Cette documentation présente la structure des requêtes et des réponses pour intégrer facilement l'API dans un site, une application ou un traitement automatisé.

360 requêtes / heure 1500 hauteurs max / requête Intervalles disponibles : 1, 5, 10, 15, 20, 30, 60 min

Pour une introduction plus guidée, consultez aussi API marée : comment récupérer des hauteurs d'eau en JSON.

Vous pouvez également revenir sur la page d'accueil de l'API pour tester une requête directement.

GET

/sites

Retourne la liste des sites disponibles avec leur identifiant et leurs coordonnées.

Exemple de requête

GET /sites

Exemple de réponse

{
  "sites": [
    {
      "site_id": "port-en-bessin",
      "name": "Port en Bessin",
      "latitude": 49.352565,
      "longitude": -0.749206
    }
  ]
}

GET

/water-levels

Retourne une série temporelle de hauteurs d'eau pour un site et une période donnés.

Paramètres

`key`Clé API du compte

`site`Identifiant du site

`from`Date/heure de début

`to`Date/heure de fin

`step`Pas de temps en minutes

`tz``Europe/Paris` ou `UTC`

Contraintes

Le quota s'applique par compte et par heure.
Une requête ne peut pas dépasser 1500 hauteurs d'eau.
Les dates demandées doivent rester dans la fenêtre J-30 à J+30.
Les hauteurs sont renvoyées en mètres.

Exemple de requête

GET /water-levels?site=port-en-bessin&from=2026-03-24T00:00&to=2026-03-25T00:00&step=10&tz=Europe/Paris&key=00000000000000000000000000000000

Exemple de réponse

{
  "site": "port-en-bessin",
  "timezone": "Europe/Paris",
  "from": "2026-03-24T00:00:00+01:00",
  "to": "2026-03-25T00:00:00+01:00",
  "step_minutes": 10,
  "unit": "m",
  "data": [
    { "time": "2026-03-24T00:00:00+01:00", "height": 6.454 },
    { "time": "2026-03-24T00:10:00+01:00", "height": 6.605 },
    { "time": "2026-03-24T00:20:00+01:00", "height": 6.730 }
  ]
}