Bitculator
Bitculator · Data API · v1

Bitculator Data API

73 endpointů 15 skupin X-Quota-* u každého volání http://localhost/api/v1

Všechny endpointy žijí pod /api/v1 a vyžadují Bearer klíč se schopností data-api — vytvořte si jej ve vývojářské konzoli.

Vaše první volání:

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

Odpovědi jsou ve formátu JSON. Ceny, kurzy a zásoby jsou desetinné řetězce (floaty neunesou tržní přesnost); počty a analytické hodnoty jsou čísla. Každá odpověď nese vaši aktuální kvótu v hlavičkách X-Quota-Limit / X-Quota-Used / X-Quota-Reset a chyby vždy používají obálku {"error": {"code", "message", "details"}}.

Data API má vlastní měsíční kvótu, vázanou na váš API plán a zcela oddělenou od vašich embed widgetů. Limity per_page závisí na plánu (Free 100, Starter/Pro 250); překročení limitu vrátí 422, místo aby hodnotu ořízlo.

Autentizace

Pro autentizaci požadavků přidejte ke každému požadavku hlavičku Authorization: Bearer {YOUR_API_KEY}.

Vytvořte si klíč pro Data API ve vývojářské konzoli — klíče jsou pouze Bearer a nesou schopnost data-api. Uchovávejte je na straně serveru; nikdy nejsou určeny k vkládání na straně klienta.

Hlavička Authorization
Vytvořit klíč →
Bearer
bc_••••••••••••••••

Odesílá se jako Authorization: Bearer {YOUR_API_KEY} u každého požadavku.

9 endpointů

Kryptoměny

Žebříčková tržní data kryptoměn a tokenů: stránkované výpisy, detail jedné kryptoměny, pohyby (rostoucí/klesající), nedávno přidané, trendy a časové řady jednotlivých kryptoměn. Ceny, tržní kapitalizace a zásoba jsou desetinné ŘETĚZCE (floaty neunesou tržní přesnost); procentní změny, pořadí a počty jsou čísla.

Seznam kryptoměn

Žebříček kryptoměn s cenami, filtry a selektory, stránkovaný pomocí Laravel obálky links + meta. Ceny, tržní kapitalizace a circulating_supply jsou desetinné řetězce; změny a pořadí jsou čísla.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

type
string volitelné
coin

Omezit na jeden typ aktiva: coin nebo token.

Jedna z hodnot: coin token

status
string volitelné
active

Stav kotace: active, delisted, untracked, progressing, awaiting nebo preparing. Výchozí jsou všechny veřejné stavy.

Jedna z hodnot: active delisted untracked progressing awaiting preparing

search
string volitelné
bitcoin

Volnotextové vyhledávání podle názvu nebo symbolu. Nesmí být delší než 100 znaků.

min_price
number volitelné
0.5

Pouze kryptoměny s cenou na této hodnotě v USD nebo vyšší. Musí být alespoň 0.

max_price
number volitelné
100000

Pouze kryptoměny s cenou na této hodnotě v USD nebo nižší. Musí být alespoň 0.

min_marketcap
number volitelné
1000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_marketcap
number volitelné
5000000000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_volume
number volitelné
1000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

ids
string volitelné
38,39

Filtrovat na konkrétní ID kryptoměn (CSV, až 100 selektorů dohromady se slugs/symbols). Nesmí být delší než 1000 znaků.

slugs
string volitelné
bitcoin,ethereum

Filtrovat na konkrétní slugy kryptoměn (CSV, až 100 selektorů dohromady). Nesmí být delší než 2000 znaků.

symbols
string volitelné
BTC,ETH

Filtrovat na konkrétní symboly kryptoměn (CSV, nezáleží na velikosti písmen, až 100 selektorů dohromady). Nesmí být delší než 1000 znaků.

sort
string volitelné
-marketcap

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: marketcap, rank, price, volume_24h, change_24h, change_7d. Nesmí být delší než 100 znaků.

interval
string volitelné
24h

Okno pohybů pouze pro /coins/gainers a /coins/losers: 24h nebo 7d.

Jedna z hodnot: 24h 7d

GET požadavek — bez těla požadavku.

Požadavek

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"

Nedávno přidané kryptoměny

Nejnovější kotace — seřazené podle status_updated_at (časová značka aktivace; created_at je datum indexace, které předchází kotaci o libovolnou dobu). Stejný tvar řádku a stránkovací obálka jako List coins.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

type
string volitelné
coin

Omezit na jeden typ aktiva: coin nebo token.

Jedna z hodnot: coin token

status
string volitelné
active

Stav kotace: active, delisted, untracked, progressing, awaiting nebo preparing. Výchozí jsou všechny veřejné stavy.

Jedna z hodnot: active delisted untracked progressing awaiting preparing

search
string volitelné
bitcoin

Volnotextové vyhledávání podle názvu nebo symbolu. Nesmí být delší než 100 znaků.

min_price
number volitelné
0.5

Pouze kryptoměny s cenou na této hodnotě v USD nebo vyšší. Musí být alespoň 0.

max_price
number volitelné
100000

Pouze kryptoměny s cenou na této hodnotě v USD nebo nižší. Musí být alespoň 0.

min_marketcap
number volitelné
1000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_marketcap
number volitelné
5000000000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_volume
number volitelné
1000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

ids
string volitelné
38,39

Filtrovat na konkrétní ID kryptoměn (CSV, až 100 selektorů dohromady se slugs/symbols). Nesmí být delší než 1000 znaků.

slugs
string volitelné
bitcoin,ethereum

Filtrovat na konkrétní slugy kryptoměn (CSV, až 100 selektorů dohromady). Nesmí být delší než 2000 znaků.

symbols
string volitelné
BTC,ETH

Filtrovat na konkrétní symboly kryptoměn (CSV, nezáleží na velikosti písmen, až 100 selektorů dohromady). Nesmí být delší než 1000 znaků.

sort
string volitelné
-marketcap

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: marketcap, rank, price, volume_24h, change_24h, change_7d. Nesmí být delší než 100 znaků.

interval
string volitelné
24h

Okno pohybů pouze pro /coins/gainers a /coins/losers: 24h nebo 7d.

Jedna z hodnot: 24h 7d

GET požadavek — bez těla požadavku.

Požadavek

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"

Nejvíce rostoucí

Největší růsty za okno interval (výchozí 24h, nebo 7d). Stejný tvar řádku a stránkovací obálka jako List coins.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

type
string volitelné
coin

Omezit na jeden typ aktiva: coin nebo token.

Jedna z hodnot: coin token

status
string volitelné
active

Stav kotace: active, delisted, untracked, progressing, awaiting nebo preparing. Výchozí jsou všechny veřejné stavy.

Jedna z hodnot: active delisted untracked progressing awaiting preparing

search
string volitelné
bitcoin

Volnotextové vyhledávání podle názvu nebo symbolu. Nesmí být delší než 100 znaků.

min_price
number volitelné
0.5

Pouze kryptoměny s cenou na této hodnotě v USD nebo vyšší. Musí být alespoň 0.

max_price
number volitelné
100000

Pouze kryptoměny s cenou na této hodnotě v USD nebo nižší. Musí být alespoň 0.

min_marketcap
number volitelné
1000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_marketcap
number volitelné
5000000000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_volume
number volitelné
1000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

ids
string volitelné
38,39

Filtrovat na konkrétní ID kryptoměn (CSV, až 100 selektorů dohromady se slugs/symbols). Nesmí být delší než 1000 znaků.

slugs
string volitelné
bitcoin,ethereum

