Volumen 24h—Interés abierto—Liquidaciones 24h$1.36BLargo/Corto 24h—Dominancia BTC—Dominancia ETH—
App
Idioma ▾
€ EUR ▾
/api/meta/endpoint
GETDisponibleFRESH

Documentación de un endpoint

Documentación completa de un endpoint: parámetros, tabla de campos generada a partir de respuestas reales, una respuesta de ejemplo capturada, muestras verificadas, historial de la sonda de 30 días, errores y límites.

GET/api/meta/endpoint

Solicitud

Parámetros de consulta

NombreTipoObligatorioValor por defectoValores admitidosDescripción
idstringObligatorio——Id del endpoint en el catálogo (por ejemplo `sd-oi`). Los ids desconocidos devuelven 404. Ejemplo: sd-oi

Solicitud de ejemplo

curl -s "https://www.coinboss.com/api/meta/endpoint?id=sd-oi"

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.

CampoTipoUnidadDescripción
successboolean—true cuando la solicitud se completó correctamente. En caso de fallo, el cuerpo es `{ success: false, code, error, request_id }`.
schemastring—Id del esquema de esta respuesta (`coinboss.meta.endpoint/1`).
nownumbermsHora del servidor en el momento de generar la respuesta.
endpointobject—Registro del endpoint en el catálogo. Las claves del mapa son nombres de atributos como `id`, `path`, `status`, `params`, `category`, `sources`, `units`, `formula`. claves dinámicas: id,cat,kind,method,path,title
endpoint.{*}array|number|object|string|null—Valor de un atributo: texto, un número, una lista (`params`, `required`, `ts_fields`) o un objeto (`probe`, `category`, `example_query`); null cuando no está definido.
endpoint.{*}[]object|string—Elemento de un atributo de tipo lista: una definición de parámetro en `params`, o un nombre en `required` / `ts_fields`. puede faltar
endpoint.{*}[].namestring—Nombre. puede faltar
endpoint.{*}[].instring—Dónde se envía el parámetro: `query` o `path`. puede faltar
endpoint.{*}[].typestring—Tipo. puede faltar
endpoint.{*}[].requiredboolean—true cuando el parámetro debe enviarse. puede faltar
endpoint.{*}[].defaultnull—Valor utilizado cuando se omite el parámetro; null cuando no hay valor predeterminado. puede faltar
endpoint.{*}[].enumnull—Lista de valores aceptados; null cuando el parámetro no está restringido a una lista. puede faltar
endpoint.{*}[].minnull—Mínimo. puede faltar
endpoint.{*}[].maxnull—Máximo. puede faltar
endpoint.{*}[].examplestring—Valor de ejemplo del parámetro; null cuando no se indica ninguno. puede faltar
endpoint.{*}[].descstring—Descripción del parámetro. puede faltar
endpoint.{*}.checked_atnumbermsMarca de tiempo. puede faltar
endpoint.{*}.httpnumber—Estado HTTP de la solicitud de sonda más reciente. puede faltar
endpoint.{*}.okboolean—`true` cuando la solicitud de sonda más reciente devolvió HTTP 200 con un cuerpo JSON válido. puede faltar
endpoint.{*}.schema_okboolean—`true` cuando la respuesta sondeada coincidió con la tabla de campos documentada; `null` cuando no existe ninguna tabla de campos. puede faltar
endpoint.{*}.latency_msnumbermsTiempo de respuesta de la solicitud de sonda más reciente. puede faltar
endpoint.{*}.bytesnumberbytesTamaño del cuerpo de la respuesta sondeada. puede faltar
endpoint.{*}.qualitynull—`meta.quality` indicado por la respuesta sondeada (FRESH / PARTIAL / STALE …); `null` cuando el endpoint no lo indica. puede faltar
endpoint.{*}.data_age_snumber|nullsSegundos transcurridos desde el evento. puede faltar
endpoint.{*}.last_ok_atnumbermsMarca de tiempo. puede faltar
endpoint.{*}.fail_streaknumbercountNúmero de sondeos fallidos consecutivos; 0 cuando el último sondeo tuvo éxito. puede faltar
endpoint.{*}.idstring—Identificador. puede faltar
endpoint.{*}.titlestring—Título para mostrar de la categoría del endpoint (dentro de `category`). puede faltar
endpoint.{*}.coinstring—Símbolo de la moneda, en mayúsculas (por ejemplo BTC). puede faltar
fieldsarray—Tabla de campos de la respuesta, inferida a partir de respuestas reales; null cuando no se ha generado ninguna tabla.
fields[]object—Un campo de la respuesta: `path`, `type`, `unit`, `desc` e indicadores.
fields[].pathstring—Ruta del campo en la respuesta: `a.b` para el anidamiento, `[]` para los elementos de un array, `{*}` para los valores de un mapa.
fields[].typestring—Tipo.
fields[].unitstring|null—Unidad de los valores de este objeto.
fields[].descstring—Descripción del campo; null cuando no se ha escrito ninguna.
fields[].optionalboolean—Presente y true cuando el campo faltaba en al menos una respuesta muestreada. puede faltar
fields[].mapboolean—Presente y true cuando el objeto es un mapa con claves que dependen de los datos (monedas, exchanges, fechas) en lugar de campos fijos. puede faltar
fields[].keysarray—Muestra de las claves observadas en el mapa; solo en los campos con `map` true. puede faltar
fields[].keys[]string—Una clave de muestra. puede faltar
fields_generated_atnumbermsMarca de tiempo.
fields_generated_fromarray—URL de solicitud a partir de cuyas respuestas reales se infirió la tabla de campos; null cuando no hay tabla.
fields_generated_from[]string—Una ruta de solicitud muestreada con su cadena de consulta.
exampleobject—Última respuesta real correcta capturada por la sonda: `request`, `captured_at`, `truncated` (longitudes originales de los arrays acortados) y `body`; null cuando no hay ninguna.
example.requeststring—Solicitud que produjo el ejemplo capturado (ruta y cadena de consulta).
example.captured_atnumbermsMarca de tiempo.
example.truncatedobject—Lo que se acortó en el ejemplo capturado: para cada array o mapa, el número de elementos omitidos. Sus claves dependen del endpoint documentado.
example.bodyobject—Respuesta capturada del endpoint documentado, acortada. Su estructura es la descrita por `fields`.
verified_samplesobject|null—Resultados de las solicitudes de muestra adicionales de la sonda (`at`, `samples` con la consulta, el estado HTTP, la latencia y la comprobación del esquema); null cuando no se ejecutó ninguna.
verified_samples.atnumbermsHora en que se comprobaron por última vez las muestras adicionales.
verified_samples.samplesarray—Número de muestras.
verified_samples.samples[]object—Número de muestras.
verified_samples.samples[].queryobject—Parámetros de consulta de la solicitud de muestra.
verified_samples.samples[].query.coinstring—Símbolo de la moneda, en mayúsculas (por ejemplo BTC). puede faltar
verified_samples.samples[].httpnumber—Estado HTTP devuelto.
verified_samples.samples[].okboolean—`true` cuando la muestra devolvió lo esperado (HTTP 200 con JSON válido, o el estado de error esperado).
verified_samples.samples[].latency_msnumbermsTiempo de respuesta de la solicitud de muestra.
verified_samples.samples[].schema_okboolean|null—`true` cuando la respuesta de muestra coincidió con la tabla de campos documentada; `null` cuando no se comprobó.
verified_samples.samples[].qualitynull—`meta.quality` indicado por la respuesta de muestra; `null` cuando no se indica.
verified_samples.samples[].notestring|null—Nota.
probe_detailnull—Diferencias de esquema encontradas por el último sondeo: rutas de campos `missing`, `mismatched` y `undocumented`; null cuando no hay ninguna.
uptime_30dobject—Comprobaciones de la sonda sobre este endpoint en los últimos 30 días: totales, porcentaje de éxito y un desglose por día.
uptime_30d.checksnumbercountNúmero de comprobaciones de la sonda sobre el endpoint en los últimos 30 días (menos días cuando el seguimiento empezó más tarde).
uptime_30d.oknumbercountNúmero de esas comprobaciones que tuvieron éxito.
uptime_30d.pctnumber%Porcentaje.
uptime_30d.daysarray—Valores diarios o número de días.
uptime_30d.days[]object—Valores diarios o número de días.
uptime_30d.days[].daystring—Día de calendario (UTC).
uptime_30d.days[].checksnumbercountNúmero de solicitudes de sonda ese día.
uptime_30d.days[].oknumbercountNúmero de solicitudes de sonda correctas ese día.
uptime_30d.days[].pctnumber%Porcentaje.
uptime_30d.days[].avg_msnumbermsTiempo medio de respuesta ese día; `null` si no hubo comprobaciones.
uptime_30d.days[].max_msnumbermsRespuesta más lenta ese día.
errorsarray—Códigos de error que puede devolver la API, cada uno con su estado HTTP, su significado y una recomendación de reintento.
errors[]object—Un código de error.
errors[].codestring—Código.
errors[].httpnumber|string—Estado HTTP enviado con este código; una cadena como `501 / 503` cuando corresponde más de uno.
errors[].meaningstring—Qué significa el error.
errors[].retrystring—Recomendación sobre si conviene reintentar y cómo hacerlo.
errors[].legacyboolean—Presente y true solo en el código utilizado por los endpoints antiguos que responden HTTP 200 con `success: false`. puede faltar
rate_limitobject—Reglas del límite de solicitudes de la API pública.
rate_limit.window_snumbersDuración de la ventana de recuento (60).
rate_limit.anonymous_per_minnumbercountSolicitudes por minuto permitidas por IP de cliente cuando no se envía ninguna clave de API.
rate_limit.scopestring—Texto que indica cómo se cuentan las solicitudes: por IP de cliente cuando son anónimas, por clave cuando se envía una cabecera `CB-API-KEY`.
rate_limit.key_tiers_per_minobject—Solicitudes por minuto permitidas para cada nivel de clave de API, con el nombre del nivel como clave.
rate_limit.key_tiers_per_min.hobbyistnumbercountSolicitudes por minuto para las claves del nivel `hobbyist`.
rate_limit.key_tiers_per_min.startupnumbercountSolicitudes por minuto para las claves del nivel `startup`.
rate_limit.key_tiers_per_min.standardnumbercountSolicitudes por minuto para las claves del nivel `standard`.
rate_limit.key_tiers_per_min.professionalnumbercountSolicitudes por minuto para las claves del nivel `professional`.
rate_limit.exemptarray—Patrones de ruta que no se cuentan para el límite.
rate_limit.exempt[]string—Un patrón de ruta exento, por ejemplo `/api/coin-icon/*`.
rate_limit.headersarray—Nombres de las cabeceras de respuesta que informan del estado del límite de solicitudes.
rate_limit.headers[]string—Un nombre de cabecera, por ejemplo `X-RateLimit-Remaining`.
rate_limit.on_exceedobject—Lo que se devuelve cuando se supera el límite: estado `http` y `code` de error.
rate_limit.on_exceed.httpnumber—Estado HTTP devuelto cuando se supera el límite (429).
rate_limit.on_exceed.codestring—Código.
relatedarray—Todos los endpoints de la misma categoría, incluido este.
related[]object—Un endpoint: `id`, `path` y `title`.
related[].idstring—Identificador.
related[].pathstring—Ruta de solicitud del endpoint.
related[].titlestring—Título breve para mostrar del endpoint.
probeobject—Estado de la sonda de endpoints en la que se basan los estados en vivo: hora de la última ejecución, su antigüedad, el intervalo y si es fresca.
probe.last_run_atnumbermsMarca de tiempo.
probe.age_snumbersSegundos transcurridos desde la última actualización de esta fila.
probe.interval_snumbersIntervalo previsto entre dos ejecuciones de la sonda (300).
probe.freshboolean—true cuando la última ejecución de la sonda tiene menos de 20 minutos; cuando es false, los estados de los endpoints se notifican como `unknown`.
probe.errornull—Mensaje de error (presente solo en caso de fallo).
metaobject—Envoltorio de esta respuesta: id del esquema, sistema que la produce, marcas de tiempo, duración de la caché y frescura.
meta.schemastring—Id del esquema de esta respuesta; el mismo valor que el `schema` de nivel superior.
meta.sourcearray—De dónde procede el valor.
meta.source[]object—De dónde procede el valor.
meta.source[].systemstring—Sistema que produjo los datos; siempre `coinboss` en los endpoints del centro de desarrolladores.
meta.source[].componentstring—Componente del que proceden los datos: la sonda de endpoints y la patrulla de calidad de datos.
meta.observed_atnull—Marca de tiempo.
meta.received_atnumbermsMarca de tiempo.
meta.fetched_atnumbermsCuándo obtuvo CoinBoss los datos de la fuente.
meta.windowstring—Ventana.
meta.cache_ttl_snumbersDuración de la caché del lado del servidor para esta respuesta.
meta.qualitystring—`FRESH` cuando este endpoint se sondeó en los últimos 20 minutos; en caso contrario, `STALE`.
meta.is_staleboolean—true cuando la fila es más antigua que la ventana de frescura; las filas desactualizadas no se usan en los totales.
meta.fallbackstring—Nota en texto plano sobre lo que devuelve este endpoint cuando sus datos de entrada están desactualizados o faltan.

