Volume 24h—Contratos em aberto—Liquidações 24h$1.36BLong/Short 24h—Dominância BTC—Dominância ETH—
App
Idioma ▾
R$ BRL ▾
/api/meta/endpoint
GETDisponívelFRESH

Documentação do endpoint

Documentação completa de um endpoint: parâmetros, tabela de campos gerada a partir de respostas reais, um exemplo de resposta capturado, amostras verificadas, histórico de sondagens de 30 dias, erros e limites.

GET/api/meta/endpoint

Requisição

Parâmetros de consulta

NomeTipoObrigatórioPadrãoValores aceitosDescrição
idstringObrigatório——ID do endpoint no catálogo (por exemplo, `sd-oi`). IDs desconhecidos retornam 404. Exemplo: sd-oi

Exemplo de requisição

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

Campos da resposta

A tabela de campos é gerada a partir de respostas reais, portanto lista exatamente o que o endpoint retorna. Os caminhos usam a[] para itens de array e {*} para objetos indexados por um nome dinâmico, como uma moeda ou uma corretora.

CampoTipoUnidadeDescrição
successboolean—true quando a requisição foi bem-sucedida. Em caso de falha, o corpo é `{ success: false, code, error, request_id }`.
schemastring—ID do esquema desta resposta (`coinboss.meta.endpoint/1`).
nownumbermsHorário do servidor em que a resposta foi montada.
endpointobject—Registro do endpoint no catálogo. As chaves do mapa são nomes de atributos como `id`, `path`, `status`, `params`, `category`, `sources`, `units`, `formula`. chaves dinâmicas: id,cat,kind,method,path,title
endpoint.{*}array|number|object|string|null—Valor de um atributo: texto, um número, uma lista (`params`, `required`, `ts_fields`) ou um objeto (`probe`, `category`, `example_query`); null quando não definido.
endpoint.{*}[]object|string—Elemento de um atributo de lista: uma definição de parâmetro em `params`, ou um nome em `required` / `ts_fields`. pode estar ausente
endpoint.{*}[].namestring—Nome. pode estar ausente
endpoint.{*}[].instring—Onde o parâmetro é enviado: `query` ou `path`. pode estar ausente
endpoint.{*}[].typestring—Tipo. pode estar ausente
endpoint.{*}[].requiredboolean—true quando o parâmetro precisa ser enviado. pode estar ausente
endpoint.{*}[].defaultnull—Valor usado quando o parâmetro é omitido; null quando não há padrão. pode estar ausente
endpoint.{*}[].enumnull—Lista de valores aceitos; null quando o parâmetro não está restrito a uma lista. pode estar ausente
endpoint.{*}[].minnull—Mínimo. pode estar ausente
endpoint.{*}[].maxnull—Máximo. pode estar ausente
endpoint.{*}[].examplestring—Valor de exemplo do parâmetro; null quando nenhum é fornecido. pode estar ausente
endpoint.{*}[].descstring—Descrição do parâmetro. pode estar ausente
endpoint.{*}.checked_atnumbermsTimestamp. pode estar ausente
endpoint.{*}.httpnumber—Status HTTP da requisição de sondagem mais recente. pode estar ausente
endpoint.{*}.okboolean—`true` quando a requisição de sondagem mais recente retornou HTTP 200 com um corpo JSON válido. pode estar ausente
endpoint.{*}.schema_okboolean—`true` quando a resposta sondada correspondeu à tabela de campos documentada; `null` quando não existe tabela de campos. pode estar ausente
endpoint.{*}.latency_msnumbermsTempo de resposta da requisição de sondagem mais recente. pode estar ausente
endpoint.{*}.bytesnumberbytesTamanho do corpo da resposta sondada. pode estar ausente
endpoint.{*}.qualitynull—`meta.quality` reportado pela resposta sondada (FRESH / PARTIAL / STALE …); `null` quando o endpoint não o reporta. pode estar ausente
endpoint.{*}.data_age_snumber|nullsSegundos desde o evento. pode estar ausente
endpoint.{*}.last_ok_atnumbermsTimestamp. pode estar ausente
endpoint.{*}.fail_streaknumbercountNúmero de sondagens com falha consecutivas; 0 quando a última sondagem teve sucesso. pode estar ausente
endpoint.{*}.idstring—Identificador. pode estar ausente
endpoint.{*}.titlestring—Título de exibição da categoria do endpoint (dentro de `category`). pode estar ausente
endpoint.{*}.coinstring—Símbolo da moeda, em maiúsculas (por exemplo, BTC). pode estar ausente
fieldsarray—Tabela de campos da resposta, inferida de respostas reais; null quando nenhuma tabela foi gerada.
fields[]object—Um campo da resposta: `path`, `type`, `unit`, `desc` e flags.
fields[].pathstring—Caminho do campo na resposta: `a.b` para aninhamento, `[]` para itens de array, `{*}` para os valores de um mapa.
fields[].typestring—Tipo.
fields[].unitstring|null—Unidade dos valores deste objeto.
fields[].descstring—Descrição do campo; null quando nenhuma foi escrita.
fields[].optionalboolean—Presente e true quando o campo estava ausente em pelo menos uma resposta amostrada. pode estar ausente
fields[].mapboolean—Presente e true quando o objeto é um mapa com chaves que dependem dos dados (moedas, corretoras, datas), e não com campos fixos. pode estar ausente
fields[].keysarray—Amostra de chaves observadas no mapa; somente em campos com `map` true. pode estar ausente
fields[].keys[]string—Uma chave de amostra. pode estar ausente
fields_generated_atnumbermsTimestamp.
fields_generated_fromarray—URLs de requisição de cujas respostas reais a tabela de campos foi inferida; null quando não há tabela.
fields_generated_from[]string—Um caminho de requisição amostrado, com query string.
exampleobject—Última resposta real bem-sucedida capturada pela sonda: `request`, `captured_at`, `truncated` (tamanhos originais dos arrays encurtados) e `body`; null quando não há nenhuma.
example.requeststring—Requisição que produziu o exemplo capturado (caminho e query string).
example.captured_atnumbermsTimestamp.
example.truncatedobject—O que foi encurtado no exemplo capturado: para cada array ou mapa, o número de itens deixados de fora. Suas chaves dependem do endpoint documentado.
example.bodyobject—Resposta capturada do endpoint documentado, encurtada. Sua estrutura é a descrita por `fields`.
verified_samplesobject|null—Resultados das requisições de amostra adicionais da sonda (`at`, `samples` com query, status HTTP, latência, verificação de esquema); null quando nenhuma foi executada.
verified_samples.atnumbermsHorário em que as amostras adicionais foram verificadas pela última vez.
verified_samples.samplesarray—Número de amostras.
verified_samples.samples[]object—Número de amostras.
verified_samples.samples[].queryobject—Parâmetros de query da requisição de amostra.
verified_samples.samples[].query.coinstring—Símbolo da moeda, em maiúsculas (por exemplo, BTC). pode estar ausente
verified_samples.samples[].httpnumber—Status HTTP retornado.
verified_samples.samples[].okboolean—`true` quando a amostra retornou o que era esperado (HTTP 200 com JSON válido, ou o status de erro esperado).
verified_samples.samples[].latency_msnumbermsTempo de resposta da requisição de amostra.
verified_samples.samples[].schema_okboolean|null—`true` quando a resposta da amostra correspondeu à tabela de campos documentada; `null` quando não verificada.
verified_samples.samples[].qualitynull—`meta.quality` reportado pela resposta da amostra; `null` quando não reportado.
verified_samples.samples[].notestring|null—Observação.
probe_detailnull—Diferenças de esquema encontradas pela última sondagem: caminhos de campos `missing`, `mismatched` e `undocumented`; null quando não há nenhuma.
uptime_30dobject—Verificações de sondagem deste endpoint nos últimos 30 dias: totais, percentual de sucesso e um detalhamento por dia.
uptime_30d.checksnumbercountNúmero de verificações de sondagem do endpoint nos últimos 30 dias (menos dias quando o acompanhamento começou depois).
uptime_30d.oknumbercountNúmero dessas verificações que tiveram sucesso.
uptime_30d.pctnumber%Percentual.
uptime_30d.daysarray—Valores diários ou número de dias.
uptime_30d.days[]object—Valores diários ou número de dias.
uptime_30d.days[].daystring—Dia de calendário (UTC).
uptime_30d.days[].checksnumbercountNúmero de requisições de sondagem nesse dia.
uptime_30d.days[].oknumbercountNúmero de requisições de sondagem bem-sucedidas nesse dia.
uptime_30d.days[].pctnumber%Percentual.
uptime_30d.days[].avg_msnumbermsTempo médio de resposta nesse dia; `null` sem verificações.
uptime_30d.days[].max_msnumbermsResposta mais lenta nesse dia.
errorsarray—Códigos de erro que a API pode retornar, cada um com status HTTP, significado e orientação de nova tentativa.
errors[]object—Um código de erro.
errors[].codestring—Código.
errors[].httpnumber|string—Status HTTP enviado com este código; uma string como `501 / 503` quando mais de um se aplica.
errors[].meaningstring—O que o erro significa.
errors[].retrystring—Orientação sobre se e como tentar novamente.
errors[].legacyboolean—Presente e true somente no código usado pelos endpoints mais antigos que respondem HTTP 200 com `success: false`. pode estar ausente
rate_limitobject—Regras de limite de requisições da API pública.
rate_limit.window_snumbersDuração da janela de contagem (60).
rate_limit.anonymous_per_minnumbercountRequisições por minuto permitidas por IP de cliente quando nenhuma chave de API é enviada.
rate_limit.scopestring—Texto que informa como as requisições são contadas: por IP de cliente quando anônimas, por chave quando um cabeçalho `CB-API-KEY` é enviado.
rate_limit.key_tiers_per_minobject—Requisições por minuto permitidas para cada nível de chave de API, indexadas pelo nome do nível.
rate_limit.key_tiers_per_min.hobbyistnumbercountRequisições por minuto para chaves do nível `hobbyist`.
rate_limit.key_tiers_per_min.startupnumbercountRequisições por minuto para chaves do nível `startup`.
rate_limit.key_tiers_per_min.standardnumbercountRequisições por minuto para chaves do nível `standard`.
rate_limit.key_tiers_per_min.professionalnumbercountRequisições por minuto para chaves do nível `professional`.
rate_limit.exemptarray—Padrões de caminho que não são contados no limite.
rate_limit.exempt[]string—Um padrão de caminho isento, por exemplo, `/api/coin-icon/*`.
rate_limit.headersarray—Nomes dos cabeçalhos de resposta que informam o estado do limite de requisições.
rate_limit.headers[]string—Um nome de cabeçalho, por exemplo, `X-RateLimit-Remaining`.
rate_limit.on_exceedobject—O que é retornado quando o limite é excedido: status `http` e `code` de erro.
rate_limit.on_exceed.httpnumber—Status HTTP retornado quando o limite é excedido (429).
rate_limit.on_exceed.codestring—Código.
relatedarray—Todos os endpoints da mesma categoria, incluído este.
related[]object—Um endpoint: `id`, `path` e `title`.
related[].idstring—Identificador.
related[].pathstring—Caminho de requisição do endpoint.
related[].titlestring—Título curto de exibição do endpoint.
probeobject—Estado da sonda de endpoints por trás dos status ao vivo: horário da última execução, sua idade, o intervalo e se ela está atualizada.
probe.last_run_atnumbermsTimestamp.
probe.age_snumbersSegundos desde a última atualização desta linha.
probe.interval_snumbersIntervalo planejado entre duas execuções da sonda (300).
probe.freshboolean—true quando a última execução da sonda tem menos de 20 minutos; quando false, os status dos endpoints são reportados como `unknown`.
probe.errornull—Mensagem de erro (presente apenas em caso de falha).
metaobject—Envelope desta resposta: ID do esquema, sistema produtor, timestamps, tempo de vida do cache e atualidade.
meta.schemastring—ID do esquema desta resposta; mesmo valor do `schema` de nível superior.
meta.sourcearray—De onde vem o valor.
meta.source[]object—De onde vem o valor.
meta.source[].systemstring—Sistema que produziu os dados; sempre `coinboss` nos endpoints do centro de desenvolvedores.
meta.source[].componentstring—Componente por trás dos dados: a sonda de endpoints e a ronda de qualidade dos dados.
meta.observed_atnull—Timestamp.
meta.received_atnumbermsTimestamp.
meta.fetched_atnumbermsQuando a CoinBoss obteve os dados da fonte.
meta.windowstring—Janela.
meta.cache_ttl_snumbersTempo de vida do cache do servidor para esta resposta.
meta.qualitystring—`FRESH` quando este endpoint foi sondado nos últimos 20 minutos; caso contrário, `STALE`.
meta.is_staleboolean—true quando a linha é mais antiga que a janela de atualidade; linhas desatualizadas não entram nos totais.
meta.fallbackstring—Nota em texto simples sobre o que este endpoint retorna quando suas entradas estão desatualizadas ou ausentes.

