Bitculator
Bitculator · Data API · v1

Bitculator Data API

73 endpoints 15 grupos X-Quota-* em cada chamada http://localhost/api/v1

Todos os endpoints residem em /api/v1 e requerem uma chave Bearer com a capacidade data-api — crie uma no seu console de desenvolvedor.

A sua primeira chamada:

curl https://bitculator.com/api/v1/prices/bitcoin \
  -H "Authorization: Bearer YOUR_API_KEY"

As respostas são em JSON. Preços, taxas e ofertas são strings decimais (os floats não conseguem transportar a precisão de mercado); as contagens e os valores analíticos são números. Cada resposta transporta a sua cota ao vivo nos cabeçalhos X-Quota-Limit / X-Quota-Used / X-Quota-Reset, e os erros usam sempre o envelope {"error": {"code", "message", "details"}}.

A Data API tem a sua própria cota mensal, associada ao seu plano de API e totalmente separada dos seus widgets de embed. Os limites de per_page dependem do plano (Free 100, Starter/Pro 250); exceder um limite devolve 422 em vez de o restringir.

Autenticação

Para autenticar pedidos, inclua um cabeçalho Authorization: Bearer {YOUR_API_KEY} em cada pedido.

Crie uma chave da Data API no seu console de desenvolvedor — as chaves são exclusivamente Bearer e possuem a capacidade data-api. Mantenha-as no lado do servidor; nunca se destinam a ser incorporadas no lado do cliente.

Cabeçalho de autorização
Criar uma chave →
Bearer
bc_••••••••••••••••

Enviado como Authorization: Bearer {YOUR_API_KEY} em cada pedido.

9 endpoints

Moedas

Dados de mercado de moedas e tokens ordenados: listagens paginadas, detalhe de uma única moeda, movimentos (gainers/losers), recém-adicionadas, em destaque, e séries temporais por moeda. Preços, marketcap e oferta são STRINGS decimais (os floats não conseguem transportar a precisão de mercado); as variações percentuais, ranks e contagens são números.

Listar moedas

Moedas ordenadas com preços, filtros e seletores, paginadas com o envelope links + meta do Laravel. Preços, marketcap e circulating_supply são strings decimais; as variações e ranks são números.

GET
http://localhost/api/v1/coins
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

type
string opcional
coin

Restringir a um único tipo de ativo: coin ou token.

Um de: coin token

status
string opcional
active

Estado de listagem: active, delisted, untracked, progressing, awaiting ou preparing. Predefinição: todos os estados públicos.

Um de: active delisted untracked progressing awaiting preparing

search
string opcional
bitcoin

Correspondência de texto livre no nome ou símbolo. Não pode ter mais de 100 caracteres.

min_price
number opcional
0.5

Apenas moedas com preço igual ou superior a este valor em USD. Deve ser no mínimo 0.

max_price
number opcional
100000

Apenas moedas com preço igual ou inferior a este valor em USD. Deve ser no mínimo 0.

min_marketcap
number opcional
1000000

Apenas moedas com marketcap em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_marketcap
number opcional
5000000000000

Apenas moedas com marketcap em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_volume
number opcional
1000000

Apenas moedas com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas moedas com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

ids
string opcional
38,39

Filtre para ids de moeda específicos (CSV, até 100 seletores combinados com slugs/symbols). Não pode ter mais de 1000 caracteres.

slugs
string opcional
bitcoin,ethereum

Filtre para slugs de moeda específicos (CSV, até 100 seletores combinados). Não pode ter mais de 2000 caracteres.

symbols
string opcional
BTC,ETH

Filtre para símbolos de moeda específicos (CSV, sem distinção de maiúsculas, até 100 seletores combinados). Não pode ter mais de 1000 caracteres.

sort
string opcional
-marketcap

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: marketcap, rank, price, volume_24h, change_24h, change_7d. Não pode ter mais de 100 caracteres.

interval
string opcional
24h

Janela de variação apenas para /coins/gainers e /coins/losers: 24h ou 7d.

Um de: 24h 7d

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Moedas recém-adicionadas

Listagens mais recentes — ordenadas por status_updated_at (o timestamp de ativação; created_at é a data de rastreio, que antecede a listagem por períodos arbitrários). Mesma estrutura de linha e envelope de paginação que List coins.

GET
http://localhost/api/v1/coins/recently-added
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

type
string opcional
coin

Restringir a um único tipo de ativo: coin ou token.

Um de: coin token

status
string opcional
active

Estado de listagem: active, delisted, untracked, progressing, awaiting ou preparing. Predefinição: todos os estados públicos.

Um de: active delisted untracked progressing awaiting preparing

search
string opcional
bitcoin

Correspondência de texto livre no nome ou símbolo. Não pode ter mais de 100 caracteres.

min_price
number opcional
0.5

Apenas moedas com preço igual ou superior a este valor em USD. Deve ser no mínimo 0.

max_price
number opcional
100000

Apenas moedas com preço igual ou inferior a este valor em USD. Deve ser no mínimo 0.

min_marketcap
number opcional
1000000

Apenas moedas com marketcap em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_marketcap
number opcional
5000000000000

Apenas moedas com marketcap em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_volume
number opcional
1000000

Apenas moedas com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas moedas com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

ids
string opcional
38,39

Filtre para ids de moeda específicos (CSV, até 100 seletores combinados com slugs/symbols). Não pode ter mais de 1000 caracteres.

slugs
string opcional
bitcoin,ethereum

Filtre para slugs de moeda específicos (CSV, até 100 seletores combinados). Não pode ter mais de 2000 caracteres.

symbols
string opcional
BTC,ETH

Filtre para símbolos de moeda específicos (CSV, sem distinção de maiúsculas, até 100 seletores combinados). Não pode ter mais de 1000 caracteres.

sort
string opcional
-marketcap

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: marketcap, rank, price, volume_24h, change_24h, change_7d. Não pode ter mais de 100 caracteres.

interval
string opcional
24h

Janela de variação apenas para /coins/gainers e /coins/losers: 24h ou 7d.

Um de: 24h 7d

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/recently-added?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Maiores subidas

Os maiores movimentos positivos na janela de interval (predefinição 24h, ou 7d). Mesma estrutura de linha e envelope de paginação que List coins.

GET
http://localhost/api/v1/coins/gainers
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

type
string opcional
coin

Restringir a um único tipo de ativo: coin ou token.

Um de: coin token

status
string opcional
active

Estado de listagem: active, delisted, untracked, progressing, awaiting ou preparing. Predefinição: todos os estados públicos.

Um de: active delisted untracked progressing awaiting preparing

search
string opcional
bitcoin

Correspondência de texto livre no nome ou símbolo. Não pode ter mais de 100 caracteres.

min_price
number opcional
0.5

Apenas moedas com preço igual ou superior a este valor em USD. Deve ser no mínimo 0.

max_price
number opcional
100000

Apenas moedas com preço igual ou inferior a este valor em USD. Deve ser no mínimo 0.

min_marketcap
number opcional
1000000

Apenas moedas com marketcap em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_marketcap
number opcional
5000000000000

Apenas moedas com marketcap em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_volume
number opcional
1000000

Apenas moedas com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas moedas com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

ids
string opcional
38,39

Filtre para ids de moeda específicos (CSV, até 100 seletores combinados com slugs/symbols). Não pode ter mais de 1000 caracteres.

slugs
string opcional
bitcoin,ethereum

Filtre para slugs de moeda específicos (CSV, até 100 seletores combinados). Não pode ter mais de 2000 caracteres.

symbols
string opcional
BTC,ETH

Filtre para símbolos de moeda específicos (CSV, sem distinção de maiúsculas, até 100 seletores combinados). Não pode ter mais de 1000 caracteres.

sort
string opcional
-marketcap

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: marketcap, rank, price, volume_24h, change_24h, change_7d. Não pode ter mais de 100 caracteres.