Filtrovat na konkrétní slugy kryptoměn (CSV, až 100 selektorů dohromady). Nesmí být delší než 2000 znaků.

symbols
string volitelné
BTC,ETH

Filtrovat na konkrétní symboly kryptoměn (CSV, nezáleží na velikosti písmen, až 100 selektorů dohromady). Nesmí být delší než 1000 znaků.

sort
string volitelné
-marketcap

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: marketcap, rank, price, volume_24h, change_24h, change_7d. Nesmí být delší než 100 znaků.

interval
string volitelné
24h

Okno pohybů pouze pro /coins/gainers a /coins/losers: 24h nebo 7d.

Jedna z hodnot: 24h 7d

GET požadavek — bez těla požadavku.

Požadavek

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"

Nejvíce klesající

Největší propady za okno interval (výchozí 24h, nebo 7d). Stejný tvar řádku a stránkovací obálka jako List coins.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

type
string volitelné
coin

Omezit na jeden typ aktiva: coin nebo token.

Jedna z hodnot: coin token

status
string volitelné
active

Stav kotace: active, delisted, untracked, progressing, awaiting nebo preparing. Výchozí jsou všechny veřejné stavy.

Jedna z hodnot: active delisted untracked progressing awaiting preparing

search
string volitelné
bitcoin

Volnotextové vyhledávání podle názvu nebo symbolu. Nesmí být delší než 100 znaků.

min_price
number volitelné
0.5

Pouze kryptoměny s cenou na této hodnotě v USD nebo vyšší. Musí být alespoň 0.

max_price
number volitelné
100000

Pouze kryptoměny s cenou na této hodnotě v USD nebo nižší. Musí být alespoň 0.

min_marketcap
number volitelné
1000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_marketcap
number volitelné
5000000000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_volume
number volitelné
1000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

ids
string volitelné
38,39

Filtrovat na konkrétní ID kryptoměn (CSV, až 100 selektorů dohromady se slugs/symbols). Nesmí být delší než 1000 znaků.

slugs
string volitelné
bitcoin,ethereum

Filtrovat na konkrétní slugy kryptoměn (CSV, až 100 selektorů dohromady). Nesmí být delší než 2000 znaků.

symbols
string volitelné
BTC,ETH

Filtrovat na konkrétní symboly kryptoměn (CSV, nezáleží na velikosti písmen, až 100 selektorů dohromady). Nesmí být delší než 1000 znaků.

sort
string volitelné
-marketcap

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: marketcap, rank, price, volume_24h, change_24h, change_7d. Nesmí být delší než 100 znaků.

interval
string volitelné
24h

Okno pohybů pouze pro /coins/gainers a /coins/losers: 24h nebo 7d.

Jedna z hodnot: 24h 7d

GET požadavek — bez těla požadavku.

Požadavek

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"

Získat detail kryptoměny

Kompletní profil jedné kryptoměny. Nad rámec polí ze seznamu přidává: supply (oběžná/celková/max), today OHLC, all_time_high / all_time_low (cena, datum a percent_from aktuální ceny), fully_diluted_valuation, tržní counts (burzy/páry/tickery/peněženky), decimals, genesis_date, oficiální links (typovaný seznam url), token contracts a lokalizovaný HTML description (záložně angličtina, pokud požadovaný locale chybí). Všechna pole cen/zásob jsou desetinné řetězce.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

Parametry dotazu

locale
string volitelné
en

Jazyk obsahu pro popis (záložně angličtina).

GET požadavek — bez těla požadavku.

Požadavek

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"

Historie svíček

Časová řada OHLC + objem + tržní kapitalizace pro jednu kryptoměnu. Vyberte interval: minutely, half-hourly, hourly nebo daily. Retence je pevná vlastnost agregační pipeline — minutely 8 dní, half-hourly 3 měsíce, hourly 6 měsíců, daily navždy; požadavky nad rámec okna vrátí to, co existuje. Když je nastaven limit, dostanete N NEJNOVĚJŠÍCH řádků v okně, seřazených od nejstaršího. Ceny jsou desetinné řetězce.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

Parametry dotazu

interval
string volitelné
daily

minutely, half-hourly, hourly nebo daily (výchozí daily).

start
string volitelné
2026-06-01

Dolní mez data/času ISO.

end
string volitelné
2026-06-30

Horní mez data/času ISO (hodnota pouze s datem znamená včetně toho dne).

limit
integer volitelné
30

Max řádků (1–2000, výchozí 1000).

GET požadavek — bez těla požadavku.

Požadavek

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"

Historie tržní kapitalizace

Stejné agregace pro jednu kryptoměnu jako Candle history, promítnuté pouze na {time, marketcap}. Stejné volby interval a retenční okna (minutely 8 dní, half-hourly 3 měsíce, hourly 6 měsíců, daily navždy), nejnovějších N, když je nastaven limit.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

Parametry dotazu

interval
string volitelné
daily

minutely, half-hourly, hourly nebo daily (výchozí daily).

start
string volitelné
2026-06-01

Dolní mez data/času ISO.

end
string volitelné
2026-06-30

Horní mez data/času ISO.

limit
integer volitelné
30

Max řádků (1–2000, výchozí 1000).

GET požadavek — bez těla požadavku.

Požadavek

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 kryptoměny

Kompaktní cenová řada kryptoměny za zvolené period, určená pro kreslení sparklinů.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

Parametry dotazu

period
string volitelné
7d

24h, 7d, 30d, 60d, 90d, 180d nebo 365d (výchozí 7d).

GET požadavek — bez těla požadavku.

Požadavek

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ů

Ceny

Odlehčená rychlá cesta pro ceny — aktuální cena, tržní kapitalizace, 24h objem a nedávné změny pro požadovanou množinu kryptoměn. /prices vyžaduje selektor (ids, slugs nebo symbols); /prices/{slug} cílí na jednu kryptoměnu. Volitelně convert na fiat měnu (krypto ceny se aktualizují ~každou minutu, fiat kurzy ~dvakrát denně). Ceny a tržní kapitalizace jsou desetinné řetězce.

Získat ceny

Ceny pro požadovanou množinu kryptoměn. Předejte alespoň jeden selektor — ids, slugs nebo symbols (až 100 dohromady). meta.currency odráží cíl převodu (USD, pokud není nastaveno convert).

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

ids
string volitelné
38,39

ID kryptoměn k ocenění (CSV). Vyžadován je alespoň jeden z ids, slugs nebo symbols; tři seznamy dohromady mají limit 100 selektorů. Toto pole je povinné, pokud není přítomen žádný z slugs a symbols. Nesmí být delší než 1000 znaků.

slugs
string volitelné
bitcoin,ethereum

Slugy kryptoměn k ocenění (CSV). Vyžadován je alespoň jeden z ids, slugs nebo symbols. Toto pole je povinné, pokud není přítomen žádný z ids a symbols. Nesmí být delší než 2000 znaků.

symbols
string volitelné
BTC,ETH

Symboly kryptoměn k ocenění (CSV, nezáleží na velikosti písmen). Vyžadován je alespoň jeden z ids, slugs nebo symbols. Toto pole je povinné, pokud není přítomen žádný z ids a slugs. Nesmí být delší než 1000 znaků.

convert
string volitelné
EUR

Převede ceny/tržní kapitalizaci na aktivní fiat měnu podle symbolu (výchozí USD). Kurzy se aktualizují ~dvakrát denně.

Jedna z hodnot: 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

GET požadavek — bez těla požadavku.

Požadavek

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"

Získat cenu kryptoměny

