Skip to main content
GET
Search 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

query
string
required

Search term (minimum 2 characters)

Minimum string length: 2
limit
integer
default:10

Maximum number of results (default 10, max 50)

Required range: 1 <= x <= 50

Response

Successful response

status
string
Example:

"success"

data
object
meta
object