interval
string opcional
24h

Janela de variação apenas para /coins/gainers e /coins/losers: 24h ou 7d.

Um de: 24h 7d

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/gainers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Maiores descidas

Os maiores movimentos negativos na janela de interval (predefinição 24h, ou 7d). Mesma estrutura de linha e envelope de paginação que List coins.

GET
http://localhost/api/v1/coins/losers
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

type
string opcional
coin

Restringir a um único tipo de ativo: coin ou token.

Um de: coin token

status
string opcional
active

Estado de listagem: active, delisted, untracked, progressing, awaiting ou preparing. Predefinição: todos os estados públicos.

Um de: active delisted untracked progressing awaiting preparing

search
string opcional
bitcoin

Correspondência de texto livre no nome ou símbolo. Não pode ter mais de 100 caracteres.

min_price
number opcional
0.5

Apenas moedas com preço igual ou superior a este valor em USD. Deve ser no mínimo 0.

max_price
number opcional
100000

Apenas moedas com preço igual ou inferior a este valor em USD. Deve ser no mínimo 0.

min_marketcap
number opcional
1000000

Apenas moedas com marketcap em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_marketcap
number opcional
5000000000000

Apenas moedas com marketcap em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_volume
number opcional
1000000

Apenas moedas com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas moedas com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

ids
string opcional
38,39

Filtre para ids de moeda específicos (CSV, até 100 seletores combinados com slugs/symbols). Não pode ter mais de 1000 caracteres.

slugs
string opcional
bitcoin,ethereum

Filtre para slugs de moeda específicos (CSV, até 100 seletores combinados). Não pode ter mais de 2000 caracteres.

symbols
string opcional
BTC,ETH

Filtre para símbolos de moeda específicos (CSV, sem distinção de maiúsculas, até 100 seletores combinados). Não pode ter mais de 1000 caracteres.

sort
string opcional
-marketcap

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: marketcap, rank, price, volume_24h, change_24h, change_7d. Não pode ter mais de 100 caracteres.

interval
string opcional
24h

Janela de variação apenas para /coins/gainers e /coins/losers: 24h ou 7d.

Um de: 24h 7d

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/losers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Obter o detalhe da moeda

Perfil completo de uma única moeda. Além dos campos da lista, acrescenta: supply (circulante/total/máx.), OHLC de today, all_time_high / all_time_low (preço, data e percent_from em relação ao preço atual), fully_diluted_valuation, counts de mercado (exchanges/pairs/tickers/wallets), decimals, genesis_date, links oficiais (lista de urls tipadas), contracts do token, e uma description em HTML localizada (recorre ao inglês quando o locale pedido está em falta). Todos os campos de preço/oferta são strings decimais.

GET
http://localhost/api/v1/coins/{slug}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

Parâmetros de query

locale
string opcional
en

Idioma do conteúdo para a descrição (recorre ao inglês).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Histórico de candles

Série temporal por moeda de OHLC + volume + marketcap. Escolha interval: minutely, half-hourly, hourly ou daily. A retenção é uma propriedade rígida do pipeline de rollup — minutely 8 dias, half-hourly 3 meses, hourly 6 meses, daily para sempre; os pedidos além de uma janela devolvem o que existe. Quando um limit é definido, obtém as N linhas MAIS RECENTES na janela, emitidas da mais antiga para a mais recente. Os preços são strings decimais.

GET
http://localhost/api/v1/coins/{slug}/history
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

Parâmetros de query

interval
string opcional
daily

minutely, half-hourly, hourly ou daily (predefinição daily).

start
string opcional
2026-06-01

Limite inferior de data/hora ISO.

end
string opcional
2026-06-30

Limite superior de data/hora ISO (um valor apenas de data significa até ao fim desse dia).

limit
integer opcional
30

Máximo de linhas (1–2000, predefinição 1000).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Histórico de marketcap

Os mesmos rollups por moeda que Candle history, projetados apenas para {time, marketcap}. As mesmas opções de interval e janelas de retenção (minutely 8 dias, half-hourly 3 meses, hourly 6 meses, daily para sempre), N-mais-recentes quando um limit é definido.

GET
http://localhost/api/v1/coins/{slug}/marketcap-history
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

Parâmetros de query

interval
string opcional
daily

minutely, half-hourly, hourly ou daily (predefinição daily).

start
string opcional
2026-06-01

Limite inferior de data/hora ISO.

end
string opcional
2026-06-30

Limite superior de data/hora ISO.

limit
integer opcional
30

Máximo de linhas (1–2000, predefinição 1000).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/marketcap-history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Sparkline da moeda

Uma série de preços compacta para a moeda ao longo do period escolhido, para desenhar sparklines.

GET
http://localhost/api/v1/coins/{slug}/sparkline
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

Parâmetros de query

period
string opcional
7d

24h, 7d, 30d, 60d, 90d, 180d ou 365d (predefinição 7d).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/sparkline?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoints

Preços

O caminho rápido e leve de preços — preço atual, marketcap, volume de 24h e variações recentes para um conjunto de moedas solicitado. /prices requer um seletor (ids, slugs ou symbols); /prices/{slug} visa uma moeda. Opcionalmente convert para uma moeda fiat (os preços cripto atualizam ~a cada minuto, o câmbio fiat ~duas vezes por dia). Preços e marketcap são strings decimais.

Obter preços

Preços para um conjunto de moedas solicitado. Passe pelo menos um seletor — ids, slugs ou symbols (até 100 combinados). meta.currency ecoa o alvo de conversão (USD a menos que convert esteja definido).

GET
http://localhost/api/v1/prices
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

ids
string opcional
38,39

IDs de moeda para apresentar preços (CSV). É necessário pelo menos um de ids, slugs ou symbols; as três listas estão limitadas a 100 seletores combinados. Este campo é obrigatório quando nenhum de slugs e symbols está presente. Não pode ter mais de 1000 caracteres.

slugs
string opcional
bitcoin,ethereum

Slugs de moeda para apresentar preços (CSV). É necessário pelo menos um de ids, slugs ou symbols. Este campo é obrigatório quando nenhum de ids e symbols está presente. Não pode ter mais de 2000 caracteres.

symbols
string opcional
BTC,ETH

Símbolos de moeda para apresentar preços (CSV, sem distinção de maiúsculas). É necessário pelo menos um de ids, slugs ou symbols. Este campo é obrigatório quando nenhum de ids e slugs está presente. Não pode ter mais de 1000 caracteres.

convert
string opcional
EUR

Converta preços/marketcap para uma moeda fiat ativa por símbolo (predefinição USD). As taxas de câmbio atualizam ~duas vezes por dia.

Um de: USD EUR JPY BGN CZK DKK GBP HUF PLN RON SEK CHF ISK NOK HRK RUB TRY AUD BRL CAD CNY HKD IDR ILS INR KRW MXN MYR NZD PHP SGD THB ZAR ARS DZD MAD TWD

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/prices?ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&convert=EUR" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Obter o preço de uma moeda

Snapshot de preço de uma única moeda. Opcionalmente convert para uma moeda fiat ativa por símbolo (predefinição USD).

GET
http://localhost/api/v1/prices/{slug}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

Parâmetros de query

convert
string opcional
EUR

Símbolo de moeda fiat ativa em que apresentar os preços (predefinição USD).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/prices/bitcoin?convert=EUR" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Preço histórico

O preço em USD da moeda numa dada data, lido do histórico diário (dia exato, com recurso a ±3 dias — o mesmo resolvedor que o portefólio usa). Apenas cripto: as linhas fiat não têm histórico diário.

GET
http://localhost/api/v1/historical-price
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

slug
string obrigatório
bitcoin

O identificador de slug da moeda.

date
string obrigatório
2021-04-14

date A data de consulta (após 2008-12-31, não no futuro).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/historical-price?slug=bitcoin&date=2021-04-14" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 endpoints

