Skip to main content
GET
/
buoys
/
search
Search buoys
curl --request GET \
  --url https://api.thebuoy.app/v2/buoys/search \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "buoys": [
      {
        "id": 10,
        "name": "Anglet",
        "slug": "anglet",
        "lat": 43.4832,
        "lng": -1.5586,
        "source": "Candhis",
        "source_identifier": "64002",
        "country": "France"
      }
    ],
    "count": 1
  },
  "meta": {
    "timestamp": "2025-11-01T10:00:00Z"
  }
}

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.

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