Bitculator
Bitculator · Data API · v1

Bitculator Data API

73 endpoint 15 gruppi X-Quota-* su ogni chiamata http://localhost/api/v1

Tutti gli endpoint si trovano sotto /api/v1 e richiedono una chiave Bearer con l'abilità data-api — creane una nella tua console per sviluppatori.

La tua prima chiamata:

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

Le risposte sono in JSON. Prezzi, tassi e offerte sono stringhe decimali (i float non possono trasportare la precisione di mercato); i conteggi e i valori analitici sono numeri. Ogni risposta riporta la tua quota in tempo reale negli header X-Quota-Limit / X-Quota-Used / X-Quota-Reset e gli errori usano sempre l'envelope {"error": {"code", "message", "details"}}.

La Data API ha una quota mensile propria, legata al tuo piano API e completamente separata dai tuoi widget embed. I limiti di per_page dipendono dal piano (Free 100, Starter/Pro 250); superare un limite restituisce 422 invece di troncare.

Autenticazione

Per autenticare le richieste, includi un header Authorization: Bearer {YOUR_API_KEY} in ogni richiesta.

Crea una chiave Data API nella tua console per sviluppatori — le chiavi sono solo Bearer e portano l'abilità data-api. Tienile lato server; non sono mai pensate per l'inclusione lato client.

Header di autorizzazione
Crea una chiave →
Bearer
bc_••••••••••••••••

Inviato come Authorization: Bearer {YOUR_API_KEY} in ogni richiesta.

9 endpoint

Coin

Dati di mercato classificati di coin e token: elenchi paginati, dettaglio per singola coin, movimenti (gainers/losers), aggiunte di recente, di tendenza e serie temporali per coin. Prezzi, marketcap e offerta sono STRINGHE decimali (i float non possono trasportare la precisione di mercato); le variazioni percentuali, i rank e i conteggi sono numeri.

Elenca le coin

Coin classificate con prezzi, filtri e selettori, paginate con l'envelope links + meta di Laravel. Prezzi, marketcap e circulating_supply sono stringhe decimali; le variazioni e i rank sono numeri.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

type
string facoltativo
coin

Limita a un singolo tipo di asset: coin o token.

Uno tra: coin token

status
string facoltativo
active

Stato di quotazione: active, delisted, untracked, progressing, awaiting o preparing. Predefinito a tutti gli stati pubblici.

Uno tra: active delisted untracked progressing awaiting preparing

search
string facoltativo
bitcoin

Ricerca a testo libero su nome o simbolo. Non deve superare i 100 caratteri.

min_price
number facoltativo
0.5

Solo coin con prezzo pari o superiore a questo valore in USD. Deve essere almeno 0.

max_price
number facoltativo
100000

Solo coin con prezzo pari o inferiore a questo valore in USD. Deve essere almeno 0.

min_marketcap
number facoltativo
1000000

Solo coin con marketcap in USD pari o superiore a questo valore. Deve essere almeno 0.

max_marketcap
number facoltativo
5000000000000

Solo coin con marketcap in USD pari o inferiore a questo valore. Deve essere almeno 0.

min_volume
number facoltativo
1000000

Solo coin con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo coin con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

ids
string facoltativo
38,39

Filtra a ID di coin specifici (CSV, fino a 100 selettori combinati con slugs/symbols). Non deve superare i 1000 caratteri.

slugs
string facoltativo
bitcoin,ethereum

Filtra a slug di coin specifici (CSV, fino a 100 selettori combinati). Non deve superare i 2000 caratteri.

symbols
string facoltativo
BTC,ETH

Filtra a simboli di coin specifici (CSV, case-insensitive, fino a 100 selettori combinati). Non deve superare i 1000 caratteri.

sort
string facoltativo
-marketcap

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: marketcap, rank, price, volume_24h, change_24h, change_7d. Non deve superare i 100 caratteri.

interval
string facoltativo
24h

Finestra dei movimenti solo per /coins/gainers e /coins/losers: 24h o 7d.

Uno tra: 24h 7d

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Coin aggiunte di recente

Le quotazioni più recenti — ordinate per status_updated_at (il timestamp di passaggio ad attivo; created_at è la data di crawl, che precede la quotazione di quantità arbitrarie). Stessa struttura di riga ed envelope di paginazione di List coins.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

type
string facoltativo
coin

Limita a un singolo tipo di asset: coin o token.

Uno tra: coin token

status
string facoltativo
active

Stato di quotazione: active, delisted, untracked, progressing, awaiting o preparing. Predefinito a tutti gli stati pubblici.

Uno tra: active delisted untracked progressing awaiting preparing

search
string facoltativo
bitcoin

Ricerca a testo libero su nome o simbolo. Non deve superare i 100 caratteri.

min_price
number facoltativo
0.5

Solo coin con prezzo pari o superiore a questo valore in USD. Deve essere almeno 0.

max_price
number facoltativo
100000

Solo coin con prezzo pari o inferiore a questo valore in USD. Deve essere almeno 0.

min_marketcap
number facoltativo
1000000

Solo coin con marketcap in USD pari o superiore a questo valore. Deve essere almeno 0.

max_marketcap
number facoltativo
5000000000000

Solo coin con marketcap in USD pari o inferiore a questo valore. Deve essere almeno 0.

min_volume
number facoltativo
1000000

Solo coin con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo coin con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

ids
string facoltativo
38,39

Filtra a ID di coin specifici (CSV, fino a 100 selettori combinati con slugs/symbols). Non deve superare i 1000 caratteri.

slugs
string facoltativo
bitcoin,ethereum

Filtra a slug di coin specifici (CSV, fino a 100 selettori combinati). Non deve superare i 2000 caratteri.

symbols
string facoltativo
BTC,ETH

Filtra a simboli di coin specifici (CSV, case-insensitive, fino a 100 selettori combinati). Non deve superare i 1000 caratteri.

sort
string facoltativo
-marketcap

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: marketcap, rank, price, volume_24h, change_24h, change_7d. Non deve superare i 100 caratteri.

interval
string facoltativo
24h

Finestra dei movimenti solo per /coins/gainers e /coins/losers: 24h o 7d.

Uno tra: 24h 7d

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Maggiori rialzi

I maggiori movimenti positivi nella finestra interval (24h predefinito, o 7d). Stessa struttura di riga ed envelope di paginazione di List coins.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

type
string facoltativo
coin

Limita a un singolo tipo di asset: coin o token.

Uno tra: coin token

status
string facoltativo
active

Stato di quotazione: active, delisted, untracked, progressing, awaiting o preparing. Predefinito a tutti gli stati pubblici.

Uno tra: active delisted untracked progressing awaiting preparing

search
string facoltativo
bitcoin

Ricerca a testo libero su nome o simbolo. Non deve superare i 100 caratteri.

min_price
number facoltativo
0.5

Solo coin con prezzo pari o superiore a questo valore in USD. Deve essere almeno 0.

max_price
number facoltativo
100000

Solo coin con prezzo pari o inferiore a questo valore in USD. Deve essere almeno 0.

min_marketcap
number facoltativo
1000000