Mercados

Tickers (mercados por exchange) e pares (mercados agregados por plataforma), mais os mercados de uma moeda e os símbolos de negociação em bruto por exchange. Tudo isto são dados de snapshot — não existe histórico por ticker/par. Os volumes em USD são números; os preços são strings decimais.

Mercados da moeda

Todos os mercados de uma moeda — os tickers cujo par tem a moeda como base OU quote. Mesma estrutura de linha e filtros que List tickers.

GET
http://localhost/api/v1/coins/{slug}/markets
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

exchange
string opcional
binance-exchange

Restringir a uma única exchange por slug (omita na listagem por exchange, que já está delimitada). Deve corresponder à regex /^[a-z0-9-]{1,120}$/.

pair
integer opcional
1

Restringir a um único par por id. Deve ser no mínimo 1.

instrument
string opcional
spot

Tipo de instrumento: future, option, swap, spot ou margin (plurais aceites).

Um de: future option swap spot margin

search
string opcional
BTC

Correspondência de texto livre no símbolo do ticker. Não pode ter mais de 50 caracteres.

min_volume
number opcional
1000000

Apenas tickers com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas tickers com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_change
number opcional
-50

Apenas tickers com uma variação percentual de 24h igual ou superior a este valor.

max_change
number opcional
50

Apenas tickers com uma variação percentual de 24h igual ou inferior a este valor.

sort
string opcional
-volume_usd

Um único campo de ordenação (prefixe com - para descendente). Ordenável por: volume_usd, change_24h, price_usd, updated. Predefinição -volume_usd. Não pode ter mais de 100 caracteres.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/markets?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Símbolos de negociação da moeda

Os símbolos de negociação em bruto por exchange da moeda — dados de referência escassamente preenchidos (a cobertura é o melhor possível).

GET
http://localhost/api/v1/coins/{slug}/symbols
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/symbols" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listar tickers

Mercados individuais por exchange (tickers), paginados. Filtre por exchange, par, instrumento e intervalos de volume/variação. Os volumes em USD são números; os preços são strings decimais.

GET
http://localhost/api/v1/tickers
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

exchange
string opcional
binance-exchange

Restringir a uma única exchange por slug (omita na listagem por exchange, que já está delimitada). Deve corresponder à regex /^[a-z0-9-]{1,120}$/.

pair
integer opcional
1

Restringir a um único par por id. Deve ser no mínimo 1.

instrument
string opcional
spot

Tipo de instrumento: future, option, swap, spot ou margin (plurais aceites).

Um de: future option swap spot margin

search
string opcional
BTC

Correspondência de texto livre no símbolo do ticker. Não pode ter mais de 50 caracteres.

min_volume
number opcional
1000000

Apenas tickers com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas tickers com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_change
number opcional
-50

Apenas tickers com uma variação percentual de 24h igual ou superior a este valor.

max_change
number opcional
50

Apenas tickers com uma variação percentual de 24h igual ou inferior a este valor.

sort
string opcional
-volume_usd

Um único campo de ordenação (prefixe com - para descendente). Ordenável por: volume_usd, change_24h, price_usd, updated. Predefinição -volume_usd. Não pode ter mais de 100 caracteres.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listar pares

Pares de negociação agregados por plataforma, ordenados por volume de 24h em USD. Filtre por um slug de moeda (base ou quote) e intervalo de volume.

GET
http://localhost/api/v1/pairs
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

search
string opcional
BTC

Correspondência de texto livre no símbolo do par. Não pode ter mais de 50 caracteres.

coin
string opcional
bitcoin

Restringir a pares em que este slug de moeda é o ativo base ou quote. Deve corresponder à regex /^[a-z0-9-]{1,120}$/.

min_volume
number opcional
1000000

Apenas pares com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas pares com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

sort
string opcional
-volume_usd

Campo de ordenação: volume_usd ou updated (prefixe com - para descendente). Predefinição -volume_usd.

Um de: volume_usd -volume_usd updated -updated

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/pairs?page=1&per_page=50&search=BTC&coin=bitcoin&min_volume=1000000&max_volume=100000000000&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Obter o detalhe do par

Um par mais todos os tickers de exchange que o listam, ordenados por volume.

GET
http://localhost/api/v1/pairs/{id}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

id
integer obrigatório
1

O id do par.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/pairs/1" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
7 endpoints

Exchanges

Rankings de exchanges, detalhe, trust scores, séries temporais e listagens de mercado/moeda por exchange. Os volumes são em USD. Não existe uma coluna CEX/DEX — type é derivado da taxonomia da exchange, pelo que pode ser "cex", "dex" ou null.

Listar exchanges

Exchanges ordenadas com volume de 24h, dominância, contagens de pares/ativos e variações recentes. Paginadas com o envelope links + meta do Laravel.

GET
http://localhost/api/v1/exchanges
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

type
string opcional
cex

Restringir a um tipo de plataforma: cex ou dex (resolvido através da taxonomia da exchange).

Um de: cex dex

search
string opcional
binance

Correspondência de texto livre no nome da exchange. Não pode ter mais de 100 caracteres.

min_pairs
integer opcional
100

Apenas exchanges que listem pelo menos esta quantidade de pares. Deve ser no mínimo 0.

max_pairs
integer opcional
2000

Apenas exchanges que listem no máximo esta quantidade de pares. Deve ser no mínimo 0.

min_assets
integer opcional
50

Apenas exchanges que listem pelo menos esta quantidade de ativos. Deve ser no mínimo 0.

max_assets
integer opcional
1000

Apenas exchanges que listem no máximo esta quantidade de ativos. Deve ser no mínimo 0.

min_volume
number opcional
1000000

Apenas exchanges com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas exchanges com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

ids
string opcional
1,12

Filtre para ids de exchange específicos (CSV, até 100). Não pode ter mais de 1000 caracteres.

slugs
string opcional
binance-exchange,gateio

Filtre para slugs de exchange específicos (CSV, até 100). Não pode ter mais de 2000 caracteres.

sort
string opcional
-volume

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: volume, rank, volume_dominance, change_24h, change_7d, pairs, assets. Não pode ter mais de 100 caracteres.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/exchanges?page=1&per_page=50&type=cex&search=binance&min_pairs=100&max_pairs=2000&min_assets=50&max_assets=1000&min_volume=1000000&max_volume=100000000000&ids=1%2C12&slugs=binance-exchange%2Cgateio&sort=-volume" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Obter o detalhe da exchange

Perfil completo de uma única exchange: ranking, volume/dominância, contagens de pares e ativos, data de established, location, website de referência, e o type derivado (cex/dex/null).

GET
http://localhost/api/v1/exchanges/{slug}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
binance-exchange

O slug da exchange.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Obter o trust score da exchange

Um score de confiança agregado de 0–10 mais a sua breakdown de 13 fatores (rank, volume, age, volume_trend, stability, rank_stability, ticker_health, pairs, community, assets, dominance, market_breadth, transparency). Calculado por exchange e em cache durante 24h.

GET
http://localhost/api/v1/exchanges/{slug}/trust-score
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
binance-exchange

O slug da exchange.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/trust-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Histórico da exchange

Série temporal de volume / dominância / pares / ativos (os rollups da exchange não transportam OHLC). Escolha interval: minutely, hourly ou daily. A retenção é uma propriedade rígida do pipeline de rollup — minutely 8 dias, hourly 6 meses, daily para sempre; quando um limit é definido, obtém as N linhas mais recentes na janela, da mais antiga primeiro.

GET
http://localhost/api/v1/exchanges/{slug}/history
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
binance-exchange

O slug da exchange.

Parâmetros de query

interval
string opcional
daily

minutely, hourly ou daily (predefinição daily).

start
string opcional
2026-06-01

Limite inferior de data/hora ISO.

end
string opcional
2026-06-30

Limite superior de data/hora ISO (um valor apenas de data significa até ao fim desse dia).

