Skip to main content
GET
Get historical readings for a buoy

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.

Path Parameters

buoy_id
integer
required

Query Parameters

start_date
string<date-time>

Start date in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)

end_date
string<date-time>

End date in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)

date
string<date>

Filter by single date (YYYY-MM-DD). Alternative to start_date/end_date.

timestamp
integer

Filter by unix timestamp (seconds). Returns readings within a 3-hour window.

order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
page
integer
default:1
per_page
integer
default:20
Required range: 1 <= x <= 100

Response

Successful response

status
string
Example:

"success"

data
object
meta
object

Pagination metadata included in list responses