Generada 2026-11-11 23:03 UTC a partir de 3 respuestas reales.

Respuesta de ejemplo

/api/meta/endpoint?id=sd-oi · Respuesta real capturada 2026-11-13 03:59:28 UTC. Los arrays y mapas largos se abrevian para su visualización: errors tenía 9 elementos; fields tenía 103 elementos; related tenía 6 elementos; endpoint tenía 35 elementos; uptime_30d.days tenía 3 elementos; verified_samples.samples tenía 4 elementos.

  • {
    • "success": true,
    • "schema": "coinboss.meta.endpoint/1",
    • "now": 1794542368241,
    • "endpoint": {
      • "id": "sd-oi",
      • "cat": "open-interest"
      },
    • "fields": [
      • { … 4 },
      • { … 4 }
      ],
    • "fields_generated_at": 1794438008862,
    • "fields_generated_from": [
      • "/api/sd/oi?coin=BTC",
      • "/api/sd/oi?coin=ETH",
      • "/api/sd/oi?coin=SOL",
      • "/api/sd/oi?coin=ARKM"
      ],
    • "example": {
      • "request": "/api/sd/oi?coin=BTC",
      • "captured_at": 1794542259642,
      • "truncated": { … 4 },
      • "body": { … 17 }
      },
    • "verified_samples": {
      • "at": 1794542259642,
      • "samples": [ … 2 ]
      },
    • "probe_detail": {
      • "missing": [],
      • "mismatched": [],
      • "undocumented": [ … 6 ]
      },
    • "uptime_30d": {
      • "checks": 411,
      • "ok": 411,
      • "pct": 100,
      • "days": [ … 2 ]
      },
    • "errors": [
      • { … 4 },
      • { … 4 }
      ],
    • "rate_limit": {
      • "window_s": 60,
      • "anonymous_per_min": 1200,
      • "scope": "per client IP for anonymous requests; per key when a CB-API-KEY header is sent",
      • "key_tiers_per_min": { … 4 },
      • "exempt": [ … 1 ],
      • "headers": [ … 4 ],
      • "on_exceed": { … 2 }
      },
    • "related": [
      • { … 3 },
      • { … 3 }
      ],
    • "probe": {
      • "last_run_at": 1794542029183,
      • "age_s": 339,
      • "interval_s": 300,
      • "fresh": true,
      • "error": null
      },
    • "meta": {
      • "schema": "coinboss.meta.endpoint/1",
      • "source": [ … 1 ],
      • "observed_at": null,
      • "received_at": 1794542259642,
      • "fetched_at": 1794542368241,
      • "window": "latest",
      • "cache_ttl_s": 30,
      • "quality": "FRESH",
      • "is_stale": false,
      • "fallback": "field table comes from the last schema generation; example is the last successful real response"
      }
    }