limit
integer opcional
30

Máximo de linhas (1–2000, predefinição 1000).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Sparkline da exchange

A série sparkline de volume da exchange para um período (predefinição 7d) — a mesma série que as linhas de exchange da web renderizam.

GET
http://localhost/api/v1/exchanges/{slug}/sparkline
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
binance-exchange

O slug da exchange.

Parâmetros de query

period
string opcional
7d

Um de 24h, 7d (predefinição), 30d, 60d, 90d, 180d, 365d.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/sparkline?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mercados da exchange

As listagens de tickers da exchange (os seus mercados), paginadas. Já delimitadas à exchange — não passe aqui um parâmetro exchange.

GET
http://localhost/api/v1/exchanges/{slug}/tickers
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
binance-exchange

O slug da exchange.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

exchange
string opcional
binance-exchange

Restringir a uma única exchange por slug (omita na listagem por exchange, que já está delimitada). Deve corresponder à regex /^[a-z0-9-]{1,120}$/.

pair
integer opcional
1

Restringir a um único par por id. Deve ser no mínimo 1.

instrument
string opcional
spot

Tipo de instrumento: future, option, swap, spot ou margin (plurais aceites).

Um de: future option swap spot margin

search
string opcional
BTC

Correspondência de texto livre no símbolo do ticker. Não pode ter mais de 50 caracteres.

min_volume
number opcional
1000000

Apenas tickers com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas tickers com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_change
number opcional
-50

Apenas tickers com uma variação percentual de 24h igual ou superior a este valor.

max_change
number opcional
50

Apenas tickers com uma variação percentual de 24h igual ou inferior a este valor.

sort
string opcional
-volume_usd

Um único campo de ordenação (prefixe com - para descendente). Ordenável por: volume_usd, change_24h, price_usd, updated. Predefinição -volume_usd. Não pode ter mais de 100 caracteres.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Moedas da exchange

Moedas listadas na exchange, devolvidas na mesma estrutura que List coins e aceitando os mesmos filtros/ordenação.

GET
http://localhost/api/v1/exchanges/{slug}/assets
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
binance-exchange

O slug da exchange.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

type
string opcional
coin

Restringir a um único tipo de ativo: coin ou token.

Um de: coin token

status
string opcional
active

Estado de listagem: active, delisted, untracked, progressing, awaiting ou preparing. Predefinição: todos os estados públicos.

Um de: active delisted untracked progressing awaiting preparing

search
string opcional
bitcoin

Correspondência de texto livre no nome ou símbolo. Não pode ter mais de 100 caracteres.

min_price
number opcional
0.5

Apenas moedas com preço igual ou superior a este valor em USD. Deve ser no mínimo 0.

max_price
number opcional
100000

Apenas moedas com preço igual ou inferior a este valor em USD. Deve ser no mínimo 0.

min_marketcap
number opcional
1000000

Apenas moedas com marketcap em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_marketcap
number opcional
5000000000000

Apenas moedas com marketcap em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_volume
number opcional
1000000

Apenas moedas com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas moedas com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

ids
string opcional
38,39

Filtre para ids de moeda específicos (CSV, até 100 seletores combinados com slugs/symbols). Não pode ter mais de 1000 caracteres.

slugs
string opcional
bitcoin,ethereum

Filtre para slugs de moeda específicos (CSV, até 100 seletores combinados). Não pode ter mais de 2000 caracteres.

symbols
string opcional
BTC,ETH

Filtre para símbolos de moeda específicos (CSV, sem distinção de maiúsculas, até 100 seletores combinados). Não pode ter mais de 1000 caracteres.

sort
string opcional
-marketcap

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: marketcap, rank, price, volume_24h, change_24h, change_7d. Não pode ter mais de 100 caracteres.

interval
string opcional
24h

Janela de variação apenas para /coins/gainers e /coins/losers: 24h ou 7d.

Um de: 24h 7d

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 endpoints

Wallets

Análises de wallets cripto — score da análise, contagem de ativos suportados, contagens de prós/contras, modelo de preço e data de lançamento, mais uma taxonomia de tags agrupada nas respostas de detalhe/comparação. meta.top_score é a pontuação mais alta entre todas as wallets (use-a para normalizar as pontuações num intervalo de 0–1).

Listar wallets

Wallets analisadas com pontuação, contagem de ativos, contagens de prós/contras, modelo de preço, estado e data de lançamento. Paginadas com o envelope links + meta do Laravel, mais meta.top_score.

GET
http://localhost/api/v1/wallets
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

search
string opcional
ledger

Correspondência de texto livre no nome da wallet. Não pode ter mais de 100 caracteres.

min_score
integer opcional
50

Apenas wallets com uma pontuação de análise igual ou superior a este valor. Deve ser no mínimo 0.

max_score
integer opcional
214

Apenas wallets com uma pontuação de análise igual ou inferior a este valor. Deve ser no mínimo 0.

tags
string opcional
12,34

Filtre pela taxonomia de tags: ids de grupos de categorias separados por vírgula (os mesmos ids que os filtros de facetas da web submetem). Não pode ter mais de 1000 caracteres.

ids
string opcional
175,317

Filtre para ids de wallet específicos (CSV, até 100). Não pode ter mais de 1000 caracteres.

slugs
string opcional
frostsnap,coin98-fusion-card

Filtre para slugs de wallet específicos (CSV, até 100). Não pode ter mais de 2000 caracteres.

sort
string opcional
-score

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: score, released_at, assets, pros, cons. Não pode ter mais de 100 caracteres.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/wallets?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Cronologia de lançamentos de wallets

A lista de wallets fixada a released_at descendente (as wallets sem data por último). Mesma estrutura de linha e envelope de paginação que List wallets.

GET
http://localhost/api/v1/wallets/timeline
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

search
string opcional
ledger

Correspondência de texto livre no nome da wallet. Não pode ter mais de 100 caracteres.

min_score
integer opcional
50

Apenas wallets com uma pontuação de análise igual ou superior a este valor. Deve ser no mínimo 0.

max_score
integer opcional
214

Apenas wallets com uma pontuação de análise igual ou inferior a este valor. Deve ser no mínimo 0.

tags
string opcional
12,34

Filtre pela taxonomia de tags: ids de grupos de categorias separados por vírgula (os mesmos ids que os filtros de facetas da web submetem). Não pode ter mais de 1000 caracteres.

ids
string opcional
175,317

Filtre para ids de wallet específicos (CSV, até 100). Não pode ter mais de 1000 caracteres.

slugs
string opcional
frostsnap,coin98-fusion-card

Filtre para slugs de wallet específicos (CSV, até 100). Não pode ter mais de 2000 caracteres.

sort
string opcional
-score

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: score, released_at, assets, pros, cons. Não pode ter mais de 100 caracteres.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/wallets/timeline?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Comparar wallets

Comparação lado a lado de 2–4 wallets com a sua taxonomia de tags agrupada completa. data[] preserva a ordem dos slugs solicitada para que os consumidores possam renderizar as colunas por posição.

GET
http://localhost/api/v1/wallets/compare
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

slugs
string obrigatório
frostsnap,coin98-fusion-card

2–4 slugs de wallet distintos, separados por vírgula.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/wallets/compare?slugs=frostsnap%2Ccoin98-fusion-card" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Obter o detalhe da wallet

Perfil completo de uma única wallet, incluindo a taxonomia de tags agrupada: categories é uma lista de {group, tags[]} onde cada tag tem um slug, nome e valor opcional. meta.top_score é a pontuação mais alta entre todas as wallets.

GET
http://localhost/api/v1/wallets/{slug}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
frostsnap

O slug da wallet.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/wallets/frostsnap" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Moedas suportadas pela wallet

Moedas que a wallet suporta, devolvidas na mesma estrutura que List coins e aceitando os mesmos filtros/ordenação.

