REST APIDocs publicadas - claves por invitación

The Buoy API

Datos de boyas oceánicas en tiempo real e históricos para desarrolladores. Usa endpoints GET de solo lectura para listar boyas activas, filtrar por país o geografía, recuperar histórico y generar series temporales.

terminal
$ curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://thesurfkit.com/api/v2/buoys?country=FR&per_page=5"
{
  "status": "success",
  "data": {
    "buoys": [
      {
        "id": 12,
        "name": "Anglet",
        "slug": "anglet",
        "source": "Candhis",
        "last_reading": {
          "significient_height": 1.8,
          "maximum_height": 2.4,
          "period": 9.5,
          "direction": 285,
          "water_temperature": 14.2,
          "time": "2026-03-27T08:00:00Z"
        }
      }
    ],
    "count": 28
  },
  "meta": {
    "page": 1,
    "per_page": 5,
    "total_pages": 6
  }
}

Qué cubre la API publicada

La documentación pública se centra ahora mismo en descubrimiento de boyas, últimas lecturas y acceso histórico.

Campos de lectura

  • significient_height
  • maximum_height
  • period
  • direction
  • water_temperature

Consultas y filtros

  • country=FR
  • bounds={north,south,east,west}
  • near=lat,lng + radius
  • query=anglet
  • búsqueda nearest por lat/lng

Convenciones

  • Endpoints solo GET
  • Authorization: Bearer <api_key>
  • {status, data, meta}
  • Cabeceras X-RateLimit-*
  • page / per_page / total_pages

Endpoints de boyas publicados

La referencia oficial documenta ahora mismo nueve endpoints GET de solo lectura para listar, buscar, localizar y consultar datos de boyas.

MethodEndpoint
GET/api/v2/buoys
GET/api/v2/buoys/{buoy_id}
GET/api/v2/buoys/last_readings
GET/api/v2/buoys/search
GET/api/v2/buoys/nearest
GET/api/v2/buoys/{buoy_id}/readings
GET/api/v2/buoys/{buoy_id}/readings/search
GET/api/v2/buoys/{buoy_id}/readings/{reading_id}
GET/api/v2/buoys/{buoy_id}/readings/chart

Una API pública más simple

La documentación en vivo describe una API de boyas enfocada, con payloads predecibles y endpoints públicos para descubrimiento.

Redes oficiales, una API

Candhis, Météo France, NOAA/NDBC, Sofar Ocean, Vegagerðin y otras redes activas alimentan la misma API.

Últimas lecturas incluidas

GET /buoys ya devuelve cada boya con su last_reading, así que arrancar un país o una región se resuelve en una sola llamada.

Formato status/data/meta

Los endpoints de lista, búsqueda, nearest y lecturas usan la misma envoltura JSON para que el parsing del cliente sea simple.

Búsqueda por país y geografía

Filtra con country, bounds o near + radius, o salta directamente a /buoys/nearest para resolver por coordenadas.

Histórico y series temporales

Usa /readings, /readings/search, /readings/{reading_id} y /readings/chart para detalle e históricos listos para graficar.

Docs públicas, auth por invitación

La referencia es pública en docs.labouee.app. Las llamadas autenticadas usan claves Bearer, mientras que search y nearest siguen siendo públicas.

Para Cualquier Aplicación de Datos de Olas

Desde apps de surf hasta investigación oceanográfica, nuestra API de datos de boyas alimenta una amplia gama de productos.

Apps de Surf

Alimenta checks de condiciones con datos de altura de olas, período de oleaje y lecturas de boyas en tiempo real.

Monitoreo Costero

Construye herramientas de monitoreo de olas para puertos, marinas, ingeniería costera y operaciones offshore.

Investigación Oceanográfica

Accede a lecturas históricas de boyas para estudios climáticos, modelado de olas y machine learning.

IoT y Hardware

Conecta dispositivos a datos de boyas en directo para alertas, displays y automatización.

Preguntas Frecuentes

La documentación pública cita fuentes como Candhis, Météo France, NOAA/NDBC, Sofar Ocean, Vegagerðin y otras redes activas. El sitio mantiene un directorio de fuentes más amplio, mientras que la referencia API se centra en los endpoints de boyas publicados.

Las peticiones v2 autenticadas usan Authorization: Bearer <api_key>. La documentación también permite api_key como query parameter para entornos limitados, pero recomienda la cabecera Authorization. Las claves API se emiten ahora mismo por invitación.

Sí. GET /api/v2/buoys/search y GET /api/v2/buoys/nearest no requieren autenticación y pueden probarse antes de tener credenciales.

GET /api/v2/buoys devuelve una lista paginada de boyas y ya incluye last_reading en cada resultado. También puedes filtrar por country, source, bounds o near + radius sin hacer una segunda llamada para la última medición.

Sí. Usa GET /api/v2/buoys/{buoy_id}/readings para histórico paginado, /readings/search para encontrar la lectura más cercana a una hora objetivo, y /readings/chart para series listas para gráficos.

Usa bounds para una bounding box, near más radius para un filtrado radial, o /api/v2/buoys/nearest con lat/lng para resolver la boya activa más cercana. El endpoint de lista también soporta filtro por país.

Los endpoints de boyas documentados usan una envoltura JSON consistente con status, data y meta. La paginación y los timestamps viven en meta, y las respuestas autenticadas también exponen cabeceras X-RateLimit-*.

Sí. La documentación oficial vive en docs.labouee.app con quickstart, guía de autenticación, guías de uso y una referencia publicada para los endpoints de boyas.

La cuota por defecto es de 1.000 peticiones por hora. Las respuestas exponen X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset, y las 429 incluyen retry_after cuando se supera la cuota.

Empieza con la documentación pública, prueba search o nearest si todavía no tienes credenciales, y luego solicita acceso API cuando estés listo para llamar a los endpoints autenticados.

Docs publicadas - claves por invitación

Obtener acceso API

La documentación es pública. Solicita credenciales cuando estés listo para llamar a endpoints autenticados más allá de la búsqueda pública y la boya más cercana.

The Buoy API - Datos de boyas en tiempo real para desarrolladores | La Boya | La Bouée