Documento OpenAPI
Descripción OpenAPI 3.0 de la API pública, generada a partir del catálogo y de las tablas de campos inferidas de respuestas reales.
/api/meta/openapiSolicitud
Este endpoint no admite parámetros.
Solicitud de ejemplo
curl -s "https://www.coinboss.com/api/meta/openapi"Campos de la respuesta
La tabla de campos se genera a partir de respuestas reales, por lo que recoge exactamente lo que devuelve el endpoint. Las rutas usan a[] para los elementos de un array y {*} para los objetos cuya clave es un nombre dinámico, como una moneda o un exchange.
| Campo | Tipo | Unidad | Descripción |
|---|---|---|---|
| openapi | string | — | Versión de la especificación OpenAPI de este documento. |
| info | object | — | Título, versión y descripción de la API. |
| info.title | string | — | Título de la API. |
| info.version | string | — | Versión de la API. |
| info.description | string | — | Descripción breve de la API y de sus convenciones. |
| servers | array | — | URL base de la API. |
| servers[] | object | — | Una entrada de servidor. |
| servers[].url | string | — | URL base que debe anteponerse a cada ruta. |
| tags | array | — | Categorías de endpoints. |
| tags[] | object | — | Una categoría. |
| tags[].name | string | — | Nombre. |
| tags[].description | string | — | Descripción de la categoría. |
| paths | object | — | Endpoints, con la ruta como clave. claves dinámicas: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list |
| paths.{*} | object | — | Operaciones disponibles en una ruta. |
| paths.{*}.get | object | — | La operación GET. |
| paths.{*}.get.operationId | string | — | Id del endpoint, el mismo id que en el catálogo. |
| paths.{*}.get.summary | string | — | Bloque de resumen. |
| paths.{*}.get.description | string | — | Lo que devuelve el endpoint, con notas sobre cobertura y límites. |
| paths.{*}.get.tags | array | — | Categorías del endpoint. |
| paths.{*}.get.tags[] | string | — | Id de la categoría. |
| paths.{*}.get.x-declared-status | string | — | Disponibilidad declarada: `available`, `partial` o `unavailable`. |
| paths.{*}.get.x-cache-ttl-seconds | number | s | Duración de la caché del lado del servidor para el endpoint. puede faltar |
| paths.{*}.get.parameters | array | — | Parámetros de la solicitud. vacío en las muestras usadas para generar esta tabla |
| paths.{*}.get.parameters[] | object | — | Un parámetro. |
| paths.{*}.get.parameters[].name | string | — | Nombre. |
| paths.{*}.get.parameters[].in | string | — | Dónde va el parámetro: `query` o `path`. |
| paths.{*}.get.parameters[].required | boolean | — | `true` cuando el parámetro debe enviarse. |
| paths.{*}.get.parameters[].description | string | — | Significado del parámetro. |
| paths.{*}.get.parameters[].schema | object | — | JSON Schema del valor del parámetro (type, default, enum, minimum, maximum). |
| paths.{*}.get.parameters[].example | string | — | Valor de ejemplo. puede faltar |
| paths.{*}.get.responses | object | — | Respuestas con el estado HTTP como clave; la respuesta 200 contiene el JSON Schema generado a partir de respuestas reales. |
| components | object | — | Esquemas compartidos, incluido el cuerpo de error que utilizan todos los endpoints. |
Generada 2026-11-11 23:03 UTC a partir de 1 respuestas reales.
Respuesta de ejemplo
/api/meta/openapi · Respuesta real capturada 2026-11-13 03:59:28 UTC. Los arrays y mapas largos se abrevian para su visualización: tags tenía 21 elementos; paths tenía 298 elementos; paths.{*}.get.responses tenía 5 elementos; paths.{*}.get.parameters tenía 3 elementos; components.schemas.Error.properties.code.enum tenía 9 elementos.
- "openapi""3.0.3"
- "info"
- "title""CoinBoss API"
- "version""v1 (2026.11.12)"
- "description""Public market-data API of CoinBoss. Generated from the endpoint catalog and from field tables inferred from real responses."
- "servers"
- "tags"
- "paths"
- "/api/coin-heatmap"
- "/api/coins/all"
- "components"
- "schemas"
- "securitySchemes"
Detalles
- Autenticación
- Ninguna. Endpoint público.
- Límite de solicitudes
- 1200 solicitudes por minuto por IP
- Caché del servidor
- 5m
- Microcaché de borde
- 10s
- Marcas de tiempo
- Milisegundos de época Unix (UTC), salvo que la descripción del campo indique otra cosa
- Formato de respuesta
- json
- Estabilidad
- Estable
- Disponible desde
- 2026-11-11
Estado en vivo
Disponibilidad, últimos 30 días
100% de 408 comprobaciones superadas
Errores
Las llamadas fallidas tienen la misma estructura en todos los endpoints. La lista completa está en la página de errores. Errores y límites de solicitudes →
| Código | HTTP | Significado | Qué hacer |
|---|---|---|---|
| INVALID_PARAM | 400 | Falta un parámetro obligatorio o un valor no se acepta. `param` indica el nombre del parámetro cuando se conoce. | No reintente sin cambios; corrija la solicitud. |
| UNAUTHORIZED | 401 | Se envió la cabecera `CB-API-KEY`, pero la clave es desconocida o está revocada. Los datos públicos no necesitan clave: elimine la cabecera o use una clave válida. | No reintente sin cambios. |
| FORBIDDEN | 403 | La ruta no forma parte de la API pública (interna o solo para cuentas). | No reintente. |
| NOT_FOUND | 404 | Ruta desconocida, o la moneda / el exchange / el fondo solicitado no existe. | No reintente; compruebe la ruta y los identificadores en el catálogo. |
| RATE_LIMITED | 429 | Más solicitudes que el límite por minuto. `Retry-After` indica los segundos de espera. | Espere el tiempo de `Retry-After` y después reintente con espera progresiva. |
| INTERNAL | 500 | Error inesperado del servidor. El mensaje es genérico por diseño; cite `request_id` al informar del error. | Reintente una vez tras unos segundos; si persiste, infórmelo con el ID de solicitud. |
| UPSTREAM_FAILED | 503 | La fuente de datos de este endpoint no respondió a tiempo. No se devuelven cifras desactualizadas ni sustitutas en su lugar. | Reintente con espera progresiva; consulte la página de estado. |
| UNAVAILABLE | 501 / 503 | El conjunto de datos no está listo temporalmente (calentamiento de la caché) o el endpoint aún no tiene una fuente pública lícita. | Reintente más tarde; el catálogo marca los endpoints que no están disponibles por diseño. |
| REQUEST_FAILED | 200 | Algunos endpoints antiguos responden HTTP 200 con `success: false`. Compruebe siempre `success`, no solo el estado HTTP. | Depende del mensaje; trátelo como una solicitud fallida. |
Pruébelo
/api/meta/openapiDisponibleSin parámetros.
https://www.coinboss.com/api/meta/openapiMás en esta categoría
- Matriz de calidad de datos (vista del recolector) /api/sd/quality
- Catálogo de la API /api/meta/catalog
- Registro de cambios y política de versionado /api/meta/changelog
- Documentación de un endpoint /api/meta/endpoint
- Documento OpenAPI /api/meta/openapi
- Matriz de calidad de datos /api/meta/quality
- Estado del servicio /api/meta/status
- Comprueba si la plataforma conoce un símbolo de moneda /api/coin-exists
- Mapa de símbolo de moneda a ruta del icono alojado localmente /api/coin-icons
- Resumen agregado de la página de moneda /api/content/coin
- Resumen de secciones de todo el sitio /api/content/summary
- Tabla de tipos de cambio fiat /api/currency/fx
- Mapa de id de exchange a ruta del icono alojado localmente /api/exchange-icons
- Comprobación de actividad /api/health
- Estadísticas de la página de investigación /api/research/stats