GET
http://localhost/api/v1/wallets/{slug}/assets
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
frostsnap

O slug da wallet.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

type
string opcional
coin

Restringir a um único tipo de ativo: coin ou token.

Um de: coin token

status
string opcional
active

Estado de listagem: active, delisted, untracked, progressing, awaiting ou preparing. Predefinição: todos os estados públicos.

Um de: active delisted untracked progressing awaiting preparing

search
string opcional
bitcoin

Correspondência de texto livre no nome ou símbolo. Não pode ter mais de 100 caracteres.

min_price
number opcional
0.5

Apenas moedas com preço igual ou superior a este valor em USD. Deve ser no mínimo 0.

max_price
number opcional
100000

Apenas moedas com preço igual ou inferior a este valor em USD. Deve ser no mínimo 0.

min_marketcap
number opcional
1000000

Apenas moedas com marketcap em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_marketcap
number opcional
5000000000000

Apenas moedas com marketcap em USD igual ou inferior a este valor. Deve ser no mínimo 0.

min_volume
number opcional
1000000

Apenas moedas com volume de 24h em USD igual ou superior a este valor. Deve ser no mínimo 0.

max_volume
number opcional
100000000000

Apenas moedas com volume de 24h em USD igual ou inferior a este valor. Deve ser no mínimo 0.

ids
string opcional
38,39

Filtre para ids de moeda específicos (CSV, até 100 seletores combinados com slugs/symbols). Não pode ter mais de 1000 caracteres.

slugs
string opcional
bitcoin,ethereum

Filtre para slugs de moeda específicos (CSV, até 100 seletores combinados). Não pode ter mais de 2000 caracteres.

symbols
string opcional
BTC,ETH

Filtre para símbolos de moeda específicos (CSV, sem distinção de maiúsculas, até 100 seletores combinados). Não pode ter mais de 1000 caracteres.

sort
string opcional
-marketcap

Campos de ordenação separados por vírgula; prefixe com - para descendente. Ordenável por: marketcap, rank, price, volume_24h, change_24h, change_7d. Não pode ter mais de 100 caracteres.

interval
string opcional
24h

Janela de variação apenas para /coins/gainers e /coins/losers: 24h ou 7d.

Um de: 24h 7d

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/wallets/frostsnap/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoints

Mercado Global

Agregados de todo o mercado — marketcap e volume totais, contagens de ativos/exchanges/pares/mercados, dominância de BTC/ETH com um top-3 baseado em rank, a leitura de Fear & Greed do mercado, mais um heatmap do top-100 e o histórico de marketcap/volume.

Snapshot do mercado global

Visão geral do mercado numa só chamada: marketcap total e volume de 24h, contagens de criptomoedas / tokens / exchanges / pares / mercados, dominance (quota de BTC e ETH mais o top3 baseado em rank), e a leitura de fear_greed do mercado.

GET
http://localhost/api/v1/global
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/global" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Heatmap do mercado

Linhas do treemap do top-100 mais estatísticas de enquadramento (marketcap/volume totais, dominância e a pontuação de Fear & Greed do mercado) — o gémeo de API do heatmap da web.

GET
http://localhost/api/v1/global/heatmap
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/global/heatmap" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Histórico global de marketcap / volume

Série temporal de todo o mercado para marketcap ou volume. A granularidade segue o period: 24h = half-hourly, 7d = hourly, 30d/all = daily (os rollups mais finos são purgados).

GET
http://localhost/api/v1/global/history/{metric}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

metric
string obrigatório
marketcap

Que série: marketcap ou volume.

Parâmetros de query

period
string opcional
7d

24h, 7d, 30d ou all (predefinição 24h).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/global/history/marketcap?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
6 endpoints

Sentimento

Índices de sentimento de mercado e por moeda. Fear & Greed e Bull/Bear são SNAPSHOTS atualizados a cada 15 minutos — só existe a leitura atual, não há série temporal para eles. O altseason traz o histórico diário completo. indicators é a contagem técnica de todo o mercado.

Contagens de votos da comunidade

As contagens da comunidade altista/baixista da moeda ao longo da janela contínua de 24h.

GET
http://localhost/api/v1/coins/{slug}/votes
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O identificador de slug da moeda.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/votes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Emitir um voto de sentimento

Emite o voto de sentimento do dono da chave para uma moeda. Um voto por dono de chave por moeda por janela contínua de 24h — votar novamente dentro da janela atualiza o voto existente.

POST
http://localhost/api/v1/coins/{slug}/votes
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O identificador de slug da moeda.

Parâmetros de corpo

vote
string obrigatório
bullish

O seu sentimento: bullish ou bearish.

Pedido

curl --request POST \
    "http://localhost/api/v1/coins/bitcoin/votes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vote\": \"bullish\"
}"

Índice Fear & Greed

A leitura atual de Fear & Greed (um snapshot de 15 minutos — sem histórico). Omita coin para o índice de todo o mercado, ou passe um slug de moeda para uma leitura por moeda. intervals transporta as sub-pontuações de 7d/30d e a sua decomposição por componente.

GET
http://localhost/api/v1/sentiment/fear-greed
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

coin
string opcional
bitcoin

Slug da moeda para uma leitura por moeda; omita para o índice de mercado.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/sentiment/fear-greed?coin=bitcoin" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Índice Bull / Bear

A leitura atual de Bull/Bear (um snapshot de 15 minutos — sem histórico). Omita coin para o índice de todo o mercado, ou passe um slug de moeda para uma leitura por moeda.

GET
http://localhost/api/v1/sentiment/bull-bear
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

coin
string opcional
bitcoin

Slug da moeda para uma leitura por moeda; omita para o índice de mercado.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/sentiment/bull-bear?coin=bitcoin" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Índice de altseason

A leitura atual de altseason (contagem de moedas a superar o BTC entre as top 100), com history diário opcional. Ao contrário do Fear & Greed, o altseason tem histórico diário completo — passe days para o incluir.

GET
http://localhost/api/v1/sentiment/altseason
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

days
integer opcional
30

Dias de histórico diário a incluir (1–365; 0/omitir = apenas o atual).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/sentiment/altseason?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Contagem de indicadores do mercado

A contagem técnica de todo o mercado — 25 categorias de indicadores agregadas, cada uma com o seu estado atual, pontuação e dados da categoria.

GET
http://localhost/api/v1/sentiment/indicators
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/sentiment/indicators" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
2 endpoints

Indicadores

Indicadores técnicos por moeda — um snapshot multi-indicador mais séries temporais diárias por família. Todas as famílias são séries DIÁRIAS calculadas a partir de candles diários (retenção completa; os ativos jovens devolvem nulls de aquecimento até existir histórico suficiente). As famílias de escala de preço (sma, vwap, macd, obv) emitem strings decimais; os osciladores limitados emitem números. Alguns períodos de janela longa requerem um plano pago (consulte o endpoint da família).

Snapshot de indicadores

O snapshot multi-indicador — o state mais recente de cada categoria de indicadores (altista/baixista/tímido…), score e data em bruto, num único payload.

GET
http://localhost/api/v1/coins/{slug}/indicators
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/indicators" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Série da família de indicadores

A série temporal diária de uma família de indicadores. As famílias com múltiplas janelas aceitam um period, e as janelas válidas diferem por família: RSI/Stoch-RSI 7/14/21/28, SMA 50/100/200, CCI 20/50/100, MFI 7/14/28, Williams %R 14/20/50, price/volume-volatility 7/14/30. As famílias de série única (MACD, OBV, ADX, VWAP, CMF) ignoram period. As moedas jovens devolvem nulls iniciais de aquecimento.

Algumas janelas longas requerem um plano pago: RSI e Stoch-RSI de 21/28 dias e as janelas de volatilidade de 30 dias precisam de Starter ou superior — pedi-las no plano Free devolve 403 com o código plan_required.