Gerada 2026-11-11 23:03 UTC a partir de 3 respostas reais.

Exemplo de resposta

/api/meta/endpoint?id=sd-oi · Resposta real capturada 2026-11-13 03:53:45 UTC. Arrays e mapas longos são encurtados para exibição: errors tinha 9 itens; fields tinha 103 itens; related tinha 6 itens; endpoint tinha 35 itens; uptime_30d.days tinha 3 itens; verified_samples.samples tinha 4 itens.

  • {
    • "success": true,
    • "schema": "coinboss.meta.endpoint/1",
    • "now": 1794542025825,
    • "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": 1794541954384,
      • "truncated": { … 4 },
      • "body": { … 17 }
      },
    • "verified_samples": {
      • "at": 1794540459506,
      • "samples": [ … 2 ]
      },
    • "probe_detail": {
      • "missing": [],
      • "mismatched": [],
      • "undocumented": [ … 6 ]
      },
    • "uptime_30d": {
      • "checks": 410,
      • "ok": 410,
      • "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": 1794541726312,
      • "age_s": 300,
      • "interval_s": 300,
      • "fresh": true,
      • "error": null
      },
    • "meta": {
      • "schema": "coinboss.meta.endpoint/1",
      • "source": [ … 1 ],
      • "observed_at": null,
      • "received_at": 1794541954384,
      • "fetched_at": 1794542025825,
      • "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"
      }
    }