Cenový snímek jedné kryptoměny. Volitelně convert na aktivní fiat měnu podle symbolu (výchozí USD).

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

Parametry dotazu

convert
string volitelné
EUR

Symbol aktivní fiat měny, ve které se má cena zobrazit (výchozí USD).

GET požadavek — bez těla požadavku.

Požadavek

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"

Historická cena

Cena kryptoměny v USD k danému datu, čtená z denní historie (přesný den, záložně ±3 dny — stejný resolver, který používá portfolio). Pouze krypto: fiat řádky nemají denní historii.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

slug
string povinné
bitcoin

Slug identifikátor kryptoměny.

date
string povinné
2021-04-14

date Datum vyhledání (po 2008-12-31, ne v budoucnosti).

GET požadavek — bez těla požadavku.

Požadavek

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ů

Trhy

Tickery (trhy jednotlivých burz) a páry (trhy agregované napříč burzami), plus trhy kryptoměny a surové obchodní symboly podle jednotlivých burz. To vše jsou snímková data — žádná historie jednotlivých tickerů/párů neexistuje. USD objemy jsou čísla; ceny jsou desetinné řetězce.

Trhy kryptoměny

Všechny trhy pro kryptoměnu — tickery, jejichž pár má kryptoměnu jako základní NEBO kotovací aktivum. Stejný tvar řádku a filtry jako List tickers.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

exchange
string volitelné
binance-exchange

Omezit na jednu burzu podle slugu (vynechte u výpisu jednotlivé burzy, který je již omezen). Musí odpovídat regulárnímu výrazu /^[a-z0-9-]{1,120}$/.

pair
integer volitelné
1

Omezit na jeden pár podle id. Musí být alespoň 1.

instrument
string volitelné
spot

Typ nástroje: future, option, swap, spot nebo margin (množná čísla akceptována).

Jedna z hodnot: future option swap spot margin

search
string volitelné
BTC

Volnotextové vyhledávání podle symbolu tickeru. Nesmí být delší než 50 znaků.

min_volume
number volitelné
1000000

Pouze tickery s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze tickery s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_change
number volitelné
-50

Pouze tickery s 24h procentní změnou na této hodnotě nebo vyšší.

max_change
number volitelné
50

Pouze tickery s 24h procentní změnou na této hodnotě nebo nižší.

sort
string volitelné
-volume_usd

Jedno pole pro řazení (předpona - pro sestupné). Řadit lze podle: volume_usd, change_24h, price_usd, updated. Výchozí je -volume_usd. Nesmí být delší než 100 znaků.

GET požadavek — bez těla požadavku.

Požadavek

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"

Obchodní symboly kryptoměny

Surové obchodní symboly kryptoměny podle jednotlivých burz — řídce naplněná referenční data (pokrytí je podle nejlepšího úsilí).

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

GET požadavek — bez těla požadavku.

Požadavek

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"

Seznam tickerů

Jednotlivé trhy podle burz (tickery), stránkované. Filtrujte podle burzy, páru, nástroje a rozsahů objemu/změny. USD objemy jsou čísla; ceny jsou desetinné řetězce.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

exchange
string volitelné
binance-exchange

Omezit na jednu burzu podle slugu (vynechte u výpisu jednotlivé burzy, který je již omezen). Musí odpovídat regulárnímu výrazu /^[a-z0-9-]{1,120}$/.

pair
integer volitelné
1

Omezit na jeden pár podle id. Musí být alespoň 1.

instrument
string volitelné
spot

Typ nástroje: future, option, swap, spot nebo margin (množná čísla akceptována).

Jedna z hodnot: future option swap spot margin

search
string volitelné
BTC

Volnotextové vyhledávání podle symbolu tickeru. Nesmí být delší než 50 znaků.

min_volume
number volitelné
1000000

Pouze tickery s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze tickery s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_change
number volitelné
-50

Pouze tickery s 24h procentní změnou na této hodnotě nebo vyšší.

max_change
number volitelné
50

Pouze tickery s 24h procentní změnou na této hodnotě nebo nižší.

sort
string volitelné
-volume_usd

Jedno pole pro řazení (předpona - pro sestupné). Řadit lze podle: volume_usd, change_24h, price_usd, updated. Výchozí je -volume_usd. Nesmí být delší než 100 znaků.

GET požadavek — bez těla požadavku.

Požadavek

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"

Seznam párů

Obchodní páry agregované napříč burzami, seřazené podle 24h objemu v USD. Filtrujte podle slugu kryptoměny (základní nebo kotovací) a rozsahu objemu.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

search
string volitelné
BTC

Volnotextové vyhledávání podle symbolu páru. Nesmí být delší než 50 znaků.

coin
string volitelné
bitcoin

Omezit na páry, kde je tento slug kryptoměny základním nebo kotovacím aktivem. Musí odpovídat regulárnímu výrazu /^[a-z0-9-]{1,120}$/.

min_volume
number volitelné
1000000

Pouze páry s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze páry s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

sort
string volitelné
-volume_usd

Pole pro řazení: volume_usd nebo updated (předpona - pro sestupné). Výchozí je -volume_usd.

Jedna z hodnot: volume_usd -volume_usd updated -updated

GET požadavek — bez těla požadavku.

Požadavek

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"

Získat detail páru

Jeden pár plus každý ticker burzy, který jej kotuje, seřazeno podle objemu.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

id
integer povinné
1

ID páru.

GET požadavek — bez těla požadavku.

Požadavek

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ů

Burzy

Žebříčky burz, detail, skóre důvěry, časové řady a výpisy trhů/kryptoměn jednotlivých burz. Objemy jsou v USD. Neexistuje sloupec CEX/DEX — type je odvozen z taxonomie burz, takže může být "cex", "dex" nebo null.

Seznam burz

Žebříček burz s 24h objemem, dominancí, počty párů/aktiv a nedávnými změnami. Stránkovaný pomocí Laravel obálky links + meta.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

type
string volitelné
cex

Omezit na typ burzy: cex nebo dex (vyhodnoceno pomocí taxonomie burz).

Jedna z hodnot: cex dex

search
string volitelné
binance

Volnotextové vyhledávání podle názvu burzy. Nesmí být delší než 100 znaků.

min_pairs
integer volitelné
100

Pouze burzy kotující alespoň tento počet párů. Musí být alespoň 0.

max_pairs
integer volitelné
2000

Pouze burzy kotující nejvýše tento počet párů. Musí být alespoň 0.

min_assets
integer volitelné
50

Pouze burzy kotující alespoň tento počet aktiv. Musí být alespoň 0.

max_assets
integer volitelné
1000

Pouze burzy kotující nejvýše tento počet aktiv. Musí být alespoň 0.

min_volume
number volitelné
1000000

Pouze burzy s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze burzy s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

ids
string volitelné
1,12

Filtrovat na konkrétní ID burz (CSV, až 100). Nesmí být delší než 1000 znaků.

slugs
string volitelné
binance-exchange,gateio

Filtrovat na konkrétní slugy burz (CSV, až 100). Nesmí být delší než 2000 znaků.

sort
string volitelné
-volume

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: volume, rank, volume_dominance, change_24h, change_7d, pairs, assets. Nesmí být delší než 100 znaků.

GET požadavek — bez těla požadavku.

Požadavek

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"

Získat detail burzy

Kompletní profil jedné burzy: žebříček, objem/dominance, počty párů a aktiv, datum established, location, referral website a odvozený type (cex/dex/null).

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
binance-exchange

Slug burzy.

GET požadavek — bez těla požadavku.