GET
http://localhost/api/v1/coins/{slug}/indicators/{family}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O slug da moeda.

family
string obrigatório
rsi

Família de indicadores — uma de rsi, stoch-rsi, sma, cci, mfi, williams-r, price-volatility, volume-volatility, macd, obv, adx, vwap, cmf.

Parâmetros de query

period
integer opcional
14

Comprimento da janela (apenas quando a família tem janelas; deve ser uma das janelas válidas dessa família).

start
string opcional
2026-06-01

Limite inferior de data ISO.

end
string opcional
2026-06-30

Limite superior de data ISO.

limit
integer opcional
30

Máximo de linhas (1–1000, predefinição 365).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/indicators/rsi?period=14&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
6 endpoints

Liquidações

Liquidações de derivados. A cobertura de origem são atualmente apenas os mercados de swap da OKX (indicado em cada meta.note). O feed EM BRUTO (a lista /liquidations e a decomposição horária) é purgado após ~48 horas; os agregados diários são mantidos para sempre. Os agregados de hoje são parciais e atualizam a cada ~15 minutos.

Feed de liquidações

O feed de liquidações em bruto (~últimas 48h, depois purgado), do mais recente para o mais antigo. A cobertura de origem são atualmente os mercados de swap da OKX. Os preços são strings decimais. meta transporta os campos de paginação mais um retention e note.

GET
http://localhost/api/v1/liquidations
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1). Deve ser no mínimo 1.

per_page
integer opcional
50

Linhas por página. O limite depende do plano (Free 100, Starter/Pro 250); excedê-lo devolve 422 em vez de o restringir. Deve ser no mínimo 1. Não pode ser superior a 100.

exchange
string opcional
okx

Restringir a uma única exchange por slug. A cobertura de origem são atualmente os mercados de swap da OKX. Deve corresponder à regex /^[a-z0-9-]{1,120}$/.

instrument
string opcional
swap

Tipo de instrumento: future, option, swap, spot ou margin.

Um de: future option swap spot margin

position
string opcional
short

Lado da posição liquidada: long ou short.

Um de: long short

order
string opcional
buy

Lado da execução que desencadeou a liquidação: buy ou sell.

Um de: buy sell

symbol
string opcional
BTC

Correspondência de prefixo no instId da plataforma (por exemplo BTC corresponde a BTC-USDT-SWAP). Deve corresponder à regex /^[A-Za-z0-9$.-]{1,25}$/.

min_usd
number opcional
1000

Apenas liquidações com um valor em USD igual ou superior a este limiar. Deve ser no mínimo 0.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/liquidations?page=1&per_page=50&exchange=okx&instrument=swap&position=short&order=buy&symbol=BTC&min_usd=1000" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Liquidações horárias

Totais horários de USD long/short sobre o feed em bruto. Como o feed em bruto é purgado às ~48h, hours está limitado a 48. A cobertura de origem são atualmente os mercados de swap da OKX.

GET
http://localhost/api/v1/liquidations/hourly
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

hours
integer opcional
24

Janela de retrospetiva em horas (1–48, predefinição 24).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/liquidations/hourly?hours=24" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Liquidações diárias

Agregados diários (mantidos para sempre), somados entre exchanges/instrumentos por dia — USD total/long/short mais contagens de posições long/short. A linha de hoje é parcial e atualiza a cada ~15 minutos. A cobertura de origem são atualmente os mercados de swap da OKX.

GET
http://localhost/api/v1/liquidations/daily
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

days
integer opcional
30

Número de dias de calendário incl. hoje (1–365, predefinição 30).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/liquidations/daily?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Resumo das liquidações de hoje

Hoje até agora — USD total/long/short, contagens de posições e dominance long-vs-short. Os números são parciais e atualizam a cada ~15 minutos; data é null até ser registada a primeira liquidação do dia. A cobertura de origem são atualmente os mercados de swap da OKX.

GET
http://localhost/api/v1/liquidations/summary
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/liquidations/summary" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Fluxo líquido de liquidações

Fluxo de USD de liquidações long-vs-short por dia ao longo da janela. A cobertura de origem são atualmente os mercados de swap da OKX.

GET
http://localhost/api/v1/liquidations/netflow
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

days
integer opcional
30

Número de dias de calendário incl. hoje (1–90, predefinição 30).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/liquidations/netflow?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Moedas mais liquidadas

Principais moedas por volume de liquidação na janela recente, com a divisão de USD long/short por moeda. A cobertura de origem são atualmente os mercados de swap da OKX.

GET
http://localhost/api/v1/liquidations/coins
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

hours
integer opcional
24

Janela de retrospetiva em horas (1–48, predefinição 24).

limit
integer opcional
8

Número de moedas a devolver (1–20, predefinição 8).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/liquidations/coins?hours=24&limit=8" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoints

Conversão

Converta entre quaisquer dois ativos ativos (cripto E fiat), e liste as moedas utilizáveis como pernas de conversão. Os valores são strings decimais. As taxas de câmbio fiat atualizam ~duas vezes por dia; as taxas cripto ~a cada minuto.

Converter entre ativos

Conversão do lado do servidor entre quaisquer dois ativos ativos (cripto E fiat). to aceita um CSV para conversão multi-alvo; inverter é apenas trocar from/to. A conversão é linear, portanto value = unit_rate * amount. As taxas de câmbio fiat atualizam ~duas vezes por dia; as taxas cripto ~a cada minuto.

GET
http://localhost/api/v1/convert
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

from
string obrigatório
bitcoin

Slug do ativo de origem.

to
string obrigatório
ethereum

Slug(s) do ativo de destino, separados por vírgula (até 10).

amount
number opcional
2.5

Quantidade do ativo de origem a converter (predefinição 1).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/convert?from=bitcoin&to=ethereum&amount=2.5" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listar moedas fiat

As moedas fiat ativas com as suas taxas de câmbio em USD: rate_per_usd (unidades por USD) e a sua inversa usd_value. As taxas de câmbio fiat atualizam ~duas vezes por dia.

GET
http://localhost/api/v1/fiats
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/fiats" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listar taxas de conversão

As vs-currencies utilizáveis como pernas de conversão — as principais fiats, moedas e tokens — cada uma com um usd_value normalizado (USD por unidade). Os valores de moedas/tokens atualizam ~a cada minuto; as taxas fiat lentas são colocadas em cache separadamente (~duas vezes por dia).

GET
http://localhost/api/v1/rates
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/rates" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 endpoints

Calculadoras

Calculadoras financeiras do lado do servidor que espelham as ferramentas web: DCA, lucros/perdas e empréstimo (que leem dados de mercado em cache), mais cálculos de juros compostos e staking sem estado.

Calculadora de DCA

Backtest de dollar-cost averaging sobre o histórico real de preços diários da moeda: uma compra de amount por interval entre start e end. Passe series=true para incluir a série completa por compra.

GET
http://localhost/api/v1/calculators/dca
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

slug
string obrigatório
bitcoin

O identificador de slug da moeda.

amount
number obrigatório
100

USD gasto por compra (0.01–1,000,000,000).

interval
string obrigatório
weekly

Cadência de compra: daily, weekly, monthly, quarterly ou yearly.

start
string obrigatório
2024-01-01

date Data da primeira compra (após 2008-12-31).

end
string opcional
2025-01-01

date Data da última compra (predefinição hoje).

series
boolean opcional
false

Incluir a série por compra no payload.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/calculators/dca?slug=bitcoin&amount=100&interval=weekly&start=2024-01-01&end=2025-01-01&series=" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Calculadora de lucros / perdas

O que uma compra-e-venda entre duas datas históricas rendeu, usando os preços reais da moeda nessas datas. As taxas são montantes fixos em USD, não percentagens.

GET
http://localhost/api/v1/calculators/profit-loss
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

slug
string obrigatório
bitcoin

O identificador de slug da moeda.

amount
number obrigatório
1000