Amostras verificadas

Além do exemplo acima, a sonda chama este endpoint com estes parâmetros e verifica o esquema a cada vez.

ParâmetrosHTTPLatênciaResultado
id=sd-funding2002 msAprovado FRESH
id=liquidations-overview2002 msAprovado FRESH
—4002 msAprovado retorna o erro esperado

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

Detalhes

Autenticação
Nenhuma. Endpoint público.
Limite de requisições
1200 requisições por minuto por IP
Cache do servidor
30s
Microcache de borda
10s
Fontes de dados
Catálogo de endpoints da CoinBoss, esquemas gerados pela sonda da API, sd_api_probe.
Timestamps
Milissegundos da época Unix (UTC), salvo se a descrição do campo indicar o contrário
Formato da resposta
json
Estabilidade
Estável
Disponível desde
2026-11-11

Status ao vivo

DisponívelVerificado 2026-11-13 03:53:45 UTCHTTP 2004 msEsquema confereDado mais recente: há 71s

Disponibilidade, últimos 30 dias

99.75% de 407 verificações aprovadas

Divergência de esquema detectada pela última sondagem
  • Retornado, mas não documentado: probe_detail.missing, probe_detail.mismatched, probe_detail.undocumented, probe_detail.undocumented[]

Erros

As chamadas com falha têm o mesmo formato em todos os endpoints. A lista completa está na página de erros. Erros e limites de requisições →