Muestras verificadas

Además del ejemplo anterior, la sonda llama a este endpoint con estos parámetros y comprueba el esquema en cada ocasión.

ParámetrosHTTPLatenciaResultado
id=sd-funding2002 msCorrecto FRESH
id=liquidations-overview2002 msCorrecto FRESH
—4002 msCorrecto devuelve el error esperado

Comprobado 2026-11-13 03:29:26 UTC

Detalles

Autenticación
Ninguna. Endpoint público.
Límite de solicitudes
1200 solicitudes por minuto por IP
Caché del servidor
30s
Microcaché de borde
10s
Fuentes de datos
Catálogo de endpoints de CoinBoss, esquemas generados por la sonda de la API, sd_api_probe.
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

DisponibleComprobado 2026-11-13 03:53:45 UTCHTTP 2004 msEl esquema coincideAntigüedad del dato más reciente: 71s

Disponibilidad, últimos 30 días

99.75% de 408 comprobaciones superadas

Desviación del esquema detectada por la última sonda
  • Devuelto pero no documentado: probe_detail.missing, probe_detail.mismatched, probe_detail.undocumented, probe_detail.undocumented[]

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ódigoHTTPSignificadoQué hacer
INVALID_PARAM400Falta 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.
UNAUTHORIZED401Se 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.
FORBIDDEN403La ruta no forma parte de la API pública (interna o solo para cuentas).No reintente.
NOT_FOUND404Ruta desconocida, o la moneda / el exchange / el fondo solicitado no existe.No reintente; compruebe la ruta y los identificadores en el catálogo.
RATE_LIMITED429Má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.
INTERNAL500Error 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_FAILED503La 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.
UNAVAILABLE501 / 503El 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_FAILED200Algunos 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

GET/api/meta/endpointDisponible
Parámetros

string — Endpoint id from the catalog (for example `sd-oi`). Unknown ids return 404.

URL de la solicitudhttps://www.coinboss.com/api/meta/endpoint?id=sd-oi
Elija un endpoint y pulse «Enviar solicitud». Aquí aparecerán la respuesta, las cabeceras y los tiempos.