USD investido em buy_date (0.01–1,000,000,000).

buy_date
string obrigatório
2023-01-01

date Data de compra.

sell_date
string obrigatório
2025-01-01

date Data de venda (em/após buy_date).

buy_fee
number opcional
10

Taxa fixa de compra em USD (predefinição 0).

sell_fee
number opcional
10

Taxa fixa de venda em USD (predefinição 0).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/calculators/profit-loss?slug=bitcoin&amount=1000&buy_date=2023-01-01&sell_date=2025-01-01&buy_fee=10&sell_fee=10" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Calculadora de juros compostos

Matemática pura — sem dados de mercado. Note que a taxa se aplica POR PERÍODO DE CAPITALIZAÇÃO (a convenção da calculadora web), não por ano.

GET
http://localhost/api/v1/calculators/compound-interest
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

principal
number obrigatório
10000

Saldo inicial em USD.

rate
number obrigatório
1

Taxa de juro em % por período de capitalização.

duration
integer obrigatório
5

Duração da projeção (os anos estão limitados a 50).

duration_unit
string opcional
years

years (predefinição) ou months.

compound_frequency
string opcional
monthly

daily, weekly, monthly (predefinição), quarterly ou annually.

contribution
number opcional
100

Depósito recorrente em USD (predefinição 0).

contribution_frequency
string opcional
monthly

daily, weekly, monthly (predefinição), quarterly ou annually.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/calculators/compound-interest?principal=10000&rate=1&duration=5&duration_unit=years&compound_frequency=monthly&contribution=100&contribution_frequency=monthly" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Calculadora de empréstimo vs venda

Pedir emprestado com garantia de cripto vs vendê-la — compara ambos os cenários usando o preço ATUAL da moeda. Projeção informativa, não é aconselhamento financeiro.

GET
http://localhost/api/v1/calculators/loan
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

slug
string obrigatório
bitcoin

O identificador de slug da moeda.

crypto_amount
number obrigatório
2

Quanto da moeda você detém.

needed_cash
number obrigatório
50000

USD que precisa de libertar.

term_months
integer opcional
36

Prazo do empréstimo em meses (predefinição 36).

interest_rate
number opcional
10

APR do empréstimo em % (predefinição 10).

ltv
number opcional
50

Rácio loan-to-value em % (predefinição 50).

expected_growth
number opcional
25

Crescimento esperado do preço da moeda ao longo do prazo em % (predefinição 25).

tax_rate
number opcional
25

Imposto sobre mais-valias em % aplicado à venda (predefinição 25).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/calculators/loan?slug=bitcoin&crypto_amount=2&needed_cash=50000&term_months=36&interest_rate=10&ltv=50&expected_growth=25&tax_rate=25" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Calculadora de recompensas de staking

Matemática pura — recompensas de staking com capitalização opcional e uma comissão de validador. Não são lidos dados de mercado.

GET
http://localhost/api/v1/calculators/staking
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

amount
number obrigatório
1000

Quantidade em stake, nas unidades do ativo em stake.

period
number obrigatório
2

Duração do período de staking (limitado ao equivalente a 50 anos).

period_unit
string opcional
years

years (predefinição), months ou days.

apy
number obrigatório
5

APY anunciada em %.

compound_frequency
string opcional
monthly

never, daily, weekly, monthly (predefinição) ou yearly.

commission
number opcional
10

Comissão do validador em %, retirada das recompensas (predefinição 0).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/calculators/staking?amount=1000&period=2&period_unit=years&apy=5&compound_frequency=monthly&commission=10" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
8 endpoints

Editorial

Artigos editoriais — apenas publicados (ACTIVE). locale escolhe o idioma do conteúdo com recurso ao inglês por campo (o payload indica que locale prevaleceu de facto). Os artigos podem ser filtrados por tag ou por um slug de coin/exchange/wallet relacionado. As leituras da API deliberadamente NÃO incrementam as contagens de visualizações.

Vídeos da moeda

Vídeos selecionados associados a uma moeda (o separador Vídeos da página da moeda), paginados.

GET
http://localhost/api/v1/coins/{slug}/videos
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O identificador de slug da moeda.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1).

per_page
integer opcional
10

Linhas por página (1–50, predefinição 10).

type
string opcional
review

Filtre por tipo de vídeo (por exemplo overview, tutorial, explainer, review, analysis, news).

search
string opcional
halving

Correspondência de texto livre no título.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/videos?page=1&per_page=10&type=review&search=halving" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Cronologia de insights da moeda

A cronologia de insights da moeda — o mesmo payload que o painel de insights da página do ativo usa, delimitado por offset/limit.

GET
http://localhost/api/v1/coins/{slug}/insights
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
bitcoin

O identificador de slug da moeda.

Parâmetros de query

locale
string opcional
en

Idioma do conteúdo (recorre ao inglês).

offset
integer opcional
0

Linhas a ignorar (0–500, predefinição 0).

limit
integer opcional
5

Linhas a devolver (1–50, predefinição 5).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/insights?locale=en&offset=0&limit=5" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listar artigos

Artigos publicados, do mais recente para o mais antigo, paginados. Filtre por tag ou por um slug de coin / exchange / wallet relacionado, ou search de texto livre. Cada linha é um resumo (título, subtítulo, tags, tempo de leitura, imagem de destaque, entidades relacionadas, datas).

GET
http://localhost/api/v1/articles
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1).

per_page
integer opcional
20

Linhas por página (1–50, predefinição 20).

locale
string opcional
en

Idioma do conteúdo (recorre ao inglês).

tag
string opcional
guide

Filtre por tag: news, guide, tutorial, explainer, analysis, review, trading, overview ou information.

coin
string opcional
bitcoin

Filtre para artigos relacionados com este slug de moeda.

exchange
string opcional
binance-exchange

Filtre para artigos relacionados com este slug de exchange.

wallet
string opcional
frostsnap

Filtre para artigos relacionados com este slug de wallet.

search
string opcional
halving

Correspondência de texto livre no título/subtítulo.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/articles?page=1&per_page=20&locale=en&tag=guide&coin=bitcoin&exchange=binance-exchange&wallet=frostsnap&search=halving" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Obter um artigo

Um artigo publicado com o seu corpo completo, tags, imagem de destaque, contadores de utilidade e entidades relacionadas. locale escolhe o idioma do conteúdo com recurso ao inglês por campo (o payload indica que locale prevaleceu de facto).

GET
http://localhost/api/v1/articles/{slug}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
what-is-bitcoin

O slug do artigo.

Parâmetros de query

locale
string opcional
en

Idioma do conteúdo (recorre ao inglês).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/articles/what-is-bitcoin?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Submeter feedback de artigo

Regista um gosto/não gosto num artigo — os mesmos contadores que os botões de utilidade da web usam. Aplica-se limitação por chave a montante.

POST
http://localhost/api/v1/articles/{slug}/feedback
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

slug
string obrigatório
what-is-bitcoin

O slug do artigo.

Parâmetros de corpo

helpful
boolean obrigatório
true

true para útil, false para não útil.

Pedido

curl --request POST \
    "http://localhost/api/v1/articles/what-is-bitcoin/feedback" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"helpful\": true
}"

Obter um vídeo

Um vídeo selecionado com o seu id do YouTube, título, tipo, duração e as moedas/exchanges/wallets a que está associado.

GET
http://localhost/api/v1/videos/{id}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

id
integer obrigatório
87

O id do vídeo.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/videos/87" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Listar insights

Insights de mercado gerados por IA, paginados. Filtre por type, um slug de coin relacionado ou search de texto livre; locale escolhe o idioma do título/resumo com recurso ao inglês.

GET
http://localhost/api/v1/insights
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1).

per_page
integer opcional
20

Linhas por página (1–50, predefinição 20).

locale
string opcional
en

Idioma do conteúdo (recorre ao inglês).

type
string opcional
per_asset