Požadavek

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"

Získat skóre důvěry burzy

Souhrnné skóre důvěry score 0–10 plus jeho breakdown na 13 faktorů (rank, volume, age, volume_trend, stability, rank_stability, ticker_health, pairs, community, assets, dominance, market_breadth, transparency). Počítáno pro každou burzu a uloženo v cache 24 h.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
binance-exchange

Slug burzy.

GET požadavek — bez těla požadavku.

Požadavek

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"

Historie burzy

Časová řada objem / dominance / páry / aktiva (agregace burz nenesou OHLC). Vyberte interval: minutely, hourly nebo daily. Retence je pevná vlastnost agregační pipeline — minutely 8 dní, hourly 6 měsíců, daily navždy; když je nastaven limit, dostanete nejnovějších N řádků v okně, od nejstaršího.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
binance-exchange

Slug burzy.

Parametry dotazu

interval
string volitelné
daily

minutely, hourly nebo daily (výchozí daily).

start
string volitelné
2026-06-01

Dolní mez data/času ISO.

end
string volitelné
2026-06-30

Horní mez data/času ISO (hodnota pouze s datem znamená včetně toho dne).

limit
integer volitelné
30

Max řádků (1–2000, výchozí 1000).

GET požadavek — bez těla požadavku.

Požadavek

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 burzy

Sparkline řada objemu burzy za období (výchozí 7d) — stejná řada, kterou vykreslují řádky burz na webu.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
binance-exchange

Slug burzy.

Parametry dotazu

period
string volitelné
7d

Jedna z hodnot 24h, 7d (výchozí), 30d, 60d, 90d, 180d, 365d.

GET požadavek — bez těla požadavku.

Požadavek

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"

Trhy burzy

Výpisy tickerů burzy (její trhy), stránkované. Již omezeno na burzu — zde nepředávejte parametr exchange.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
binance-exchange

Slug burzy.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

exchange
string volitelné
binance-exchange

Omezit na jednu burzu podle slugu (vynechte u výpisu jednotlivé burzy, který je již omezen). Musí odpovídat regulárnímu výrazu /^[a-z0-9-]{1,120}$/.

pair
integer volitelné
1

Omezit na jeden pár podle id. Musí být alespoň 1.

instrument
string volitelné
spot

Typ nástroje: future, option, swap, spot nebo margin (množná čísla akceptována).

Jedna z hodnot: future option swap spot margin

search
string volitelné
BTC

Volnotextové vyhledávání podle symbolu tickeru. Nesmí být delší než 50 znaků.

min_volume
number volitelné
1000000

Pouze tickery s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze tickery s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_change
number volitelné
-50

Pouze tickery s 24h procentní změnou na této hodnotě nebo vyšší.

max_change
number volitelné
50

Pouze tickery s 24h procentní změnou na této hodnotě nebo nižší.

sort
string volitelné
-volume_usd

Jedno pole pro řazení (předpona - pro sestupné). Řadit lze podle: volume_usd, change_24h, price_usd, updated. Výchozí je -volume_usd. Nesmí být delší než 100 znaků.

GET požadavek — bez těla požadavku.

Požadavek

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"

Kryptoměny burzy

Kryptoměny kotované na burze, vrácené ve stejném tvaru jako List coins a přijímající stejné filtry/řazení.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
binance-exchange

Slug burzy.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

type
string volitelné
coin

Omezit na jeden typ aktiva: coin nebo token.

Jedna z hodnot: coin token

status
string volitelné
active

Stav kotace: active, delisted, untracked, progressing, awaiting nebo preparing. Výchozí jsou všechny veřejné stavy.

Jedna z hodnot: active delisted untracked progressing awaiting preparing

search
string volitelné
bitcoin

Volnotextové vyhledávání podle názvu nebo symbolu. Nesmí být delší než 100 znaků.

min_price
number volitelné
0.5

Pouze kryptoměny s cenou na této hodnotě v USD nebo vyšší. Musí být alespoň 0.

max_price
number volitelné
100000

Pouze kryptoměny s cenou na této hodnotě v USD nebo nižší. Musí být alespoň 0.

min_marketcap
number volitelné
1000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_marketcap
number volitelné
5000000000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_volume
number volitelné
1000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

ids
string volitelné
38,39

Filtrovat na konkrétní ID kryptoměn (CSV, až 100 selektorů dohromady se slugs/symbols). Nesmí být delší než 1000 znaků.

slugs
string volitelné
bitcoin,ethereum

Filtrovat na konkrétní slugy kryptoměn (CSV, až 100 selektorů dohromady). Nesmí být delší než 2000 znaků.

symbols
string volitelné
BTC,ETH

Filtrovat na konkrétní symboly kryptoměn (CSV, nezáleží na velikosti písmen, až 100 selektorů dohromady). Nesmí být delší než 1000 znaků.

sort
string volitelné
-marketcap

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: marketcap, rank, price, volume_24h, change_24h, change_7d. Nesmí být delší než 100 znaků.

interval
string volitelné
24h

Okno pohybů pouze pro /coins/gainers a /coins/losers: 24h nebo 7d.

Jedna z hodnot: 24h 7d

GET požadavek — bez těla požadavku.

Požadavek

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ů

Peněženky

Recenze krypto peněženek — hodnotící score, počet podporovaných aktiv, počty pro/proti, cenový model a datum vydání, plus seskupená taxonomie štítků v odpovědích detailu/porovnání. meta.top_score je nejvyšší skóre napříč všemi peněženkami (použijte jej k normalizaci skóre do rozsahu 0–1).

Seznam peněženek

Recenzované peněženky se skóre, počtem aktiv, počty pro/proti, cenovým modelem, stavem a datem vydání. Stránkované pomocí Laravel obálky links + meta, plus meta.top_score.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

search
string volitelné
ledger

Volnotextové vyhledávání podle názvu peněženky. Nesmí být delší než 100 znaků.

min_score
integer volitelné
50

Pouze peněženky s hodnotícím skóre na této hodnotě nebo vyšší. Musí být alespoň 0.

max_score
integer volitelné
214

Pouze peněženky s hodnotícím skóre na této hodnotě nebo nižší. Musí být alespoň 0.

tags
string volitelné
12,34

Filtrovat podle taxonomie štítků: ID skupin kategorií oddělená čárkou (stejná ID, která odesílají webové fasetové filtry). Nesmí být delší než 1000 znaků.

ids
string volitelné
175,317

Filtrovat na konkrétní ID peněženek (CSV, až 100). Nesmí být delší než 1000 znaků.

slugs
string volitelné
frostsnap,coin98-fusion-card

Filtrovat na konkrétní slugy peněženek (CSV, až 100). Nesmí být delší než 2000 znaků.

sort
string volitelné
-score

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: score, released_at, assets, pros, cons. Nesmí být delší než 100 znaků.

GET požadavek — bez těla požadavku.

Požadavek

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"

Časová osa vydání peněženek

Seznam peněženek připnutý na sestupné released_at (peněženky bez data poslední). Stejný tvar řádku a stránkovací obálka jako List wallets.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

search
string volitelné
ledger

Volnotextové vyhledávání podle názvu peněženky. Nesmí být delší než 100 znaků.

min_score
integer volitelné
50

Pouze peněženky s hodnotícím skóre na této hodnotě nebo vyšší. Musí být alespoň 0.

max_score
integer volitelné
214

Pouze peněženky s hodnotícím skóre na této hodnotě nebo nižší. Musí být alespoň 0.

tags
string volitelné
12,34

