Skip to main content
GET
List all buoys

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Format: Authorization: Bearer YOUR_API_KEY

Alternative: Pass as query parameter ?api_key=YOUR_API_KEY

Security: API keys are stored as BCrypt hashes (never plain text). Only the hash is stored in the database.

Query Parameters

bounds
string

Geographic bounding box as JSON string {"north":44,"south":43,"east":-1,"west":-2}

near
string

Coordinates and radius in format lat,lng (e.g., "43.5,-1.5"). Use with radius parameter.

radius
integer
default:100

Search radius in kilometers (used with near parameter, default: 100)

source
string

Filter by source (e.g., "Candhis", "Meteo France", "Sofar Ocean")

country
string

Filter by ISO 3166-1 alpha-2 country code (e.g., "FR", "ES", "PT"). When set, up to 500 buoys are returned per page.

Pattern: ^[A-Z]{2}$
active_only
boolean
default:true

Only return buoys with recent readings (default: true)

page
integer
default:1
per_page
integer
default:50
Required range: x <= 500

Response

Successful response

status
string
Example:

"success"

data
object
meta
object

Pagination metadata included in list responses