/api/p3/btc-returns
GETDisponível

Matriz de retornos mensais / trimestrais / anuais

Matriz de retornos mensais / trimestrais / anuais (BTC / ETH)

GET/api/p3/btc-returns

Requisição

Parâmetros de consulta

NomeTipoObrigatórioPadrãoValores aceitosDescrição
coinstringOpcionalBTCBTC, ETHMoeda; somente BTC ou ETH, as demais são tratadas como BTC. Exemplo: BTC

Exemplo de requisição

curl -s "https://www.coinboss.com/api/p3/btc-returns?coin=BTC"

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 }`.
nownumbermsHorário do servidor em que a resposta foi montada.
coinstring—Símbolo da moeda, em maiúsculas (por exemplo, BTC).
matrixobject—Matriz indexada por linha e coluna. chaves dinâmicas: 2013,2014,2015,2016,2017,2018
matrix.{*}object—Matriz indexada por linha e coluna. chaves dinâmicas: 1,2,3,4,5,6
matrix.{*}.{*}number—Matriz indexada por linha e coluna.
monthAvgobject—Retorno mensal médio de cada mês do calendário em todos os anos de `matrix`; as chaves são os números dos meses `1`–`12`. chaves dinâmicas: 1,2,3,4,5,6
monthAvg.{*}number%Média aritmética dos retornos desse mês do calendário em todos os anos com dados; a chave é o número do mês.
monthMedobject—Mediana do retorno mensal de cada mês do calendário em todos os anos; as chaves são os números dos meses `1`–`12`. chaves dinâmicas: 1,2,3,4,5,6
monthMed.{*}number%Mediana dos retornos desse mês do calendário em todos os anos com dados; a chave é o número do mês.
qmatrixobject—Retornos trimestrais por ano; as chaves são anos do calendário. chaves dinâmicas: 2013,2014,2015,2016,2017,2018
qmatrix.{*}object—Retornos dos trimestres de um ano; as chaves são os números dos trimestres `1`–`4`, e os trimestres sem dados são omitidos. chaves dinâmicas: 1,2,3,4
qmatrix.{*}.{*}number%Retorno do trimestre, composto a partir dos retornos mensais disponíveis nesse trimestre (o trimestre atual é parcial).
qAvgobject—Retorno médio de cada trimestre em todos os anos; as chaves são os números dos trimestres `1`–`4`. chaves dinâmicas: 1,2,3,4
qAvg.{*}number%Média aritmética dos retornos desse trimestre em todos os anos com dados.
qMedobject—Mediana do retorno de cada trimestre em todos os anos; as chaves são os números dos trimestres `1`–`4`. chaves dinâmicas: 1,2,3,4
qMed.{*}number%Mediana dos retornos desse trimestre em todos os anos com dados.
yearlyobject—Valores anuais. chaves dinâmicas: 2013,2014,2015,2016,2017,2018
yearly.{*}number—Valores anuais.
yearSrcobject—Origem dos candles mensais usados em cada ano; as chaves são anos do calendário. chaves dinâmicas: 2013,2014,2015,2016,2017,2018
yearSrc.{*}string—Rótulo da fonte dos candles mensais desse ano: `binance`, um rótulo de preço de referência de terceiros para os anos anteriores à listagem do par na Binance, ou `mixed`.

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

Exemplo de resposta

/api/p3/btc-returns?coin=BTC · Resposta real capturada 2026-11-13 04:02:30 UTC. Arrays e mapas longos são encurtados para exibição: qAvg tinha 4 itens; qMed tinha 4 itens; matrix tinha 14 itens; yearly tinha 14 itens; qmatrix tinha 14 itens; yearSrc tinha 14 itens.

  • {
    • "success": true,
    • "now": 1794542253311,
    • "coin": "BTC",
    • "matrix": {
      • "2013": { … 2 },
      • "2014": { … 2 }
      },
    • "monthAvg": {
      • "1": 3.3,
      • "2": 10.27
      },
    • "monthMed": {
      • "1": -1.09,
      • "2": 11.63
      },
    • "qmatrix": {
      • "2013": { … 2 },
      • "2014": { … 2 }
      },
    • "qAvg": {
      • "1": 47.83,
      • "2": 23.04
      },
    • "qMed": {
      • "1": -3,
      • "2": 9.21
      },
    • "yearly": {
      • "2013": 5372.48,
      • "2014": -57.38
      },
    • "yearSrc": {
      • "2013": "coinmetrics",
      • "2014": "coinmetrics"
      }
    }

Detalhes

Autenticação
Nenhuma. Endpoint público.
Limite de requisições
1200 requisições por minuto por IP
Cache do servidor
10m
Microcache de borda
10s
Frequência de atualização
a cada 6 horas (o mês corrente é atualizado no próprio registro)
Janela
histórico mensal completo
Fontes de dados
Retornos mensais, trimestrais e anuais calculados internamente a partir de um conjunto público de taxas de referência (primeiros anos) e dos klines mensais das corretoras.
Cobertura de corretoras
BTC e ETH.
Ordenação
ano em ordem crescente
Unidades
percent
Método
Monthly return = (close - open) / open x 100; quarterly and yearly returns compound the monthly ones; averages and medians per calendar month/quarter.
Timestamps
Milissegundos da época Unix (UTC), salvo se a descrição do campo indicar o contrário
Formato da resposta
json
Estabilidade
Estável

Status ao vivo

DisponívelVerificado 2026-11-13 04:02:30 UTCHTTP 2001 msEsquema confere

Disponibilidade, últimos 30 dias

100% de 412 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/p3/btc-returnsDisponível
Parâmetros

string · padrão BTC — Coin; BTC or ETH only, others treated as BTC.

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