Filtrovat podle taxonomie štítků: ID skupin kategorií oddělená čárkou (stejná ID, která odesílají webové fasetové filtry). Nesmí být delší než 1000 znaků.

ids
string volitelné
175,317

Filtrovat na konkrétní ID peněženek (CSV, až 100). Nesmí být delší než 1000 znaků.

slugs
string volitelné
frostsnap,coin98-fusion-card

Filtrovat na konkrétní slugy peněženek (CSV, až 100). Nesmí být delší než 2000 znaků.

sort
string volitelné
-score

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: score, released_at, assets, pros, cons. Nesmí být delší než 100 znaků.

GET požadavek — bez těla požadavku.

Požadavek

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"

Porovnat peněženky

Porovnání 2–4 peněženek vedle sebe s jejich kompletní seskupenou taxonomií štítků. data[] zachovává pořadí požadovaných slugů, aby konzumenti mohli vykreslit sloupce podle pozice.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

slugs
string povinné
frostsnap,coin98-fusion-card

2–4 různé slugy peněženek oddělené čárkou.

GET požadavek — bez těla požadavku.

Požadavek

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"

Získat detail peněženky

Kompletní profil jedné peněženky včetně seskupené taxonomie štítků: categories je seznam {group, tags[]}, kde každý štítek má slug, název a volitelnou hodnotu. meta.top_score je nejvyšší skóre napříč všemi peněženkami.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
frostsnap

Slug peněženky.

GET požadavek — bez těla požadavku.

Požadavek

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"

Kryptoměny podporované peněženkou

Kryptoměny, které peněženka podporuje, vrácené ve stejném tvaru jako List coins a přijímající stejné filtry/řazení.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
frostsnap

Slug peněženky.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

type
string volitelné
coin

Omezit na jeden typ aktiva: coin nebo token.

Jedna z hodnot: coin token

status
string volitelné
active

Stav kotace: active, delisted, untracked, progressing, awaiting nebo preparing. Výchozí jsou všechny veřejné stavy.

Jedna z hodnot: active delisted untracked progressing awaiting preparing

search
string volitelné
bitcoin

Volnotextové vyhledávání podle názvu nebo symbolu. Nesmí být delší než 100 znaků.

min_price
number volitelné
0.5

Pouze kryptoměny s cenou na této hodnotě v USD nebo vyšší. Musí být alespoň 0.

max_price
number volitelné
100000

Pouze kryptoměny s cenou na této hodnotě v USD nebo nižší. Musí být alespoň 0.

min_marketcap
number volitelné
1000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_marketcap
number volitelné
5000000000000

Pouze kryptoměny s tržní kapitalizací v USD na této hodnotě nebo nižší. Musí být alespoň 0.

min_volume
number volitelné
1000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo vyšší. Musí být alespoň 0.

max_volume
number volitelné
100000000000

Pouze kryptoměny s 24h objemem v USD na této hodnotě nebo nižší. Musí být alespoň 0.

ids
string volitelné
38,39

Filtrovat na konkrétní ID kryptoměn (CSV, až 100 selektorů dohromady se slugs/symbols). Nesmí být delší než 1000 znaků.

slugs
string volitelné
bitcoin,ethereum

Filtrovat na konkrétní slugy kryptoměn (CSV, až 100 selektorů dohromady). Nesmí být delší než 2000 znaků.

symbols
string volitelné
BTC,ETH

Filtrovat na konkrétní symboly kryptoměn (CSV, nezáleží na velikosti písmen, až 100 selektorů dohromady). Nesmí být delší než 1000 znaků.

sort
string volitelné
-marketcap

Pole pro řazení oddělená čárkou; předpona - pro sestupné. Řadit lze podle: marketcap, rank, price, volume_24h, change_24h, change_7d. Nesmí být delší než 100 znaků.

interval
string volitelné
24h

Okno pohybů pouze pro /coins/gainers a /coins/losers: 24h nebo 7d.

Jedna z hodnot: 24h 7d

GET požadavek — bez těla požadavku.

Požadavek

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ů

Globální trh

Tržní agregace — celková tržní kapitalizace a objem, počty aktiv/burz/párů/trhů, dominance BTC/ETH s top 3 podle pořadí, tržní hodnota Strachu a chamtivosti, plus heatmapa top 100 a historie tržní kapitalizace/objemu.

Snímek globálního trhu

Jednorázový přehled trhu: celková tržní kapitalizace a 24h objem, počty kryptoměn / tokenů / burz / párů / trhů, dominance (podíl BTC & ETH plus top3 podle pořadí) a tržní hodnota fear_greed.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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

Tržní heatmapa

Řádky treemapy top 100 plus rámcové statistiky (celková tržní kapitalizace/objem, dominance a tržní skóre Strachu a chamtivosti) — API dvojče webové heatmapy.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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"

Historie globální tržní kapitalizace / objemu

Časová řada celého trhu pro marketcap nebo volume. Granularita se řídí period: 24h = po půlhodinách, 7d = po hodinách, 30d/all = po dnech (jemnější agregace jsou odstraněny).

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

metric
string povinné
marketcap

Která řada: marketcap nebo volume.

Parametry dotazu

period
string volitelné
7d

24h, 7d, 30d nebo all (výchozí 24h).

GET požadavek — bez těla požadavku.

Požadavek

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

Indexy sentimentu pro trh i jednotlivé kryptoměny. Strach a chamtivost a Býci/Medvědi jsou SNÍMKY obnovované po 15 minutách — existuje pouze aktuální hodnota, žádná časová řada pro ně není. Altseason nese kompletní denní historii. indicators je tržní technický souhrn.

Součty hlasů komunity

Býčí/medvědí součty komunity ke kryptoměně za posuvné 24h okno.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug identifikátor kryptoměny.

GET požadavek — bez těla požadavku.

Požadavek

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"

Odeslat hlas o sentimentu

Odešle hlas majitele klíče o sentimentu ke kryptoměně. Jeden hlas na majitele klíče a kryptoměnu za posuvné 24h okno — opětovné hlasování v rámci okna aktualizuje stávající hlas.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug identifikátor kryptoměny.

Parametry těla

vote
string povinné
bullish

Váš sentiment: bullish nebo bearish.

Požadavek

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

Index strachu a chamtivosti

Aktuální hodnota Strachu a chamtivosti (15minutový snímek — bez historie). Vynechte coin pro tržní index, nebo předejte slug kryptoměny pro hodnotu jednotlivé kryptoměny. intervals nese 7d/30d dílčí skóre a jejich rozpad na složky.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

coin
string volitelné
bitcoin

Slug kryptoměny pro hodnotu jednotlivé kryptoměny; vynechte pro tržní index.

GET požadavek — bez těla požadavku.

Požadavek

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"

Index býci / medvědi

Aktuální hodnota Býci/Medvědi (15minutový snímek — bez historie). Vynechte coin pro tržní index, nebo předejte slug kryptoměny pro hodnotu jednotlivé kryptoměny.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

coin
string volitelné
bitcoin

Slug kryptoměny pro hodnotu jednotlivé kryptoměny; vynechte pro tržní index.

GET požadavek — bez těla požadavku.

Požadavek

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"

Index altseason

Aktuální hodnota altseason (počet kryptoměn překonávajících BTC ze top 100), s volitelnou denní history. Na rozdíl od Strachu a chamtivosti má altseason kompletní denní historii — předejte days pro její zahrnutí.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

days
integer volitelné
30

Počet dní denní historie k zahrnutí (1–365; 0/vynechání = pouze aktuální).

GET požadavek — bez těla požadavku.

