Každý pool HeroMiners odpovídá na stejnou sadu HTTP endpointů jen pro čtení. Žádný klíč, žádný účet a žádná registrace: požádáte o URL a dostanete zpět JSON, s nastaveným Access-Control-Allow-Origin: *, takže ho stránka v prohlížeči může volat přímo. Použijte ho k sestavení monitoru rigu, upozornění na výplaty, vlastního dashboardu nebo k načtení poolu do tabulky.
Zadejte svou adresu a každý příklad níže bude připravený ke spuštění proti tomuto poolu. Nic, co sem napíšete, se neposílá nikam jinam než do samotného poolu, a to jen po stisknutí Spustit.
Základní URL
https://quantus.herominers.com
Endpointy
GET/api/stats
Vše, co pool právě teď ví sám o sobě: hashrate poolu a sítě, připojení těžaři a workery, poslední blok, poplatky, porty a nastavení výplat.
Parametry
address
Výplatní adresa. Přidá daného těžaře pod miner a pod solo_miner, pokud těží i solo. Bez ní se žádný z těchto klíčů neposílá.
Tímto endpointem začněte. Stránka poolu, stránka těžařů a každý graf na tomto webu jsou sestavené z něj.
Požadavek
curl "https://quantus.herominers.com/api/stats"
Odpověď
Objekt s pool, network, config, charts, lastblock, payments a visitors, tedy kolik lidí je právě na webu, jako { windowMinutes, activeVisitors, activeLookups }. Přepočítává se jednou za cyklus statistik, takže častější dotazování vrací stejná čísla.
GET/api/live_stats
Stejná data jako /api/stats, ale požadavek zůstane otevřený, dokud neskončí další cyklus statistik, a teprve pak přijde odpověď. Jeden požadavek na aktualizaci místo dotazování podle časovače.
Parametry
address
Zahrnout do dat těžaře, stejně jako u /api/stats.
Otevřete jedno spojení a po odpovědi ho otevřete znovu. Více současně otevřených spojení ze stejné IP se odmítne s kódem 503, takže je nerozvětvujte.
Stejný tvar jako /api/stats, jen miner a solo_miner se posílají vždy, prázdné, pokud nebyla zadána adresa. Požadavek zůstává otevřený až jeden cyklus statistik.
GET/api/stats_address
Jeden těžař: aktuální a průměrný hashrate, platné a stale shares, zůstatek, vyplacená částka a tytéž údaje pro každý worker.
Pro spuštění zadejte výše address. Příkaz to obsahuje, protože bez toho pool odpoví chybou.
Odpověď
Objekt se stats (součty těžaře), payments, charts, unlocked a workers, tedy polem s jednou položkou pro každý worker pojmenovaný svým name. Adresa, která tu nikdy netěžila, dostane chybu, ne prázdného těžaře.
GET/api/get_blocks
Bloky, které pool našel a které už nečekají: vyplacené, nebo osiřelé. Které to je, říká status.
Parametry
heightpovinné
Vrátí bloky pod touto výškou. Pro nejnovější stránku zadejte číslo vysoko nad špičkou řetězce, pak nejnižší přijatou výšku pro listování zpět.
Adresa nálezce se maskuje dřív, než opustí pool, takže tento endpoint nelze použít ke sběru adres. time je v Unixových sekundách, reward v nejmenší jednotce mince a solo blok nese score s hodnotou s0, když byl vyplacen, nebo s1, když osiřel.
Výplaty, které pool odeslal, buď za celý pool, nebo pro jednu adresu.
Parametry
timepovinné
Vrátí výplaty před tímto Unixovým časem v sekundách. Pro nejnovější stránku použijte aktuální čas, pak nejstarší přijatý čas pro listování zpět.
address
Omezí výsledek na jednu výplatní adresu. Bez ní vrátí všechny výplaty poolu.
limit
Kolik položek vrátit. Omezeno na vlastní velikost stránky poolu, takže větší číslo prostě vrátí ji.
format
Zadejte parsed a místo surového pole dostanete objekty { tx, amount, time }.
conversions
S address zadejte 1 a dostanete i záznam o směně každé výplaty na stránce, která byla směněna na jinou minci. Odpověď pak má tvar { payments, conversions }. S format=parsed se ignoruje.
Bez format ploché pole, ve kterém se střídá hodnota a čas, přičemž každá hodnota je txid:amount. Částky jsou řetězce v nejmenší jednotce mince a musí řetězci zůstat: převod na číslo ztrácí přesnost na řetězci s 18 desetinnými místy.
GET/api/get_miners_stats
Deset největších těžařů v poolu a k tomu rozdělení podle těžebního softwaru a regionů, ze kterých vychází stránka těžařů.
Objekt s miners, agents, regions, regionHistory a statsDisplay. Adresy jsou maskované. Když panel není zapnutý, jeho pole přijde prázdné a statsDisplay to uvede.
GET/api/get_blocks_search
Hledání v blocích poolu podle výšky, hashe bloku nebo adresy nálezce, v čekajících i vyplacených blocích najednou.
Parametry
qpovinné
Výška, hash bloku nebo adresa.
offset
Přeskočí tolik výsledků. Odpověď nese hasMore, takže víte, zda se ptát znovu.
Hledání má limit na IP a jeho překročení vrátí rateLimited s přesnou dobou čekání v retryMs, ne holou chybu. Nejdřív zavolejte /api/get_blocks_search_config a zjistěte meze délky a zda je hledání vůbec zapnuté.
Pro spuštění zadejte výše q. Příkaz to obsahuje, protože bez toho pool odpoví chybou.
Odpověď
Objekt s pending a matured, v obou se střídá hodnota a výška jako u /api/get_blocks, plus totalMatched, offset, limit a hasMore. Blok v matured má formát /api/get_blocks; blok v pending ještě čeká na dozrání a používá delší formát čekajících bloků, takže jeho pole jsou v jiném pořadí.
GET/api/get_blocks_search_config
Zda je hledání bloků zapnuté a do jakých mezí se dotaz musí vejít, aby šlo vyhledávací pole nastavit před prvním hledáním.
{ enabled, minQueryLength, maxQueryLength, frontendCooldownMs }. Délky jsou ve znacích a frontendCooldownMs udává, jak dlouho čekat mezi dvěma hledáními.
GET/api/get_miner_payout_level
Práh výplaty aktuálně nastavený pro adresu, v celých mincích.
Parametry
addresspovinné
Výplatní adresa.
Zapisuje ho odpovídající /api/set_miner_payout_level a není otevřený komukoli: požadavek musí přijít z vlastní těžební IP dané adresy. Tato kontrola a limit před ní jsou popsané na kartě nastavení v dashboardu, ne zde.
Pro spuštění zadejte výše address. Příkaz to obsahuje, protože bez toho pool odpoví chybou.
Odpověď
{ banned, minerMessage } a při blokaci také blockMining, blockPayments a reason. Je to oznámení, které stránka těžaře pro tuto adresu ukazuje: blokace těžby, blokace výplat, nebo žádná. minerMessage je zpráva provozovatele pro tuto adresu jako { message, type, createdAt, expiresAt }, nebo null, když žádná není.
Jak ho používat dobře
Dotazujte se v rytmu poolu. Čísla se přepočítávají jednou za cyklus statistik a config.updateInterval v odpovědi /api/stats udává jeho délku v sekundách. Častější dotazy vracejí stejnou odpověď a stojí přenos nás oba.
Dejte přednost /api/live_stats před rychlým časovačem. Odpoví v okamžiku, kdy je něco nového, což je pro vás rychlejší a pro pool šetrnější než dotazování.
Částky nechte jako řetězce. Odměny a zůstatky přicházejí v nejmenší jednotce mince. Na řetězci s 18 desetinnými místy tato celá čísla přesahují to, co číslo v JavaScriptu dokáže uložit přesně, takže převod na číslo potichu zaokrouhlí výplatu.
Počítejte s maskovanými adresami. Veřejné seznamy skrývají střed každé adresy. Celou vlastní adresu potřebujete jen vy a jen tam, kde ji sami zadáte.
Limit berte jako čekání, ne jako selhání. Kde platí limit, odpověď nese retryMs. Počkejte tak dlouho a zkuste to znovu, místo zahlcování.
Představte se. Hlavička User-Agent s názvem vašeho nástroje není povinná, ale díky ní vám můžeme dát vědět o změně, místo abychom hádali, co se rozbilo.