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

Documento OpenAPI

Descrição OpenAPI 3.0 da API pública, gerada a partir do catálogo e das tabelas de campos inferidas de respostas reais.

GET/api/meta/openapi

Requisição

Este endpoint não recebe parâmetros.

Exemplo de requisição

curl -s "https://www.coinboss.com/api/meta/openapi"

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
openapistring—Versão da especificação OpenAPI deste documento.
infoobject—Título, versão e descrição da API.
info.titlestring—Título da API.
info.versionstring—Versão da API.
info.descriptionstring—Descrição curta da API e de suas convenções.
serversarray—URLs base da API.
servers[]object—Uma entrada de servidor.
servers[].urlstring—URL base a ser prefixada a cada caminho.
tagsarray—Categorias de endpoints.
tags[]object—Uma categoria.
tags[].namestring—Nome.
tags[].descriptionstring—Descrição da categoria.
pathsobject—Endpoints, indexados por caminho. chaves dinâmicas: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list
paths.{*}object—Operações disponíveis em um caminho.
paths.{*}.getobject—A operação GET.
paths.{*}.get.operationIdstring—ID do endpoint, o mesmo ID do catálogo.
paths.{*}.get.summarystring—Bloco de resumo.
paths.{*}.get.descriptionstring—O que o endpoint retorna, com notas sobre cobertura e limites.
paths.{*}.get.tagsarray—Categorias do endpoint.
paths.{*}.get.tags[]string—ID da categoria.
paths.{*}.get.x-declared-statusstring—Disponibilidade declarada: `available`, `partial` ou `unavailable`.
paths.{*}.get.x-cache-ttl-secondsnumbersTempo de vida do cache do servidor para o endpoint. pode estar ausente
paths.{*}.get.parametersarray—Parâmetros da requisição. vazio nas amostras usadas para gerar esta tabela
paths.{*}.get.parameters[]object—Um parâmetro.
paths.{*}.get.parameters[].namestring—Nome.
paths.{*}.get.parameters[].instring—Onde o parâmetro vai: `query` ou `path`.
paths.{*}.get.parameters[].requiredboolean—`true` quando o parâmetro precisa ser enviado.
paths.{*}.get.parameters[].descriptionstring—Significado do parâmetro.
paths.{*}.get.parameters[].schemaobject—JSON Schema do valor do parâmetro (tipo, padrão, enum, mínimo, máximo).
paths.{*}.get.parameters[].examplestring—Valor de exemplo. pode estar ausente
paths.{*}.get.responsesobject—Respostas indexadas por status HTTP; a resposta 200 traz o JSON Schema gerado a partir de respostas reais.
componentsobject—Esquemas compartilhados, incluído o corpo de erro usado por todos os endpoints.

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

Exemplo de resposta

/api/meta/openapi · Resposta real capturada 2026-11-13 03:59:28 UTC. Arrays e mapas longos são encurtados para exibição: tags tinha 21 itens; paths tinha 298 itens; paths.{*}.get.responses tinha 5 itens; paths.{*}.get.parameters tinha 3 itens; components.schemas.Error.properties.code.enum tinha 9 itens.

  • {
    • "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": [
      • { … 1 }
      ],
    • "tags": [
      • { … 2 },
      • { … 2 }
      ],
    • "paths": {
      • "/api/coin-heatmap": { … 1 },
      • "/api/coins/all": { … 1 }
      },
    • "components": {
      • "schemas": { … 1 },
      • "securitySchemes": { … 1 }
      }
    }

Detalhes

Autenticação
Nenhuma. Endpoint público.
Limite de requisições
1200 requisições por minuto por IP
Cache do servidor
5m
Microcache de borda
10s
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:59:28 UTCHTTP 20037 msEsquema confere

Disponibilidade, últimos 30 dias

100% de 408 verificações aprovadas

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/openapiDisponível
Parâmetros

Sem parâmetros.

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