CódigoHTTPSignificadoO que fazer
INVALID_PARAM400Falta um parâmetro obrigatório ou um valor não é aceito. `param` indica o nome do parâmetro quando ele é conhecido.Não repita a requisição sem alterações; corrija-a.
UNAUTHORIZED401O cabeçalho `CB-API-KEY` foi enviado, mas a chave é desconhecida ou foi revogada. Dados públicos não exigem chave — remova o cabeçalho ou use uma chave válida.Não repita a requisição sem alterações.
FORBIDDEN403A rota não faz parte da API pública (é interna ou exclusiva de conta).Não tente novamente.
NOT_FOUND404Rota desconhecida, ou a moeda / corretora / fundo solicitado não existe.Não tente novamente; confira o caminho e os identificadores no catálogo.
RATE_LIMITED429Mais requisições do que o limite por minuto. `Retry-After` informa os segundos a aguardar.Aguarde `Retry-After` e então tente novamente com backoff.
INTERNAL500Erro inesperado do servidor. A mensagem é genérica de propósito; cite `request_id` ao reportá-lo.Tente novamente uma vez após alguns segundos; se persistir, reporte-o com o ID da requisição.
UPSTREAM_FAILED503A fonte de dados por trás deste endpoint não respondeu a tempo. Nenhum número desatualizado ou substituto é retornado em seu lugar.Tente novamente com backoff; consulte a página de status.
UNAVAILABLE501 / 503O conjunto de dados ainda não está pronto temporariamente (aquecimento do cache) ou o endpoint ainda não tem uma fonte pública lícita.Tente novamente mais tarde; o catálogo marca os endpoints que são indisponíveis por design.
REQUEST_FAILED200Alguns endpoints mais antigos respondem HTTP 200 com `success: false`. Verifique sempre `success`, não apenas o status HTTP.Depende da mensagem; trate como uma requisição com falha.

Experimente

GET/api/meta/endpointDisponível
Parâmetros

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

URL da requisiçãohttps://www.coinboss.com/api/meta/endpoint?id=sd-oi
Escolha um endpoint e clique em “Enviar requisição”. A resposta, os cabeçalhos e o tempo de resposta aparecerão aqui.