Filtre por tipo de insight: per_asset, market_overview ou narrative.

coin
string opcional
bitcoin

Filtre para insights sobre este slug de moeda.

search
string opcional
etf

Correspondência de texto livre no título.

sort
string opcional
first_reported

Ordem de ordenação: first_reported (predefinição) ou last_updated.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/insights?page=1&per_page=20&locale=en&type=per_asset&coin=bitcoin&search=etf&sort=first_reported" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Obter um insight

Um insight com o seu payload completo — título, resumo, cronologia do artigo de origem e moedas relacionadas.

GET
http://localhost/api/v1/insights/{id}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

id
integer obrigatório
101

O id do insight.

Parâmetros de query

locale
string opcional
en

Idioma do conteúdo (recorre ao inglês).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/insights/101?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoints

Alarmes

CRUD de alarmes de preço — os mesmos alarmes que a aplicação web gere. Os alarmes consomem o saldo de inventário de alarmes do dono da chave, são do tipo TARGET apenas em moedas, e uma proteção de above/below vs valor atual bloqueia alarmes que se autodisparariam instantaneamente. Definidos por chave (a chave de API define o dono) e nunca colocados em cache de resposta.

Listar alarmes

Os alarmes do dono da chave, do mais recente para o mais antigo, paginados. Filtre por status, direction ou canal de notification.

GET
http://localhost/api/v1/alarms
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1).

per_page
integer opcional
25

Linhas por página (1–100, predefinição 25).

status
string opcional
active

Filtre por estado: active ou triggered.

direction
string opcional
above

Filtre por direção de disparo: above ou below.

notification
string opcional
email

Filtre por canal de entrega: email, push ou webhook.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/alarms?page=1&per_page=25&status=active&direction=above&notification=email" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Criar um alarme

Cria um alarme TARGET numa moeda e gasta um slot de alarme do saldo do dono da chave. O alvo é verificado em relação ao valor atual da moeda para que o alarme não se possa autodisparar instantaneamente: um alarme above deve visar mais do que o valor atual, um alarme below menos.

POST
http://localhost/api/v1/alarms
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de corpo

name
string obrigatório
BTC six figures

Um rótulo para o alarme (máx. 255 caracteres).

coin
string obrigatório
bitcoin

O identificador de slug da moeda.

metric
string obrigatório
rate

A métrica vigiada: rate, volume ou marketcap.

direction
string obrigatório
above

Direção de disparo: above ou below.

target
number obrigatório
100000

O valor do limiar (deve situar-se no lado direction do valor atual da moeda).

notification
string obrigatório
email

Canal de entrega: email, push ou webhook.

Pedido

curl --request POST \
    "http://localhost/api/v1/alarms" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"BTC six figures\",
    \"coin\": \"bitcoin\",
    \"metric\": \"rate\",
    \"direction\": \"above\",
    \"target\": 100000,
    \"notification\": \"email\"
}"

Eliminar um alarme

Elimina um dos alarmes do dono da chave e reembolsa o slot de alarme que consumiu.

DELETE
http://localhost/api/v1/alarms/{id}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

id
integer obrigatório
42

O id do alarme.

Pedido

curl --request DELETE \
    "http://localhost/api/v1/alarms/42" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 endpoints

Webhooks

A Bitculator faz POST de cada evento como JSON com um cabeçalho de assinatura HMAC:

X-Bitculator-Signature: t=<unix-ts>,v1=<hex hmac_sha256("<ts>.<raw-body>", secret)>
X-Bitculator-Event: alarm.triggered

Verifique-o recalculando o HMAC sobre "." com o segredo do seu endpoint e comparando em tempo constante; rejeite se t for mais antigo do que alguns minutos (proteção contra replay). Exemplo (PHP):

[$t, $v1] = sscanf($_SERVER['HTTP_X_BITCULATOR_SIGNATURE'], 't=%d,v1=%s');
$expected = hash_hmac('sha256', $t.'.'.file_get_contents('php://input'), $secret);
abort_unless(hash_equals($expected, $v1) && abs(time() - $t) < 300, 403);

Eventos suportados: alarm.triggered. As entregas são repetidas 3× com backoff; um endpoint desativa-se automaticamente após 10 entregas falhadas consecutivas.

Listar endpoints de webhook

Os endpoints de webhook do dono da chave, do mais recente para o mais antigo. Os segredos de assinatura nunca são incluídos — cada segredo é mostrado exatamente uma vez, na criação.

GET
http://localhost/api/v1/webhooks
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Criar um endpoint de webhook

Regista um endpoint HTTPS (máx. 5 por conta) para entregas de eventos. A resposta inclui o secret de assinatura — a ÚNICA vez em que é mostrado, por isso armazene-o imediatamente.

POST
http://localhost/api/v1/webhooks
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de corpo

url
string obrigatório
https://example.com/webhooks/bitculator

O URL de entrega HTTPS. Apenas hosts públicos — endereços internos/privados são rejeitados.

events
string[] obrigatório
["alarm.triggered"]

Eventos a subscrever. Valores permitidos: alarm.triggered.

Pedido

curl --request POST \
    "http://localhost/api/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/example.com\\/webhooks\\/bitculator\",
    \"events\": [
        \"alarm.triggered\"
    ]
}"

Eliminar um endpoint de webhook

Elimina um dos endpoints de webhook do dono da chave. As entregas pendentes para ele são abandonadas.

DELETE
http://localhost/api/v1/webhooks/{id}
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

id
integer obrigatório
7

O id do endpoint de webhook.

Pedido

curl --request DELETE \
    "http://localhost/api/v1/webhooks/7" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Enviar um evento de teste

Dispara um evento de teste alarm.triggered assinado (test: true no payload, cabeçalhos de assinatura reais) para que os recetores possam ser verificados de ponta a ponta.

POST
http://localhost/api/v1/webhooks/{id}/test
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

id
integer obrigatório
7

O id do endpoint de webhook.

Pedido

curl --request POST \
    "http://localhost/api/v1/webhooks/7/test" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Registo de entregas de webhook

As tentativas de entrega do endpoint (mantidas 30 dias), da mais recente para a mais antiga, paginadas.

GET
http://localhost/api/v1/webhooks/{id}/deliveries
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Parâmetros de caminho

id
integer obrigatório
7

O id do endpoint de webhook.

Parâmetros de query

page
integer opcional
1

Número da página (começa em 1).

per_page
integer opcional
25

Linhas por página (1–100, predefinição 25).

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/webhooks/7/deliveries?page=1&per_page=25" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 endpoints

Meta

Meta da API e introspeção: um ping autenticado para verificar uma chave e a pilha de middleware, o uso/cota da chave atual, e a especificação OpenAPI legível por máquina.

Especificação OpenAPI

O documento OpenAPI 3 legível por máquina para esta API, em JSON — aponte o codegen ou as ferramentas de API para este URL. Público: sem necessidade de chave.

GET
http://localhost/api/v1/openapi.json
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/openapi.json" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Ping

Uma no-op autenticada para verificar uma chave da Data API de ponta a ponta (auth.api → limitação de burst por plano → cota mensal). Conta para a cota como qualquer outra chamada.

GET
http://localhost/api/v1/ping
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/ping" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Uso e cota da chave

Introspeção de uso para o dono da chave que faz a chamada: o plano da Data API, o seu limite mensal, o usado e o restante (correspondendo sempre aos cabeçalhos X-Quota-*), a janela do período atual e decomposições por endpoint / por token. O uso de widgets de embed tem o seu próprio plano e conjunto — nunca aparece aqui.

GET
http://localhost/api/v1/usage
Bearer
bc_••••••••••••••••

As chaves são exclusivamente Bearer e possuem a capacidade data-api — mantenha-as no lado do servidor.

Pedido GET — sem corpo de pedido.

Pedido

curl --request GET \
    --get "http://localhost/api/v1/usage" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"