Solo coin con marketcap in USD pari o superiore a questo valore. Deve essere almeno 0.

max_marketcap
number facoltativo
5000000000000

Solo coin con marketcap in USD pari o inferiore a questo valore. Deve essere almeno 0.

min_volume
number facoltativo
1000000

Solo coin con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo coin con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

ids
string facoltativo
38,39

Filtra a ID di coin specifici (CSV, fino a 100 selettori combinati con slugs/symbols). Non deve superare i 1000 caratteri.

slugs
string facoltativo
bitcoin,ethereum

Filtra a slug di coin specifici (CSV, fino a 100 selettori combinati). Non deve superare i 2000 caratteri.

symbols
string facoltativo
BTC,ETH

Filtra a simboli di coin specifici (CSV, case-insensitive, fino a 100 selettori combinati). Non deve superare i 1000 caratteri.

sort
string facoltativo
-marketcap

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: marketcap, rank, price, volume_24h, change_24h, change_7d. Non deve superare i 100 caratteri.

interval
string facoltativo
24h

Finestra dei movimenti solo per /coins/gainers e /coins/losers: 24h o 7d.

Uno tra: 24h 7d

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Maggiori ribassi

I maggiori movimenti negativi nella finestra interval (24h predefinito, o 7d). Stessa struttura di riga ed envelope di paginazione di List coins.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

type
string facoltativo
coin

Limita a un singolo tipo di asset: coin o token.

Uno tra: coin token

status
string facoltativo
active

Stato di quotazione: active, delisted, untracked, progressing, awaiting o preparing. Predefinito a tutti gli stati pubblici.

Uno tra: active delisted untracked progressing awaiting preparing

search
string facoltativo
bitcoin

Ricerca a testo libero su nome o simbolo. Non deve superare i 100 caratteri.

min_price
number facoltativo
0.5

Solo coin con prezzo pari o superiore a questo valore in USD. Deve essere almeno 0.

max_price
number facoltativo
100000

Solo coin con prezzo pari o inferiore a questo valore in USD. Deve essere almeno 0.

min_marketcap
number facoltativo
1000000

Solo coin con marketcap in USD pari o superiore a questo valore. Deve essere almeno 0.

max_marketcap
number facoltativo
5000000000000

Solo coin con marketcap in USD pari o inferiore a questo valore. Deve essere almeno 0.

min_volume
number facoltativo
1000000

Solo coin con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo coin con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

ids
string facoltativo
38,39

Filtra a ID di coin specifici (CSV, fino a 100 selettori combinati con slugs/symbols). Non deve superare i 1000 caratteri.

slugs
string facoltativo
bitcoin,ethereum

Filtra a slug di coin specifici (CSV, fino a 100 selettori combinati). Non deve superare i 2000 caratteri.

symbols
string facoltativo
BTC,ETH

Filtra a simboli di coin specifici (CSV, case-insensitive, fino a 100 selettori combinati). Non deve superare i 1000 caratteri.

sort
string facoltativo
-marketcap

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: marketcap, rank, price, volume_24h, change_24h, change_7d. Non deve superare i 100 caratteri.

interval
string facoltativo
24h

Finestra dei movimenti solo per /coins/gainers e /coins/losers: 24h o 7d.

Uno tra: 24h 7d

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Ottieni il dettaglio di una coin