Požadavek

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"

Souhrn tržních indikátorů

Tržní technický souhrn — 25 agregovaných kategorií indikátorů, každá se svým aktuálním stavem, skóre a daty kategorie.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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ů

Indikátory

Technické indikátory pro jednu kryptoměnu — snímek více indikátorů plus denní časová řada pro každou rodinu. Všechny rodiny jsou DENNÍ řady počítané z denních svíček (plná retence; mladá aktiva vracejí zahřívací null hodnoty, dokud neexistuje dostatek historie). Rodiny s cenovou škálou (sma, vwap, macd, obv) vydávají desetinné řetězce; omezené oscilátory vydávají čísla. Některá dlouhá okna vyžadují placený plán (viz endpoint rodiny).

Snímek indikátoru

Snímek více indikátorů — nejnovější state (býčí/medvědí/vyčkávající…), score a surová data každé kategorie indikátoru v jednom payloadu.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

GET požadavek — bez těla požadavku.

Požadavek

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"

Řada rodiny indikátorů

Denní časová řada jedné rodiny indikátorů. Rodiny s více okny přijímají period a platná okna se liší podle rodiny: 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. Rodiny s jednou řadou (MACD, OBV, ADX, VWAP, CMF) period ignorují. Mladé kryptoměny vracejí úvodní zahřívací null hodnoty.

Některá dlouhá okna vyžadují placený plán: 21/28denní RSI a Stoch-RSI a 30denní volatilitní okna vyžadují Starter nebo vyšší — jejich vyžádání na plánu Free vrátí 403 s kódem plan_required.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug kryptoměny.

family
string povinné
rsi

Rodina indikátorů — jedna z rsi, stoch-rsi, sma, cci, mfi, williams-r, price-volatility, volume-volatility, macd, obv, adx, vwap, cmf.

Parametry dotazu

period
integer volitelné
14

Délka okna (pouze tam, kde rodina má okna; musí být jedno z platných oken dané rodiny).

start
string volitelné
2026-06-01

Dolní mez data ISO.

end
string volitelné
2026-06-30

Horní mez data ISO.

limit
integer volitelné
30

Max řádků (1–1000, výchozí 365).

GET požadavek — bez těla požadavku.

Požadavek

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ů

Likvidace

Likvidace derivátů. Zdrojové pokrytí jsou aktuálně pouze OKX swap trhy (uvedeno v každém meta.note). SUROVÝ feed (seznam /liquidations a hodinový rozpad) je odstraněn po ~48 hodinách; denní souhrny se uchovávají navždy. Dnešní agregace jsou částečné a aktualizují se každých ~15 minut.

Feed likvidací

Surový feed likvidací (~posledních 48 h, poté odstraněn), od nejnovějších. Zdrojové pokrytí jsou aktuálně OKX swap trhy. Ceny jsou desetinné řetězce. meta nese stránkovací pole plus retention a note.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1). Musí být alespoň 1.

per_page
integer volitelné
50

Řádků na stránku. Limit závisí na plánu (Free 100, Starter/Pro 250); jeho překročení vrátí 422, místo aby hodnotu ořízlo. Musí být alespoň 1. Nesmí být větší než 100.

exchange
string volitelné
okx

Omezit na jednu burzu podle slugu. Zdrojové pokrytí jsou aktuálně OKX swap trhy. Musí odpovídat regulárnímu výrazu /^[a-z0-9-]{1,120}$/.

instrument
string volitelné
swap

Typ nástroje: future, option, swap, spot nebo margin.

Jedna z hodnot: future option swap spot margin

position
string volitelné
short

Strana likvidované pozice: long nebo short.

Jedna z hodnot: long short

order
string volitelné
buy

Strana obchodu, která spustila likvidaci: buy nebo sell.

Jedna z hodnot: buy sell

symbol
string volitelné
BTC

Shoda na prefix instId burzy (např. BTC odpovídá BTC-USDT-SWAP). Musí odpovídat regulárnímu výrazu /^[A-Za-z0-9$.-]{1,25}$/.

min_usd
number volitelné
1000

Pouze likvidace s hodnotou v USD na tomto prahu nebo vyšší. Musí být alespoň 0.

GET požadavek — bez těla požadavku.

Požadavek

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"

Hodinové likvidace

Hodinové součty long/short v USD nad surovým feedem. Protože surový feed je odstraněn po ~48 h, hours je omezeno na 48. Zdrojové pokrytí jsou aktuálně OKX swap trhy.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

hours
integer volitelné
24

Okno zpětného pohledu v hodinách (1–48, výchozí 24).

GET požadavek — bez těla požadavku.

Požadavek

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"

Denní likvidace

Denní agregace (uchovávané navždy), sečtené napříč burzami/nástroji za den — total/long/short USD plus počty long/short pozic. Dnešní řádek je částečný a aktualizuje se každých ~15 minut. Zdrojové pokrytí jsou aktuálně OKX swap trhy.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

days
integer volitelné
30

Počet kalendářních dní včetně dneška (1–365, výchozí 30).

GET požadavek — bez těla požadavku.

Požadavek

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"

Souhrn dnešních likvidací

Dnešek zatím — total/long/short USD, počty pozic a dominance long vs. short. Údaje jsou částečné a aktualizují se každých ~15 minut; data je null, dokud není zaznamenána první likvidace dne. Zdrojové pokrytí jsou aktuálně OKX swap trhy.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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"

Čistý tok likvidací

Denní tok likvidací long vs. short v USD za okno. Zdrojové pokrytí jsou aktuálně OKX swap trhy.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

days
integer volitelné
30

Počet kalendářních dní včetně dneška (1–90, výchozí 30).

GET požadavek — bez těla požadavku.

Požadavek

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"

Nejvíce likvidované kryptoměny

Nejvýznamnější kryptoměny podle objemu likvidací za nedávné okno, s rozdělením long/short v USD na kryptoměnu. Zdrojové pokrytí jsou aktuálně OKX swap trhy.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

hours
integer volitelné
24

Okno zpětného pohledu v hodinách (1–48, výchozí 24).

limit
integer volitelné
8

Počet kryptoměn k vrácení (1–20, výchozí 8).

GET požadavek — bez těla požadavku.

Požadavek

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ů

Převod

Převod mezi libovolnými dvěma aktivními aktivy (krypto I fiat) a výpis měn použitelných jako převodní strany. Hodnoty jsou desetinné řetězce. Fiat kurzy se aktualizují ~dvakrát denně; krypto kurzy ~každou minutu.

Převod mezi aktivy

Serverový převod mezi libovolnými dvěma aktivními aktivy (krypto I fiat). to přijímá CSV pro převod na více cílů; obrácení je pouze prohození from/to. Převod je lineární, takže value = unit_rate * amount. Fiat kurzy se aktualizují ~dvakrát denně; krypto kurzy ~každou minutu.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

from
string povinné
bitcoin

Slug zdrojového aktiva.

to
string povinné
ethereum

Slug(y) cílového aktiva, oddělené čárkou (až 10).

amount
number volitelné
2.5

Množství zdrojového aktiva k převodu (výchozí 1).

GET požadavek — bez těla požadavku.

Požadavek

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"

Seznam fiat měn

Aktivní fiat měny s jejich USD kurzy: rate_per_usd (jednotky na USD) a jeho převrácená hodnota usd_value. Fiat kurzy se aktualizují ~dvakrát denně.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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

Seznam převodních kurzů

