Base URL
All endpoints are served from:Authentication
All endpoints exceptGET /buoys/search and GET /buoys/nearest require a Bearer token:
Response format
Every response uses a consistent envelope:Error codes
| HTTP status | error value | Meaning |
|---|---|---|
400 | bad_request | Missing or malformed parameters |
401 | unauthorized | Invalid or missing API key |
404 | resource_not_found | Resource doesn’t exist |
422 | validation_failed | Parameter validation error |
429 | rate_limit_exceeded | Hourly quota exceeded |
Pagination
List endpoints acceptpage and per_page parameters. Pagination metadata is always in meta:
Units
| Measurement | Unit |
|---|---|
| Wave height | metres (m) |
| Wave period | seconds (s) |
| Wave direction | degrees (°), clockwise from north |
| Wind speed | km/h |
| Temperature | °C |
| Distance (radius) | kilometres (km) |