Profilo completo di una singola coin. Oltre ai campi della lista aggiunge: supply (circulating/total/max), OHLC today, all_time_high / all_time_low (prezzo, data e percent_from rispetto al prezzo attuale), fully_diluted_valuation, counts di mercato (exchanges/pairs/tickers/wallets), decimals, genesis_date, links ufficiali (lista di url tipizzati), contracts del token e una description HTML localizzata (ripiega sull'inglese quando il locale richiesto manca). Tutti i campi di prezzo/offerta sono stringhe decimali.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

Parametri di query

locale
string facoltativo
en

Lingua del contenuto per la descrizione (ripiega sull'inglese).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Storico delle candele

Serie temporale per coin di OHLC + volume + marketcap. Scegli interval: minutely, half-hourly, hourly o daily. La retention è una proprietà rigida della pipeline di rollup — minutely 8 giorni, half-hourly 3 mesi, hourly 6 mesi, daily per sempre; le richieste oltre una finestra restituiscono ciò che esiste. Quando è impostato un limit ottieni le N righe PIÙ RECENTI nella finestra, emesse dalla più vecchia. I prezzi sono stringhe decimali.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

Parametri di query

interval
string facoltativo
daily

minutely, half-hourly, hourly o daily (predefinito daily).

start
string facoltativo
2026-06-01

Limite inferiore della data/ora ISO.

end
string facoltativo
2026-06-30

Limite superiore della data/ora ISO (un valore solo-data significa fino a tutto quel giorno).

limit
integer facoltativo
30

Righe massime (1–2000, predefinito 1000).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Storico del marketcap

Gli stessi rollup per coin di Candle history, proiettati solo su {time, marketcap}. Stesse scelte di interval e finestre di retention (minutely 8 giorni, half-hourly 3 mesi, hourly 6 mesi, daily per sempre), le N più recenti quando è impostato un limit.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

Parametri di query

interval
string facoltativo
daily

minutely, half-hourly, hourly o daily (predefinito daily).

start
string facoltativo
2026-06-01

Limite inferiore della data/ora ISO.

end
string facoltativo
2026-06-30

Limite superiore della data/ora ISO.

limit
integer facoltativo
30

Righe massime (1–2000, predefinito 1000).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 della coin

Una serie di prezzi compatta per la coin sul period scelto, per disegnare sparkline.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

Parametri di query

period
string facoltativo
7d

24h, 7d, 30d, 60d, 90d, 180d o 365d (predefinito 7d).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Prezzi

Il percorso rapido leggero per i prezzi — prezzo attuale, marketcap, volume 24h e variazioni recenti per un insieme richiesto di coin. /prices richiede un selettore (ids, slugs o symbols); /prices/{slug} punta a una singola coin. Facoltativamente convert in una valuta fiat (i prezzi crypto si aggiornano ~ogni minuto, i cambi fiat ~due volte al giorno). Prezzi e marketcap sono stringhe decimali.

Ottieni i prezzi

Prezzi per un insieme richiesto di coin. Passa almeno un selettore — ids, slugs o symbols (fino a 100 combinati). meta.currency riporta la valuta di destinazione della conversione (USD a meno che convert non sia impostato).

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

ids
string facoltativo
38,39

ID delle coin da prezzare (CSV). È richiesto almeno uno tra ids, slugs o symbols; le tre liste hanno un limite complessivo di 100 selettori. Questo campo è obbligatorio quando non è presente né slugssymbols. Non deve superare i 1000 caratteri.

slugs
string facoltativo
bitcoin,ethereum

Slug delle coin da prezzare (CSV). È richiesto almeno uno tra ids, slugs o symbols. Questo campo è obbligatorio quando non è presente né idssymbols. Non deve superare i 2000 caratteri.

symbols
string facoltativo
BTC,ETH

Simboli delle coin da prezzare (CSV, case-insensitive). È richiesto almeno uno tra ids, slugs o symbols. Questo campo è obbligatorio quando non è presente né idsslugs. Non deve superare i 1000 caratteri.

convert
string facoltativo
EUR

Converti prezzi/marketcap in una valuta fiat attiva per simbolo (predefinito USD). I tassi di cambio si aggiornano ~due volte al giorno.

Uno tra: 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

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Ottieni il prezzo di una coin

Istantanea del prezzo di una singola coin. Facoltativamente convert in una valuta fiat attiva per simbolo (predefinito USD).

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

Parametri di query

convert
string facoltativo
EUR

Simbolo della valuta fiat attiva in cui esprimere il prezzo (predefinito USD).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Prezzo storico

Il prezzo in USD della coin in una data specifica, letto dallo storico giornaliero (giorno esatto, fallback ±3 giorni — lo stesso resolver usato dal portafoglio). Solo crypto: le righe fiat non hanno storico giornaliero.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

slug
string obbligatorio
bitcoin

L'identificatore slug della coin.

date
string obbligatorio
2021-04-14

date La data di ricerca (dopo il 2008-12-31, non nel futuro).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Mercati

Ticker (mercati per exchange) e coppie (mercati aggregati per venue), più i mercati di una coin e i simboli di trading grezzi per exchange. È tutto dato istantaneo — non esiste storico per ticker/coppia. I volumi in USD sono numeri; i prezzi sono stringhe decimali.

Mercati della coin

Tutti i mercati di una coin — i ticker la cui coppia ha la coin come base O quotazione. Stessa struttura di riga e stessi filtri di List tickers.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

exchange
string facoltativo
binance-exchange

Limita a un singolo exchange per slug (ometti nell'elenco per exchange, che è già delimitato). Deve corrispondere all'espressione regolare /^[a-z0-9-]{1,120}$/.

pair
integer facoltativo
1

Limita a una singola coppia per id. Deve essere almeno 1.

instrument
string facoltativo
spot

Tipo di strumento: future, option, swap, spot o margin (plurali accettati).

Uno tra: future option swap spot margin

search
string facoltativo
BTC

Ricerca a testo libero sul simbolo del ticker. Non deve superare i 50 caratteri.

min_volume
number facoltativo
1000000

Solo ticker con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo ticker con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

min_change
number facoltativo
-50

Solo ticker con una variazione percentuale 24h pari o superiore a questo valore.

max_change
number facoltativo
50

Solo ticker con una variazione percentuale 24h pari o inferiore a questo valore.

sort
string facoltativo
-volume_usd

Un singolo campo di ordinamento (anteponi - per l'ordine decrescente). Ordinabile per: volume_usd, change_24h, price_usd, updated. Predefinito -volume_usd. Non deve superare i 100 caratteri.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Simboli di trading della coin

I simboli di trading grezzi per exchange della coin — dati di riferimento popolati in modo sparso (la copertura è best-effort).

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Elenca i ticker

Singoli mercati per exchange (ticker), paginati. Filtra per exchange, coppia, strumento e intervalli di volume/variazione. I volumi in USD sono numeri; i prezzi sono stringhe decimali.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

exchange
string facoltativo
binance-exchange

Limita a un singolo exchange per slug (ometti nell'elenco per exchange, che è già delimitato). Deve corrispondere all'espressione regolare /^[a-z0-9-]{1,120}$/.

pair
integer facoltativo
1

Limita a una singola coppia per id. Deve essere almeno 1.

instrument
string facoltativo
spot

Tipo di strumento: future, option, swap, spot o margin (plurali accettati).

Uno tra: future option swap spot margin

search
string facoltativo
BTC

Ricerca a testo libero sul simbolo del ticker. Non deve superare i 50 caratteri.

min_volume
number facoltativo
1000000

Solo ticker con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo ticker con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

min_change
number facoltativo
-50

Solo ticker con una variazione percentuale 24h pari o superiore a questo valore.

max_change
number facoltativo
50

Solo ticker con una variazione percentuale 24h pari o inferiore a questo valore.

sort
string facoltativo
-volume_usd

Un singolo campo di ordinamento (anteponi - per l'ordine decrescente). Ordinabile per: volume_usd, change_24h, price_usd, updated. Predefinito -volume_usd. Non deve superare i 100 caratteri.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Elenca le coppie

Coppie di trading aggregate per venue, classificate per volume USD 24h. Filtra per uno slug di coin (base o quotazione) e per intervallo di volume.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

search
string facoltativo
BTC

Ricerca a testo libero sul simbolo della coppia. Non deve superare i 50 caratteri.

coin
string facoltativo
bitcoin

Limita alle coppie in cui questo slug di coin è l'asset di base o di quotazione. Deve corrispondere all'espressione regolare /^[a-z0-9-]{1,120}$/.

min_volume
number facoltativo
1000000

Solo coppie con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo coppie con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

sort
string facoltativo
-volume_usd

Campo di ordinamento: volume_usd o updated (anteponi - per l'ordine decrescente). Predefinito -volume_usd.

Uno tra: volume_usd -volume_usd updated -updated

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Ottieni il dettaglio di una coppia

Una coppia più ogni ticker di exchange che la quota, ordinati per volume.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

id
integer obbligatorio
1

L'id della coppia.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Exchange

Classifiche degli exchange, dettaglio, trust score, serie temporali ed elenchi di mercati/coin per exchange. I volumi sono in USD. Non esiste una colonna CEX/DEX — type è derivato dalla tassonomia degli exchange, quindi può essere "cex", "dex" o null.

Elenca gli exchange

Exchange classificati con volume 24h, dominanza, conteggi di coppie/asset e variazioni recenti. Paginati con l'envelope links + meta di Laravel.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

type
string facoltativo
cex

Limita a un tipo di venue: cex o dex (risolto tramite la tassonomia degli exchange).

Uno tra: cex dex

search
string facoltativo
binance

Ricerca a testo libero sul nome dell'exchange. Non deve superare i 100 caratteri.

min_pairs
integer facoltativo
100

Solo exchange che quotano almeno questo numero di coppie. Deve essere almeno 0.

max_pairs
integer facoltativo
2000

Solo exchange che quotano al massimo questo numero di coppie. Deve essere almeno 0.

min_assets
integer facoltativo
50

Solo exchange che quotano almeno questo numero di asset. Deve essere almeno 0.

max_assets
integer facoltativo
1000

Solo exchange che quotano al massimo questo numero di asset. Deve essere almeno 0.

min_volume
number facoltativo
1000000

Solo exchange con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo exchange con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

ids
string facoltativo
1,12

Filtra a ID di exchange specifici (CSV, fino a 100). Non deve superare i 1000 caratteri.

slugs
string facoltativo
binance-exchange,gateio

Filtra a slug di exchange specifici (CSV, fino a 100). Non deve superare i 2000 caratteri.

sort
string facoltativo
-volume

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: volume, rank, volume_dominance, change_24h, change_7d, pairs, assets. Non deve superare i 100 caratteri.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Ottieni il dettaglio di un exchange

Profilo completo di un singolo exchange: classifica, volume/dominanza, conteggi di coppie e asset, data established, location, website di referral e il type derivato (cex/dex/null).

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
binance-exchange

Lo slug dell'exchange.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Ottieni il trust score di un exchange

Uno score di affidabilità aggregato 0–10 più il suo breakdown a 13 fattori (rank, volume, age, volume_trend, stability, rank_stability, ticker_health, pairs, community, assets, dominance, market_breadth, transparency). Calcolato per exchange e messo in cache 24h.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
binance-exchange

Lo slug dell'exchange.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Storico dell'exchange

Serie temporale di volume / dominanza / coppie / asset (i rollup degli exchange non portano OHLC). Scegli interval: minutely, hourly o daily. La retention è una proprietà rigida della pipeline di rollup — minutely 8 giorni, hourly 6 mesi, daily per sempre; quando è impostato un limit ottieni le N righe più recenti nella finestra, dalla più vecchia.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
binance-exchange

Lo slug dell'exchange.

Parametri di query

interval
string facoltativo
daily

minutely, hourly o daily (predefinito daily).

start
string facoltativo
2026-06-01

Limite inferiore della data/ora ISO.

end
string facoltativo
2026-06-30

Limite superiore della data/ora ISO (un valore solo-data significa fino a tutto quel giorno).

limit
integer facoltativo
30

Righe massime (1–2000, predefinito 1000).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 dell'exchange

La serie sparkline del volume dell'exchange per un periodo (predefinito 7d) — la stessa serie resa dalle righe degli exchange sul sito web.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
binance-exchange

Lo slug dell'exchange.

Parametri di query

period
string facoltativo
7d

Uno tra 24h, 7d (predefinito), 30d, 60d, 90d, 180d, 365d.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Mercati dell'exchange

Gli elenchi di ticker dell'exchange (i suoi mercati), paginati. Già delimitati all' exchange — non passare qui un parametro exchange.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
binance-exchange

Lo slug dell'exchange.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

exchange
string facoltativo
binance-exchange

Limita a un singolo exchange per slug (ometti nell'elenco per exchange, che è già delimitato). Deve corrispondere all'espressione regolare /^[a-z0-9-]{1,120}$/.

pair
integer facoltativo
1

Limita a una singola coppia per id. Deve essere almeno 1.

instrument
string facoltativo
spot

Tipo di strumento: future, option, swap, spot o margin (plurali accettati).

Uno tra: future option swap spot margin

search
string facoltativo
BTC

Ricerca a testo libero sul simbolo del ticker. Non deve superare i 50 caratteri.

min_volume
number facoltativo
1000000

Solo ticker con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo ticker con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

min_change
number facoltativo
-50

Solo ticker con una variazione percentuale 24h pari o superiore a questo valore.

max_change
number facoltativo
50

Solo ticker con una variazione percentuale 24h pari o inferiore a questo valore.

sort
string facoltativo
-volume_usd

Un singolo campo di ordinamento (anteponi - per l'ordine decrescente). Ordinabile per: volume_usd, change_24h, price_usd, updated. Predefinito -volume_usd. Non deve superare i 100 caratteri.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Coin dell'exchange

Coin quotate sull'exchange, restituite nella stessa struttura di List coins e con gli stessi filtri/ordinamenti.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
binance-exchange

Lo slug dell'exchange.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

type
string facoltativo
coin

Limita a un singolo tipo di asset: coin o token.

Uno tra: coin token

status
string facoltativo
active

Stato di quotazione: active, delisted, untracked, progressing, awaiting o preparing. Predefinito a tutti gli stati pubblici.

Uno tra: active delisted untracked progressing awaiting preparing

search
string facoltativo
bitcoin

Ricerca a testo libero su nome o simbolo. Non deve superare i 100 caratteri.

min_price
number facoltativo
0.5

Solo coin con prezzo pari o superiore a questo valore in USD. Deve essere almeno 0.

max_price
number facoltativo
100000

Solo coin con prezzo pari o inferiore a questo valore in USD. Deve essere almeno 0.

min_marketcap
number facoltativo
1000000

Solo coin con marketcap in USD pari o superiore a questo valore. Deve essere almeno 0.

max_marketcap
number facoltativo
5000000000000

Solo coin con marketcap in USD pari o inferiore a questo valore. Deve essere almeno 0.

min_volume
number facoltativo
1000000

Solo coin con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo coin con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

ids
string facoltativo
38,39

Filtra a ID di coin specifici (CSV, fino a 100 selettori combinati con slugs/symbols). Non deve superare i 1000 caratteri.

slugs
string facoltativo
bitcoin,ethereum

Filtra a slug di coin specifici (CSV, fino a 100 selettori combinati). Non deve superare i 2000 caratteri.

symbols
string facoltativo
BTC,ETH

Filtra a simboli di coin specifici (CSV, case-insensitive, fino a 100 selettori combinati). Non deve superare i 1000 caratteri.

sort
string facoltativo
-marketcap

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: marketcap, rank, price, volume_24h, change_24h, change_7d. Non deve superare i 100 caratteri.

interval
string facoltativo
24h

Finestra dei movimenti solo per /coins/gainers e /coins/losers: 24h o 7d.

Uno tra: 24h 7d

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Wallet

Recensioni di wallet crypto — score della recensione, numero di asset supportati, conteggi di pro/contro, modello di prezzo e data di rilascio, più una tassonomia di tag raggruppati nelle risposte di dettaglio/confronto. meta.top_score è il punteggio più alto tra tutti i wallet (usalo per normalizzare i punteggi in un intervallo 0–1).

Elenca i wallet

Wallet recensiti con punteggio, numero di asset, conteggi di pro/contro, modello di prezzo, stato e data di rilascio. Paginati con l'envelope links + meta di Laravel, più meta.top_score.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

search
string facoltativo
ledger

Ricerca a testo libero sul nome del wallet. Non deve superare i 100 caratteri.

min_score
integer facoltativo
50

Solo wallet con un punteggio di recensione pari o superiore a questo valore. Deve essere almeno 0.

max_score
integer facoltativo
214

Solo wallet con un punteggio di recensione pari o inferiore a questo valore. Deve essere almeno 0.

tags
string facoltativo
12,34

Filtra per tassonomia dei tag: ID dei gruppi di categoria separati da virgola (gli stessi ID inviati dai filtri a faccette del sito web). Non deve superare i 1000 caratteri.

ids
string facoltativo
175,317

Filtra a ID di wallet specifici (CSV, fino a 100). Non deve superare i 1000 caratteri.

slugs
string facoltativo
frostsnap,coin98-fusion-card

Filtra a slug di wallet specifici (CSV, fino a 100). Non deve superare i 2000 caratteri.

sort
string facoltativo
-score

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: score, released_at, assets, pros, cons. Non deve superare i 100 caratteri.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Timeline delle release dei wallet

La lista dei wallet fissata su released_at decrescente (i wallet senza data per ultimi). Stessa struttura di riga ed envelope di paginazione di List wallets.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

search
string facoltativo
ledger

Ricerca a testo libero sul nome del wallet. Non deve superare i 100 caratteri.

min_score
integer facoltativo
50

Solo wallet con un punteggio di recensione pari o superiore a questo valore. Deve essere almeno 0.

max_score
integer facoltativo
214

Solo wallet con un punteggio di recensione pari o inferiore a questo valore. Deve essere almeno 0.

tags
string facoltativo
12,34

Filtra per tassonomia dei tag: ID dei gruppi di categoria separati da virgola (gli stessi ID inviati dai filtri a faccette del sito web). Non deve superare i 1000 caratteri.

ids
string facoltativo
175,317

Filtra a ID di wallet specifici (CSV, fino a 100). Non deve superare i 1000 caratteri.

slugs
string facoltativo
frostsnap,coin98-fusion-card

Filtra a slug di wallet specifici (CSV, fino a 100). Non deve superare i 2000 caratteri.

sort
string facoltativo
-score

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: score, released_at, assets, pros, cons. Non deve superare i 100 caratteri.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Confronta wallet

Confronto fianco a fianco di 2–4 wallet con la loro tassonomia completa di tag raggruppati. data[] mantiene l'ordine degli slug richiesti così i consumatori possono rendere le colonne posizionalmente.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

slugs
string obbligatorio
frostsnap,coin98-fusion-card

2–4 slug di wallet distinti, separati da virgola.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Ottieni il dettaglio di un wallet

Profilo completo di un singolo wallet compresa la tassonomia di tag raggruppati: categories è una lista di {group, tags[]} dove ogni tag ha uno slug, un nome e un valore facoltativo. meta.top_score è il punteggio più alto tra tutti i wallet.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
frostsnap

Lo slug del wallet.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Coin supportate dal wallet

Coin supportate dal wallet, restituite nella stessa struttura di List coins e con gli stessi filtri/ordinamenti.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
frostsnap

Lo slug del wallet.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

type
string facoltativo
coin

Limita a un singolo tipo di asset: coin o token.

Uno tra: coin token

status
string facoltativo
active

Stato di quotazione: active, delisted, untracked, progressing, awaiting o preparing. Predefinito a tutti gli stati pubblici.

Uno tra: active delisted untracked progressing awaiting preparing

search
string facoltativo
bitcoin

Ricerca a testo libero su nome o simbolo. Non deve superare i 100 caratteri.

min_price
number facoltativo
0.5

Solo coin con prezzo pari o superiore a questo valore in USD. Deve essere almeno 0.

max_price
number facoltativo
100000

Solo coin con prezzo pari o inferiore a questo valore in USD. Deve essere almeno 0.

min_marketcap
number facoltativo
1000000

Solo coin con marketcap in USD pari o superiore a questo valore. Deve essere almeno 0.

max_marketcap
number facoltativo
5000000000000

Solo coin con marketcap in USD pari o inferiore a questo valore. Deve essere almeno 0.

min_volume
number facoltativo
1000000

Solo coin con volume USD 24h pari o superiore a questo valore. Deve essere almeno 0.

max_volume
number facoltativo
100000000000

Solo coin con volume USD 24h pari o inferiore a questo valore. Deve essere almeno 0.

ids
string facoltativo
38,39

Filtra a ID di coin specifici (CSV, fino a 100 selettori combinati con slugs/symbols). Non deve superare i 1000 caratteri.

slugs
string facoltativo
bitcoin,ethereum

Filtra a slug di coin specifici (CSV, fino a 100 selettori combinati). Non deve superare i 2000 caratteri.

symbols
string facoltativo
BTC,ETH

Filtra a simboli di coin specifici (CSV, case-insensitive, fino a 100 selettori combinati). Non deve superare i 1000 caratteri.

sort
string facoltativo
-marketcap

Campi di ordinamento separati da virgola; anteponi - per l'ordine decrescente. Ordinabile per: marketcap, rank, price, volume_24h, change_24h, change_7d. Non deve superare i 100 caratteri.

interval
string facoltativo
24h

Finestra dei movimenti solo per /coins/gainers e /coins/losers: 24h o 7d.

Uno tra: 24h 7d

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Mercato globale

Aggregati a livello di mercato — marketcap e volume totali, conteggi di asset/exchange/coppia/mercato, dominanza BTC/ETH con una top-3 basata sul rank, la lettura Fear & Greed di mercato, più una heatmap top-100 e lo storico di marketcap/volume.

Istantanea del mercato globale

Panoramica di mercato immediata: marketcap totale e volume 24h, conteggi di criptovalute / token / exchange / coppie / mercati, dominance (quota di BTC ed ETH più il top3 basato sul rank) e la lettura fear_greed di mercato.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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

Mappa di calore del mercato

Righe treemap della top-100 più statistiche di contesto (marketcap/volume totali, dominanza e il punteggio Fear & Greed di mercato) — il gemello API della heatmap web.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Storico globale di marketcap / volume

Serie temporale del mercato totale per marketcap o volume. La granularità segue il period: 24h = half-hourly, 7d = hourly, 30d/all = daily (i rollup più fini vengono eliminati).

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

metric
string obbligatorio
marketcap

Quale serie: marketcap o volume.

Parametri di query

period
string facoltativo
7d

24h, 7d, 30d o all (predefinito 24h).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Sentiment

Indici di sentiment di mercato e per singola coin. Fear & Greed e Bull/Bear sono ISTANTANEE aggiornate ogni 15 minuti — esiste solo la lettura corrente, per esse non c'è serie temporale. Altseason porta lo storico giornaliero completo. indicators è il conteggio tecnico a livello di mercato.

Conteggi dei voti della community

I conteggi rialzisti/ribassisti della community per la coin nella finestra mobile di 24h.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

L'identificatore slug della coin.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Esprimi un voto sul sentiment

Registra il voto sul sentiment del proprietario della chiave per una coin. Un voto per proprietario della chiave per coin per finestra mobile di 24h — rivotare all'interno della finestra aggiorna il voto esistente.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

L'identificatore slug della coin.

Parametri del body

vote
string obbligatorio
bullish

Il tuo sentiment: bullish o bearish.

Richiesta

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\"
}"

Indice Fear & Greed

La lettura Fear & Greed corrente (un'istantanea di 15 minuti — nessuno storico). Ometti coin per l'indice a livello di mercato, o passa uno slug di coin per una lettura per singola coin. intervals porta i sotto-punteggi a 7d/30d e la scomposizione delle loro componenti.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

coin
string facoltativo
bitcoin

Slug della coin per una lettura per singola coin; ometti per l'indice di mercato.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Indice Bull / Bear

La lettura Bull/Bear corrente (un'istantanea di 15 minuti — nessuno storico). Ometti coin per l'indice a livello di mercato, o passa uno slug di coin per una lettura per singola coin.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

coin
string facoltativo
bitcoin

Slug della coin per una lettura per singola coin; ometti per l'indice di mercato.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Indice altseason

La lettura altseason corrente (numero di coin che battono BTC tra le prime 100), con history giornaliero facoltativo. A differenza di Fear & Greed, altseason ha storico giornaliero completo — passa days per includerlo.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

days
integer facoltativo
30

Giorni di storico giornaliero da includere (1–365; 0/omesso = solo il valore corrente).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Conteggio degli indicatori di mercato

Il conteggio tecnico a livello di mercato — 25 categorie di indicatori aggregate, ciascuna con il suo stato corrente, punteggio e dati di categoria.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Indicatori

Indicatori tecnici per coin — un'istantanea multi-indicatore più serie temporali giornaliere per famiglia. Tutte le famiglie sono serie GIORNALIERE calcolate dalle candele giornaliere (retention completa; gli asset giovani restituiscono null di warm-up finché non esiste storico sufficiente). Le famiglie a scala di prezzo (sma, vwap, macd, obv) emettono stringhe decimali; gli oscillatori limitati emettono numeri. Alcuni periodi a finestra lunga richiedono un piano a pagamento (vedi l'endpoint della famiglia).

Istantanea dell'indicatore

L'istantanea multi-indicatore — l'ultimo state di ogni categoria di indicatori (rialzista/ribassista/timido…), score e data grezzi, in un unico payload.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Serie della famiglia di indicatori

La serie temporale giornaliera di una famiglia di indicatori. Le famiglie con più finestre accettano un period, e le finestre valide differiscono per famiglia: 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. Le famiglie a serie singola (MACD, OBV, ADX, VWAP, CMF) ignorano period. Le coin giovani restituiscono null iniziali di warm-up.

Alcune finestre lunghe richiedono un piano a pagamento: RSI e Stoch-RSI a 21/28 giorni e le finestre di volatilità a 30 giorni richiedono Starter o superiore — richiederle sul piano Free restituisce 403 con codice plan_required.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

Lo slug della coin.

family
string obbligatorio
rsi

Famiglia di indicatori — una tra rsi, stoch-rsi, sma, cci, mfi, williams-r, price-volatility, volume-volatility, macd, obv, adx, vwap, cmf.

Parametri di query

period
integer facoltativo
14

Lunghezza della finestra (solo dove la famiglia ha finestre; deve essere una delle finestre valide di quella famiglia).

start
string facoltativo
2026-06-01

Limite inferiore della data ISO.

end
string facoltativo
2026-06-30

Limite superiore della data ISO.

limit
integer facoltativo
30

Righe massime (1–1000, predefinito 365).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Liquidazioni

Liquidazioni sui derivati. La copertura delle fonti è attualmente solo i mercati swap di OKX (indicato in ogni meta.note). Il feed GREZZO (la lista /liquidations e la scomposizione oraria) viene eliminato dopo ~48 ore; i rollup giornalieri sono conservati per sempre. Gli aggregati di oggi sono parziali e si aggiornano ogni ~15 minuti.

Feed delle liquidazioni

Il feed grezzo delle liquidazioni (~ultime 48h, poi eliminato), dal più recente. La copertura delle fonti è attualmente i mercati swap di OKX. I prezzi sono stringhe decimali. meta porta i campi di paginazione più un retention e un note.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1). Deve essere almeno 1.

per_page
integer facoltativo
50

Righe per pagina. Il limite dipende dal piano (Free 100, Starter/Pro 250); superarlo restituisce 422 invece di troncare. Deve essere almeno 1. Non deve superare 100.

exchange
string facoltativo
okx

Limita a un singolo exchange per slug. La copertura delle fonti è attualmente i mercati swap di OKX. Deve corrispondere all'espressione regolare /^[a-z0-9-]{1,120}$/.

instrument
string facoltativo
swap

Tipo di strumento: future, option, swap, spot o margin.

Uno tra: future option swap spot margin

position
string facoltativo
short

Lato della posizione liquidata: long o short.

Uno tra: long short

order
string facoltativo
buy

Lato dell'esecuzione che ha innescato la liquidazione: buy o sell.

Uno tra: buy sell

symbol
string facoltativo
BTC

Corrispondenza per prefisso sull'instId del venue (es. BTC corrisponde a BTC-USDT-SWAP). Deve corrispondere all'espressione regolare /^[A-Za-z0-9$.-]{1,25}$/.

min_usd
number facoltativo
1000

Solo liquidazioni con un valore in USD pari o superiore a questa soglia. Deve essere almeno 0.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Liquidazioni orarie

Totali USD orari long/short sul feed grezzo. Poiché il feed grezzo viene eliminato a ~48h, hours è limitato a 48. La copertura delle fonti è attualmente i mercati swap di OKX.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

hours
integer facoltativo
24

Finestra retrospettiva in ore (1–48, predefinito 24).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Liquidazioni giornaliere

Aggregati giornalieri (conservati per sempre), sommati su exchange/strumenti per giorno — USD total/long/short più i conteggi delle posizioni long/short. La riga di oggi è parziale e si aggiorna ogni ~15 minuti. La copertura delle fonti è attualmente i mercati swap di OKX.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

days
integer facoltativo
30

Numero di giorni di calendario compreso oggi (1–365, predefinito 30).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Riepilogo delle liquidazioni di oggi

Oggi finora — USD total/long/short, conteggi delle posizioni e dominance long-vs-short. Le cifre sono parziali e si aggiornano ogni ~15 minuti; data è null finché non viene registrata la prima liquidazione del giorno. La copertura delle fonti è attualmente i mercati swap di OKX.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Netflow delle liquidazioni

Flusso USD delle liquidazioni long-vs-short per giorno nella finestra. La copertura delle fonti è attualmente i mercati swap di OKX.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

days
integer facoltativo
30

Numero di giorni di calendario compreso oggi (1–90, predefinito 30).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Coin più liquidate

Le principali coin per volume di liquidazioni nella finestra recente, con la suddivisione USD long/short per coin. La copertura delle fonti è attualmente i mercati swap di OKX.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

hours
integer facoltativo
24

Finestra retrospettiva in ore (1–48, predefinito 24).

limit
integer facoltativo
8

Numero di coin da restituire (1–20, predefinito 8).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Conversione

Converti tra due qualsiasi asset attivi (crypto E fiat) ed elenca le valute utilizzabili come tappe di conversione. I valori sono stringhe decimali. I tassi di cambio fiat si aggiornano ~due volte al giorno; i tassi crypto ~ogni minuto.

Converti tra asset

Conversione lato server tra due qualsiasi asset attivi (crypto E fiat). to accetta un CSV per la conversione multi-destinazione; invertire equivale a scambiare from/to. La conversione è lineare, quindi value = unit_rate * amount. I tassi di cambio fiat si aggiornano ~due volte al giorno; i tassi crypto ~ogni minuto.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

from
string obbligatorio
bitcoin

Slug dell'asset di origine.

to
string obbligatorio
ethereum

Slug dell'asset (o asset) di destinazione, separati da virgola (fino a 10).

amount
number facoltativo
2.5

Quantità dell'asset di origine da convertire (predefinito 1).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Elenca le valute fiat

Le valute fiat attive con i loro tassi di cambio in USD: rate_per_usd (unità per USD) e il suo inverso usd_value. I tassi di cambio fiat si aggiornano ~due volte al giorno.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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

Elenca i tassi di conversione

Le vs-currencies utilizzabili come tappe di conversione — le principali fiat, coin e token — ciascuna con un usd_value normalizzato (USD per una unità). I valori di coin/token si aggiornano ~ogni minuto; i tassi fiat più lenti sono memorizzati in cache separatamente (~due volte al giorno).

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Calcolatori

Calcolatori finanziari lato server che rispecchiano gli strumenti web: DCA, profitti/perdite e prestito (che leggono dati di mercato in cache), più matematica stateless di interesse composto e staking.

Calcolatore DCA

Backtest del dollar-cost averaging sullo storico reale dei prezzi giornalieri della coin: un acquisto di amount per ogni interval tra start e end. Passa series=true per includere la serie completa per singolo acquisto.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

slug
string obbligatorio
bitcoin

L'identificatore slug della coin.

amount
number obbligatorio
100

USD spesi per acquisto (0.01–1,000,000,000).

interval
string obbligatorio
weekly

Cadenza di acquisto: daily, weekly, monthly, quarterly o yearly.

start
string obbligatorio
2024-01-01

date Data del primo acquisto (dopo il 2008-12-31).

end
string facoltativo
2025-01-01

date Data dell'ultimo acquisto (predefinito a oggi).

series
boolean facoltativo
false

Includi la serie per singolo acquisto nel payload.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Calcolatore di profitti / perdite

Il rendimento di un acquisto-poi-vendita tra due date storiche, usando i prezzi reali della coin in quelle date. Le commissioni sono importi fissi in USD, non percentuali.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

slug
string obbligatorio
bitcoin

L'identificatore slug della coin.

amount
number obbligatorio
1000

USD investiti alla buy_date (0.01–1,000,000,000).

buy_date
string obbligatorio
2023-01-01

date Data di acquisto.

sell_date
string obbligatorio
2025-01-01

date Data di vendita (in data/dopo buy_date).

buy_fee
number facoltativo
10

Commissione fissa di acquisto in USD (predefinito 0).

sell_fee
number facoltativo
10

Commissione fissa di vendita in USD (predefinito 0).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Calcolatore di interesse composto

Matematica pura — nessun dato di mercato. Nota che il tasso si applica PER PERIODO DI CAPITALIZZAZIONE (la convenzione del calcolatore web), non annualmente.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

principal
number obbligatorio
10000

Saldo iniziale in USD.

rate
number obbligatorio
1

Tasso di interesse in % per periodo di capitalizzazione.

duration
integer obbligatorio
5

Durata della proiezione (gli anni sono limitati a 50).

duration_unit
string facoltativo
years

years (predefinito) o months.

compound_frequency
string facoltativo
monthly

daily, weekly, monthly (predefinito), quarterly o annually.

contribution
number facoltativo
100

Deposito ricorrente in USD (predefinito 0).

contribution_frequency
string facoltativo
monthly

daily, weekly, monthly (predefinito), quarterly o annually.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Calcolatore prestito vs vendita

Prendere in prestito con crypto in garanzia vs venderla — confronta entrambi gli scenari usando il prezzo ATTUALE della coin. Proiezione informativa, non consulenza finanziaria.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

slug
string obbligatorio
bitcoin

L'identificatore slug della coin.

crypto_amount
number obbligatorio
2

Quanta parte della coin possiedi.

needed_cash
number obbligatorio
50000

USD che devi liberare.

term_months
integer facoltativo
36

Durata del prestito in mesi (predefinito 36).

interest_rate
number facoltativo
10

TAEG del prestito in % (predefinito 10).

ltv
number facoltativo
50

Rapporto prestito/valore (LTV) in % (predefinito 50).

expected_growth
number facoltativo
25

Crescita attesa del prezzo della coin nel periodo in % (predefinito 25).

tax_rate
number facoltativo
25

Imposta sulle plusvalenze in % applicata alla vendita (predefinito 25).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Calcolatore delle ricompense di staking

Matematica pura — ricompense di staking con capitalizzazione facoltativa e una commissione del validatore. Non viene letto alcun dato di mercato.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

amount
number obbligatorio
1000

Quantità in staking, nelle unità dell'asset in staking.

period
number obbligatorio
2

Durata del periodo di staking (limitata all'equivalente di 50 anni).

period_unit
string facoltativo
years

years (predefinito), months o days.

apy
number obbligatorio
5

APY pubblicizzato in %.

compound_frequency
string facoltativo
monthly

never, daily, weekly, monthly (predefinito) o yearly.

commission
number facoltativo
10

Commissione del validatore in %, prelevata dalle ricompense (predefinito 0).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Editoriale

Articoli editoriali — solo pubblicati (ACTIVE). locale seleziona la lingua del contenuto con fallback all'inglese per campo (il payload indica quale locale ha effettivamente prevalso). Gli articoli possono essere filtrati per tag o per uno slug coin/exchange/wallet correlato. Le letture tramite API deliberatamente NON incrementano i conteggi delle visualizzazioni.

Video della coin

Video curati associati a una coin (la scheda Video della pagina della coin), paginati.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

L'identificatore slug della coin.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1).

per_page
integer facoltativo
10

Righe per pagina (1–50, predefinito 10).

type
string facoltativo
review

Filtra per tipo di video (es. overview, tutorial, explainer, review, analysis, news).

search
string facoltativo
halving

Ricerca a testo libero sul titolo.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Timeline degli insight della coin

La timeline degli insight della coin — lo stesso payload usato dal pannello insight della pagina dell'asset, delimitato da offset/limit.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
bitcoin

L'identificatore slug della coin.

Parametri di query

locale
string facoltativo
en

Lingua del contenuto (ripiega sull'inglese).

offset
integer facoltativo
0

Righe da saltare (0–500, predefinito 0).

limit
integer facoltativo
5

Righe da restituire (1–50, predefinito 5).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Elenca gli articoli

Articoli pubblicati, dal più recente, paginati. Filtra per tag o per uno slug coin / exchange / wallet correlato, o per search a testo libero. Ogni riga è un riepilogo (titolo, sottotitolo, tag, tempo di lettura, immagine hero, entità correlate, date).

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1).

per_page
integer facoltativo
20

Righe per pagina (1–50, predefinito 20).

locale
string facoltativo
en

Lingua del contenuto (ripiega sull'inglese).

tag
string facoltativo
guide

Filtra per tag: news, guide, tutorial, explainer, analysis, review, trading, overview o information.

coin
string facoltativo
bitcoin

Filtra agli articoli correlati a questo slug di coin.

exchange
string facoltativo
binance-exchange

Filtra agli articoli correlati a questo slug di exchange.

wallet
string facoltativo
frostsnap

Filtra agli articoli correlati a questo slug di wallet.

search
string facoltativo
halving

Ricerca a testo libero su titolo/sottotitolo.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Ottieni un articolo

Un articolo pubblicato con il suo corpo completo, tag, immagine hero, contatori di utilità ed entità correlate. locale seleziona la lingua del contenuto con fallback all'inglese per campo (il payload indica quale locale ha effettivamente prevalso).

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
what-is-bitcoin

Lo slug dell'articolo.

Parametri di query

locale
string facoltativo
en

Lingua del contenuto (ripiega sull'inglese).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Invia un feedback sull'articolo

Registra un pollice su/giù su un articolo — gli stessi contatori usati dai pulsanti di utilità del sito web. A monte si applica un throttling per chiave.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

slug
string obbligatorio
what-is-bitcoin

Lo slug dell'articolo.

Parametri del body

helpful
boolean obbligatorio
true

true per utile, false per non utile.

Richiesta

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
}"

Ottieni un video

Un video curato con il suo id YouTube, titolo, tipo, durata e i coin/exchange/wallet a cui è associato.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

id
integer obbligatorio
87

L'id del video.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Elenca gli insight

Insight di mercato generati dall'AI, paginati. Filtra per type, uno slug coin correlato o search a testo libero; locale seleziona la lingua di titolo/riepilogo con fallback all'inglese.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1).

per_page
integer facoltativo
20

Righe per pagina (1–50, predefinito 20).

locale
string facoltativo
en

Lingua del contenuto (ripiega sull'inglese).

type
string facoltativo
per_asset

Filtra per tipo di insight: per_asset, market_overview o narrative.

coin
string facoltativo
bitcoin

Filtra agli insight relativi a questo slug di coin.

search
string facoltativo
etf

Ricerca a testo libero sul titolo.

sort
string facoltativo
first_reported

Ordinamento: first_reported (predefinito) o last_updated.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Ottieni un insight

Un insight con il suo payload completo — titolo, riepilogo, timeline dell'articolo di origine e coin correlate.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

id
integer obbligatorio
101

L'id dell'insight.

Parametri di query

locale
string facoltativo
en

Lingua del contenuto (ripiega sull'inglese).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Allarmi

CRUD degli allarmi di prezzo — gli stessi allarmi gestiti dalla web app. Gli allarmi consumano il saldo dell'inventario allarmi del proprietario della chiave, sono di tipo TARGET solo su coin e una protezione above/below rispetto al valore attuale blocca gli allarmi che si auto-attiverebbero immediatamente. Legati alla chiave (la chiave API imposta il proprietario) e mai memorizzati nella cache delle risposte.

Elenca gli allarmi

Gli allarmi del proprietario della chiave, dal più recente, paginati. Filtra per status, direction o canale notification.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1).

per_page
integer facoltativo
25

Righe per pagina (1–100, predefinito 25).

status
string facoltativo
active

Filtra per stato: active o triggered.

direction
string facoltativo
above

Filtra per direzione di attivazione: above o below.

notification
string facoltativo
email

Filtra per canale di consegna: email, push o webhook.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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"

Crea un allarme

Crea un allarme TARGET su una coin e consuma uno slot allarme dal saldo del proprietario della chiave. Il target viene confrontato con il valore attuale della coin, così l'allarme non può auto-attivarsi immediatamente: un allarme above deve avere come target più del valore attuale, un allarme below meno.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del body

name
string obbligatorio
BTC six figures

Un'etichetta per l'allarme (max 255 caratteri).

coin
string obbligatorio
bitcoin

L'identificatore slug della coin.

metric
string obbligatorio
rate

La metrica monitorata: rate, volume o marketcap.

direction
string obbligatorio
above

Direzione di attivazione: above o below.

target
number obbligatorio
100000

Il valore di soglia (deve trovarsi dal lato direction rispetto al valore attuale della coin).

notification
string obbligatorio
email

Canale di consegna: email, push o webhook.

Richiesta

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\"
}"

Elimina un allarme

Elimina uno degli allarmi del proprietario della chiave e rimborsa lo slot allarme che aveva consumato.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

id
integer obbligatorio
42

L'id dell'allarme.

Richiesta

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 endpoint

Webhooks

Bitculator invia in POST ogni evento come JSON con un header di firma HMAC:

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

Verificalo ricalcolando l'HMAC su "." con il segreto del tuo endpoint e confrontando a tempo costante; rifiuta se t è più vecchio di qualche minuto (protezione dai replay). Esempio (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);

Eventi supportati: alarm.triggered. Le consegne vengono ritentate 3× con backoff; un endpoint si disabilita automaticamente dopo 10 consegne fallite consecutive.

Elenca gli endpoint webhook

Gli endpoint webhook del proprietario della chiave, dal più recente. I segreti di firma non sono mai inclusi — ogni segreto viene mostrato esattamente una volta, alla creazione.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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

Crea un endpoint webhook

Registra un endpoint HTTPS (max 5 per account) per le consegne degli eventi. La risposta include il secret di firma — l'UNICA volta in cui viene mostrato, quindi memorizzalo immediatamente.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del body

url
string obbligatorio
https://example.com/webhooks/bitculator

L'URL HTTPS di consegna. Solo host pubblici — gli indirizzi interni/privati vengono rifiutati.

events
string[] obbligatorio
["alarm.triggered"]

Eventi a cui iscriversi. Valori consentiti: alarm.triggered.

Richiesta

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\"
    ]
}"

Elimina un endpoint webhook

Elimina uno degli endpoint webhook del proprietario della chiave. Le consegne in sospeso verso di esso vengono abbandonate.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

id
integer obbligatorio
7

L'id dell'endpoint webhook.

Richiesta

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

Invia un evento di test

Invia un evento di test alarm.triggered firmato (test: true nel payload, header di firma reali) così i destinatari possono essere verificati end-to-end.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

id
integer obbligatorio
7

L'id dell'endpoint webhook.

Richiesta

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"

Log delle consegne webhook

I tentativi di consegna dell'endpoint (conservati 30 giorni), dal più recente, paginati.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Parametri del percorso

id
integer obbligatorio
7

L'id dell'endpoint webhook.

Parametri di query

page
integer facoltativo
1

Numero di pagina (a partire da 1).

per_page
integer facoltativo
25

Righe per pagina (1–100, predefinito 25).

Richiesta GET — nessun corpo della richiesta.

Richiesta

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 endpoint

Meta

Meta e introspezione dell'API: un ping autenticato per verificare una chiave e lo stack di middleware, l'utilizzo/quota della chiave corrente e la specifica OpenAPI leggibile dalle macchine.

Specifica OpenAPI

Il documento OpenAPI 3 leggibile dalle macchine per questa API, in JSON — punta il codegen o gli strumenti API a questo URL. Pubblico: nessuna chiave richiesta.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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

Un no-op autenticato per verificare una chiave Data API end-to-end (auth.api → limite di burst per piano → quota mensile). Conta sulla quota come qualsiasi altra chiamata.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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

Utilizzo e quota della chiave

Introspezione dell'utilizzo per il proprietario della chiave chiamante: il piano Data API, il suo limite mensile, l'utilizzato e il rimanente (sempre coerenti con gli header X-Quota-*), la finestra del periodo corrente e le scomposizioni per endpoint / per token. L'utilizzo dei widget embed ha un piano e un pool propri — non compare mai qui.

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

Le chiavi sono solo Bearer e portano l'abilità data-api — tienile lato server.

Richiesta GET — nessun corpo della richiesta.

Richiesta

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