Měny (vs-currencies) použitelné jako převodní strany — hlavní fiaty, kryptoměny a tokeny — každá s normalizovanou usd_value (USD za jednu jednotku). Hodnoty kryptoměn/tokenů se aktualizují ~každou minutu; pomalé fiat kurzy jsou ukládány do cache samostatně (~dvakrát denně).

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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ů

Kalkulačky

Serverové finanční kalkulačky zrcadlící webové nástroje: DCA, zisk/ztráta a půjčka (které čtou tržní data z cache), plus bezstavová matematika složeného úročení a stakingu.

DCA kalkulačka

Backtest pravidelného investování (dollar-cost averaging) nad reálnou denní historií cen kryptoměny: jeden nákup za amount na každý interval mezi start a end. Předejte series=true pro zahrnutí kompletní řady jednotlivých nákupů.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

slug
string povinné
bitcoin

Slug identifikátor kryptoměny.

amount
number povinné
100

USD utraceno na nákup (0.01–1,000,000,000).

interval
string povinné
weekly

Frekvence nákupů: daily, weekly, monthly, quarterly nebo yearly.

start
string povinné
2024-01-01

date Datum prvního nákupu (po 2008-12-31).

end
string volitelné
2025-01-01

date Datum posledního nákupu (výchozí dnešek).

series
boolean volitelné
false

Zahrnout do payloadu řadu jednotlivých nákupů.

GET požadavek — bez těla požadavku.

Požadavek

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"

Kalkulačka zisku / ztráty

Co vynesl nákup a následný prodej mezi dvěma historickými daty, s použitím reálných cen kryptoměny k těmto datům. Poplatky jsou fixní částky v USD, ne procenta.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

slug
string povinné
bitcoin

Slug identifikátor kryptoměny.

amount
number povinné
1000

USD investováno v buy_date (0.01–1,000,000,000).

buy_date
string povinné
2023-01-01

date Datum nákupu.

sell_date
string povinné
2025-01-01

date Datum prodeje (v den buy_date nebo po něm).

buy_fee
number volitelné
10

Fixní nákupní poplatek v USD (výchozí 0).

sell_fee
number volitelné
10

Fixní prodejní poplatek v USD (výchozí 0).

GET požadavek — bez těla požadavku.

Požadavek

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"

Kalkulačka složeného úročení

Čistá matematika — žádná tržní data. Vezměte na vědomí, že sazba platí ZA JEDNO ÚROKOVACÍ OBDOBÍ (konvence webové kalkulačky), ne za rok.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

principal
number povinné
10000

Počáteční zůstatek v USD.

rate
number povinné
1

Úroková sazba v % za jedno úrokovací období.

duration
integer povinné
5

Délka projekce (roky jsou omezeny na 50).

duration_unit
string volitelné
years

years (výchozí) nebo months.

compound_frequency
string volitelné
monthly

daily, weekly, monthly (výchozí), quarterly nebo annually.

contribution
number volitelné
100

Opakovaný vklad v USD (výchozí 0).

contribution_frequency
string volitelné
monthly

daily, weekly, monthly (výchozí), quarterly nebo annually.

GET požadavek — bez těla požadavku.

Požadavek

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"

Kalkulačka půjčka vs. prodej

Půjčka oproti krypto zástavě vs. jeho prodej — porovnává oba scénáře pomocí AKTUÁLNÍ ceny kryptoměny. Informativní projekce, ne finanční poradenství.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

slug
string povinné
bitcoin

Slug identifikátor kryptoměny.

crypto_amount
number povinné
2

Kolik kryptoměny držíte.

needed_cash
number povinné
50000

USD, které potřebujete uvolnit.

term_months
integer volitelné
36

Doba splatnosti půjčky v měsících (výchozí 36).

interest_rate
number volitelné
10

RPSN půjčky v % (výchozí 10).

ltv
number volitelné
50

Poměr úvěru k hodnotě (LTV) v % (výchozí 50).

expected_growth
number volitelné
25

Očekávaný růst ceny kryptoměny za období v % (výchozí 25).

tax_rate
number volitelné
25

Daň z kapitálových výnosů v %, aplikovaná na prodej (výchozí 25).

GET požadavek — bez těla požadavku.

Požadavek

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"

Kalkulačka odměn za staking

Čistá matematika — odměny za staking s volitelným složeným úročením a provizí validátora. Nečtou se žádná tržní data.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

amount
number povinné
1000

Množství ve stakingu, v jednotkách stakovaného aktiva.

period
number povinné
2

Délka období stakingu (omezeno na ekvivalent 50 let).

period_unit
string volitelné
years

years (výchozí), months nebo days.

apy
number povinné
5

Inzerované APY v %.

compound_frequency
string volitelné
monthly

never, daily, weekly, monthly (výchozí) nebo yearly.

commission
number volitelné
10

Provize validátora v %, odebraná z odměn (výchozí 0).

GET požadavek — bez těla požadavku.

Požadavek

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ů

Redakce

Redakční články — pouze publikované (ACTIVE). locale volí jazyk obsahu s anglickým záložním jazykem u jednotlivých polí (payload uvádí, který locale skutečně zvítězil). Články lze filtrovat podle štítku nebo podle souvisejícího slugu kryptoměny/burzy/peněženky. Čtení přes API záměrně NEZVYŠUJÍ počty zobrazení.

Videa kryptoměny

Kurátorovaná videa připojená ke kryptoměně (záložka Videa na stránce kryptoměny), stránkovaná.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug identifikátor kryptoměny.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1).

per_page
integer volitelné
10

Řádků na stránku (1–50, výchozí 10).

type
string volitelné
review

Filtrovat podle typu videa (např. overview, tutorial, explainer, review, analysis, news).

search
string volitelné
halving

Volnotextové vyhledávání podle názvu.

GET požadavek — bez těla požadavku.

Požadavek

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"

Časová osa postřehů o kryptoměně

Časová osa postřehů o kryptoměně — stejný payload, který používá panel postřehů na stránce aktiva, ohraničený pomocí offset/limit.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
bitcoin

Slug identifikátor kryptoměny.

Parametry dotazu

locale
string volitelné
en

Jazyk obsahu (záložně angličtina).

offset
integer volitelné
0

Řádků k přeskočení (0–500, výchozí 0).

limit
integer volitelné
5

Řádků k vrácení (1–50, výchozí 5).

GET požadavek — bez těla požadavku.

Požadavek

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"

Seznam článků

Publikované články, od nejnovějších, stránkované. Filtrujte podle tag nebo souvisejícího slugu coin / exchange / wallet, nebo volnotextovým search. Každý řádek je souhrn (název, podnázev, štítky, doba čtení, hlavní obrázek, související entity, data).

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1).

per_page
integer volitelné
20

Řádků na stránku (1–50, výchozí 20).

locale
string volitelné
en

Jazyk obsahu (záložně angličtina).

tag
string volitelné
guide

Filtrovat podle štítku: news, guide, tutorial, explainer, analysis, review, trading, overview nebo information.

coin
string volitelné
bitcoin

Filtrovat na články související s tímto slugem kryptoměny.

exchange
string volitelné
binance-exchange

Filtrovat na články související s tímto slugem burzy.

wallet
string volitelné
frostsnap

Filtrovat na články související s tímto slugem peněženky.

search
string volitelné
halving

Volnotextové vyhledávání podle nadpisu/podnadpisu.

GET požadavek — bez těla požadavku.

Požadavek

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"

Získat článek

Jeden publikovaný článek s jeho kompletním tělem, štítky, hlavním obrázkem, počítadly užitečnosti a souvisejícími entitami. locale volí jazyk obsahu s anglickým záložním jazykem u jednotlivých polí (payload uvádí, který locale skutečně zvítězil).

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
what-is-bitcoin

