Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.thebuoy.app/llms.txt

Use this file to discover all available pages before exploring further.

​
When to use this endpoint

GET /buoys/last_readings is best when:
  • You already have a list of specific buoy IDs you care about (e.g. stored in your own database)
  • You want only reading data, without buoy metadata, for a minimal payload
  • You need targeted polling for a small, fixed set of buoys
Don’t have IDs yet? Use GET /buoys?country=FR — it returns buoys with readings in one call, and is the right starting point for building your ID list.

​
Basic usage

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.thebuoy.app/v2/buoys/last_readings?ids=12,45,78"
By default, only the first 3 IDs in your list are returned. To fetch more, pass a limit: 
# Fetch up to 100 buoys at once
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.thebuoy.app/v2/buoys/last_readings?ids=12,45,78,91,34&limit=5"

​
Parameters

ParameterTypeDefaultMaxDescription
idsstringrequired—Comma-separated or array-style buoy IDs
limitinteger3100How many IDs from the list to process
Array-style IDs also work: 
"?ids[]=12&ids[]=45&ids[]=78&limit=3"

​
Response

{
  "status": "success",
  "data": {
    "buoys": [
      {
        "id": 12,
        "name": "Anglet",
        "lat": 43.4832,
        "lng": -1.5586,
        "source": "Candhis",
        "last_reading": {
          "significient_height": 1.8,
          "maximum_height": 2.4,
          "period": 9.5,
          "direction": 285,
          "water_temperature": 14.2,
          "time": "2026-03-27T08:00:00Z"
        }
      }
    ],
    "missing_ids": [999]
  },
  "meta": {
    "timestamp": "2026-03-27T09:00:00Z"
  }
}

​
missing_ids

Any IDs you requested that don’t exist in the database are returned in missing_ids. This lets you detect stale IDs in your application without additional lookups.

​
Payload design

The endpoint returns only the fields needed for reading collection. Forecast fields (tide_forecast, marine_forecast, weather_forecast) are excluded to keep payloads small, even at 100 buoys per request.

​
Polling 30+ buoys

If you have more than 100 buoys, chunk the ID list and make multiple calls. Each call counts as one request against your rate limit: 
import requests

API_KEY = "YOUR_API_KEY"
BASE_URL = "https://api.thebuoy.app/v2"

def fetch_last_readings(buoy_ids: list[int], chunk_size: int = 100) -> list[dict]:
    headers = {"Authorization": f"Bearer {API_KEY}"}
    all_buoys = []

    for i in range(0, len(buoy_ids), chunk_size):
        chunk = buoy_ids[i : i + chunk_size]
        ids_param = ",".join(map(str, chunk))

        response = requests.get(
            f"{BASE_URL}/buoys/last_readings",
            params={"ids": ids_param, "limit": len(chunk)},
            headers=headers,
            timeout=15,
        )
        response.raise_for_status()
        all_buoys.extend(response.json()["data"]["buoys"])

    return all_buoys

# Example: 150 buoy IDs → 2 requests
my_buoy_ids = list(range(1, 151))
readings = fetch_last_readings(my_buoy_ids)
print(f"Got readings for {len(readings)} buoys")

​
Choosing between country filter and last_readings

ScenarioRecommended endpoint
First run — discover all France buoysGET /buoys?country=FR
Periodic poll — you already have IDs storedGET /buoys/last_readings?ids=...&limit=100
Small fixed list (≤ 3 buoys)GET /buoys/last_readings?ids=... (no limit needed)
Need buoy name, coords, and timezone tooGET /buoys?country=FR (all metadata included)