Slug článku.

Parametry dotazu

locale
string volitelné
en

Jazyk obsahu (záložně angličtina).

GET požadavek — bez těla požadavku.

Požadavek

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"

Odeslat zpětnou vazbu k článku

Zaregistruje palec nahoru/dolů u článku — stejná počítadla, která používají webová tlačítka užitečnosti. Omezování na klíč se uplatňuje výše v řetězci.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

slug
string povinné
what-is-bitcoin

Slug článku.

Parametry těla

helpful
boolean povinné
true

true pro užitečné, false pro neužitečné.

Požadavek

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

Získat video

Jedno kurátorované video s jeho YouTube id, názvem, typem, délkou a kryptoměnami/burzami/peněženkami, ke kterým je připojeno.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

id
integer povinné
87

ID videa.

GET požadavek — bez těla požadavku.

Požadavek

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"

Seznam postřehů

AI generované tržní postřehy, stránkované. Filtrujte podle type, souvisejícího slugu coin nebo volnotextovým search; locale volí jazyk titulku/shrnutí s anglickým záložním jazykem.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1).

per_page
integer volitelné
20

Řádků na stránku (1–50, výchozí 20).

locale
string volitelné
en

Jazyk obsahu (záložně angličtina).

type
string volitelné
per_asset

Filtrovat podle typu postřehu: per_asset, market_overview nebo narrative.

coin
string volitelné
bitcoin

Filtrovat na postřehy o této kryptoměně podle slugu.

search
string volitelné
etf

Volnotextové vyhledávání podle titulku.

sort
string volitelné
first_reported

Pořadí řazení: first_reported (výchozí) nebo last_updated.

GET požadavek — bez těla požadavku.

Požadavek

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"

Získat postřeh

Jeden postřeh s jeho kompletním payloadem — titulek, shrnutí, časová osa zdrojových článků a související kryptoměny.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

id
integer povinné
101

ID postřehu.

Parametry dotazu

locale
string volitelné
en

Jazyk obsahu (záložně angličtina).

GET požadavek — bez těla požadavku.

Požadavek

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ů

Alarmy

CRUD cenových alarmů — stejné alarmy, které spravuje webová aplikace. Alarmy spotřebovávají zůstatek alarmů majitele klíče, jsou typu TARGET pouze na kryptoměnách a ochrana above/below vůči aktuální hodnotě blokuje alarmy, které by se okamžitě samy spustily. Vázáno na klíč (API klíč určuje majitele) a nikdy neuloženo v cache odpovědí.

Seznam alarmů

Alarmy majitele klíče, od nejnovějších, stránkované. Filtrujte podle status, direction nebo kanálu notification.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1).

per_page
integer volitelné
25

Řádků na stránku (1–100, výchozí 25).

status
string volitelné
active

Filtrovat podle stavu: active nebo triggered.

direction
string volitelné
above

Filtrovat podle směru spuštění: above nebo below.

notification
string volitelné
email

Filtrovat podle kanálu doručení: email, push nebo webhook.

GET požadavek — bez těla požadavku.

Požadavek

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"

Vytvořit alarm

Vytvoří TARGET alarm na kryptoměně a spotřebuje jeden slot alarmu ze zůstatku majitele klíče. Cílová hodnota je porovnána s aktuální hodnotou kryptoměny, aby se alarm nemohl okamžitě sám spustit: alarm above musí cílit výše než aktuální hodnota, alarm below níže.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry těla

name
string povinné
BTC six figures

Popisek alarmu (max 255 znaků).

coin
string povinné
bitcoin

Slug identifikátor kryptoměny.

metric
string povinné
rate

Sledovaná metrika: rate, volume nebo marketcap.

direction
string povinné
above

Směr spuštění: above nebo below.

target
number povinné
100000

Prahová hodnota (musí ležet na straně direction vůči aktuální hodnotě kryptoměny).

notification
string povinné
email

Kanál doručení: email, push nebo webhook.

Požadavek

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

Smazat alarm

Smaže jeden z alarmů majitele klíče a vrátí slot alarmu, který spotřeboval.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

id
integer povinné
42

ID alarmu.

Požadavek

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ů

Webhooky

Bitculator POSTuje každou událost jako JSON s hlavičkou HMAC podpisu:

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

Ověřte jej opětovným výpočtem HMAC nad "." pomocí vašeho tajného klíče endpointu a porovnáním v konstantním čase; odmítněte, pokud je t starší než několik minut (ochrana proti replay útoku). Příklad (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);

Podporované události: alarm.triggered. Doručení se opakují 3× s prodlevou; endpoint se automaticky deaktivuje po 10 po sobě jdoucích neúspěšných doručeních.

Seznam webhook endpointů

Webhook endpointy majitele klíče, od nejnovějších. Podpisové tajné klíče nejsou nikdy zahrnuty — každý tajný klíč je zobrazen právě jednou, při vytvoření.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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

Vytvořit webhook endpoint

Zaregistruje HTTPS endpoint (max 5 na účet) pro doručování událostí. Odpověď obsahuje podpisový secret — JEDINÁ chvíle, kdy je vůbec zobrazen, takže si jej okamžitě uložte.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry těla

url
string povinné
https://example.com/webhooks/bitculator

HTTPS URL pro doručování. Pouze veřejní hostitelé — interní/privátní adresy jsou odmítnuty.

events
string[] povinné
["alarm.triggered"]

Události k odběru. Povolené hodnoty: alarm.triggered.

Požadavek

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

Smazat webhook endpoint

Smaže jeden z webhook endpointů majitele klíče. Čekající doručení na něj jsou zahozena.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

id
integer povinné
7

ID webhook endpointu.

Požadavek

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

Odeslat testovací událost

Odešle podepsanou testovací událost alarm.triggered (test: true v payloadu, skutečné podpisové hlavičky), aby bylo možné příjemce kompletně ověřit.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

id
integer povinné
7

ID webhook endpointu.

Požadavek

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 doručení webhooků

Pokusy o doručení endpointu (uchovávané 30 dní), od nejnovějších, stránkované.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

Parametry cesty

id
integer povinné
7

ID webhook endpointu.

Parametry dotazu

page
integer volitelné
1

Číslo stránky (od 1).

per_page
integer volitelné
25

Řádků na stránku (1–100, výchozí 25).

GET požadavek — bez těla požadavku.

Požadavek

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 a introspekce API: autentizovaný ping pro ověření klíče a middlewarového řetězce, využití/kvóta aktuálního klíče a strojově čitelná OpenAPI specifikace.

OpenAPI specifikace

Strojově čitelný OpenAPI 3 dokument pro toto API, jako JSON — nasměrujte na tuto URL codegen nebo API nástroje. Veřejné: klíč není potřeba.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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

Autentizovaná prázdná operace pro kompletní ověření klíče Data API (auth.api → burst limit podle plánu → měsíční kvóta). Počítá se do kvóty jako každé jiné volání.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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

Využití klíče a kvóta

Introspekce využití pro majitele volajícího klíče: plán Data API, jeho měsíční limit, využito a zbývá (vždy odpovídající hlavičkám X-Quota-*), aktuální období a rozpady podle endpointu / podle tokenu. Využití embed widgetů má vlastní plán a fond — zde se nikdy neobjeví.

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

Klíče jsou pouze Bearer a nesou schopnost data-api — uchovávejte je na straně serveru.

GET požadavek — bez těla požadavku.

Požadavek

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