Kolam 18
Pelombong T/B
Pekerja T/B
Pembangun

API Kolam

Setiap kolam HeroMiners menjawab set endpoint HTTP baca sahaja yang sama. Tiada kunci, tiada akaun dan tiada pendaftaran: minta satu URL dan anda menerima JSON, dengan Access-Control-Allow-Origin: * ditetapkan supaya halaman dalam pelayar boleh memanggilnya secara terus. Gunakannya untuk membina pemantau rig, pemberitahu bayaran, papan pemuka anda sendiri, atau untuk menarik data kolam ke dalam hamparan.

Setiap syiling mempunyai kolam sendiri dengan angka sendiri dan format alamat sendiri, jadi pilih syiling dahulu dan masukkan alamat untuk syiling tersebut. Apa-apa yang anda taip di sini tidak dihantar ke mana-mana kecuali ke kolam itu sendiri, dan hanya apabila anda menekan Jalankan.

URL Asas
https://alephium.herominers.com

Endpoint

GET /api/stats

Semua yang kolam tahu tentang dirinya sekarang: hashrate kolam dan rangkaian, pelombong dan pekerja yang bersambung, blok terakhir, yuran, port dan tetapan bayaran.

Query
address
Alamat bayaran. Menambah pelombong itu di bawah miner, dan di bawah solo_miner jika dia juga melombong secara solo. Jika ditinggalkan, kedua-dua kunci itu tidak dihantar.

Inilah endpoint untuk bermula. Halaman kolam, halaman pelombong dan setiap carta di laman ini dibina daripadanya.

Permintaan
curl "https://alephium.herominers.com/api/stats"
Jawapan

Objek dengan pool, network, config, charts, lastblock, payments dan visitors, iaitu bilangan orang di laman ini sekarang, sebagai { windowMinutes, activeVisitors, activeLookups }. Dikira semula sekali setiap kitaran statistik, jadi meninjau lebih kerap daripada itu memberikan angka yang sama.

GET /api/live_stats

Muatan yang sama seperti /api/stats, tetapi dibiarkan terbuka sehingga kitaran statistik seterusnya selesai, kemudian dijawab. Satu permintaan bagi setiap kemas kini, bukan meninjau dengan pemasa.

Query
address
Sertakan pelombong dalam muatan, seperti dengan /api/stats.

Buka satu sambungan dan buka semula apabila ia dijawab. Beberapa sambungan terbuka serentak dari IP yang sama ditolak dengan 503, jadi jangan buka banyak sekaligus.

Permintaan
curl "https://alephium.herominers.com/api/live_stats"
Jawapan

Bentuk yang sama seperti /api/stats, kecuali miner dan solo_miner sentiasa dihantar, kosong jika tiada alamat diberikan. Permintaan kekal terbuka sehingga satu kitaran statistik.

GET /api/stats_address

Seorang pelombong: hashrate semasa dan purata, share sah dan share basi, baki, jumlah dibayar, dan angka yang sama bagi setiap pekerja.

Query
addresswajib
Alamat bayaran yang hendak dicari.
Permintaan
curl "https://alephium.herominers.com/api/stats_address"

Masukkan address di atas untuk menjalankan yang ini. Arahan menunjukkannya kerana kolam menjawab dengan ralat tanpanya.

Jawapan

Objek dengan stats (jumlah pelombong), payments, charts, unlocked dan workers, iaitu tatasusunan dengan satu entri bagi setiap pekerja yang dinamakan dengan name. Alamat yang tidak pernah melombong di sini dijawab dengan ralat, bukan pelombong kosong.

GET /api/get_blocks

Blok yang ditemui kolam yang tidak lagi belum matang: sudah dibayar, atau yatim. status menyatakan yang mana.

Query
heightwajib
Pulangkan blok di bawah ketinggian ini. Berikan nombor yang jauh melebihi hujung rantaian untuk halaman terbaru, kemudian ketinggian terendah yang anda terima untuk berundur ke halaman sebelumnya.

Alamat penemu disamarkan sebelum keluar dari kolam, jadi endpoint ini tidak boleh digunakan untuk mengumpul alamat. time dalam saat Unix, reward dalam unit terkecil syiling, dan blok solo membawa score bernilai s0 apabila ia telah dibayar atau s1 apabila ia menjadi yatim.

Permintaan
curl "https://alephium.herominers.com/api/get_blocks?height=9999999999"
Jawapan

Tatasusunan rata yang berselang-seli antara nilai dan ketinggian: [block, height, block, height, ...]. Setiap blok dipisahkan dengan titik bertindih:

0hash1time2difficulty3shares4score5nonce6status7reward8finder9region10rewardScheme
GET /api/get_payments

Bayaran yang telah dihantar kolam, sama ada untuk seluruh kolam atau untuk satu alamat.

Query
timewajib
Pulangkan bayaran sebelum cap masa Unix ini dalam saat. Gunakan masa semasa untuk halaman terbaru, kemudian cap masa tertua yang anda terima untuk berundur ke halaman sebelumnya.
address
Hadkan kepada satu alamat bayaran. Tinggalkan untuk setiap bayaran yang pernah dibuat kolam.
limit
Berapa banyak yang dipulangkan. Dihadkan kepada saiz halaman kolam sendiri, jadi nombor yang lebih besar hanya memulangkan saiz itu.
format
Berikan parsed untuk mendapat objek { tx, amount, time } dan bukan tatasusunan mentah.
conversions
Bersama address, berikan 1 untuk turut mendapat rekod penukaran bagi setiap bayaran di halaman itu yang ditukar kepada syiling lain. Jawapan kemudian menjadi { payments, conversions }. Diabaikan bersama format=parsed.
Permintaan
curl "https://alephium.herominers.com/api/get_payments?time=1792758504"
Jawapan

Tanpa format, tatasusunan rata yang berselang-seli antara nilai dan cap masa, dengan setiap nilai berbentuk txid:amount. Jumlah ialah rentetan dalam unit terkecil syiling dan mesti kekal sebagai rentetan: menukarnya kepada nombor akan kehilangan ketepatan pada rantaian dengan 18 tempat perpuluhan.

GET /api/get_miners_stats

Sepuluh pelombong terbesar di kolam, serta pecahan perisian perlombongan dan rantau di sebalik halaman pelombong.

Permintaan
curl "https://alephium.herominers.com/api/get_miners_stats"
Jawapan

Objek dengan miners, agents, regions, regionHistory dan statsDisplay. Alamat disamarkan. Apabila sesuatu panel tidak didayakan, tatasusunannya kembali kosong dan statsDisplay menyatakannya.

GET /api/get_blocks_search_config

Sama ada carian blok dihidupkan, dan had yang mesti dipenuhi query, supaya kotak carian boleh disediakan sebelum carian pertama.

Permintaan
curl "https://alephium.herominers.com/api/get_blocks_search_config"
Jawapan

{ enabled, minQueryLength, maxQueryLength, frontendCooldownMs }. Panjang dalam aksara, dan frontendCooldownMs ialah berapa lama perlu menunggu antara dua carian.

GET /api/get_miner_payout_level

Ambang bayaran yang kini ditetapkan untuk sesuatu alamat, dalam syiling penuh.

Query
addresswajib
Alamat bayaran.

Pasangannya, /api/set_miner_payout_level, yang menulisnya, dan ia tidak terbuka kepada sesiapa sahaja: permintaan mesti datang dari IP perlombongan alamat itu sendiri. Semakan itu, dan had kadar di hadapannya, diterangkan dalam tab tetapan papan pemuka, bukan di sini.

Permintaan
curl "https://alephium.herominers.com/api/get_miner_payout_level"

Masukkan address di atas untuk menjalankan yang ini. Arahan menunjukkannya kerana kolam menjawab dengan ralat tanpanya.

Jawapan

{ status: "done", level }. Alamat yang tidak pernah menetapkannya mendapat minimum kolam.

GET /api/miner_ban_status

Notis sekatan yang ditunjukkan halaman pelombong untuk sesuatu alamat, dan apa-apa mesej yang ditinggalkan pengendali untuknya.

Query
addresswajib
Alamat bayaran.
Permintaan
curl "https://alephium.herominers.com/api/miner_ban_status"

Masukkan address di atas untuk menjalankan yang ini. Arahan menunjukkannya kerana kolam menjawab dengan ralat tanpanya.

Jawapan

{ banned, minerMessage }, dan apabila disekat juga blockMining, blockPayments dan reason. Ia ialah notis yang ditunjukkan halaman pelombong untuk alamat ini: disekat daripada melombong, daripada dibayar, atau tidak kedua-duanya. minerMessage ialah mesej pengendali untuk alamat ini, sebagai { message, type, createdAt, expiresAt }, atau null apabila tiada.

Menggunakannya dengan baik

  • Tinjau mengikut jadual kolam sendiri. Angka dikira semula sekali setiap kitaran statistik, dan config.updateInterval dalam jawapan /api/stats menyatakan tempohnya dalam saat. Meminta lebih kerap daripada itu memberikan jawapan yang sama dan membazirkan lebar jalur kita berdua.
  • Utamakan /api/live_stats berbanding pemasa pantas. Ia menjawab sebaik sahaja ada sesuatu yang baharu, jadi lebih cepat untuk anda dan lebih ringan bagi kolam berbanding meninjau.
  • Simpan jumlah sebagai rentetan. Ganjaran dan baki dipulangkan dalam unit terkecil syiling. Pada rantaian dengan 18 tempat perpuluhan, integer itu melebihi apa yang boleh disimpan dengan tepat oleh nombor JavaScript, jadi menukarnya kepada nombor akan membundarkan bayaran tanpa disedari.
  • Jangka alamat disamarkan. Senarai awam menyembunyikan bahagian tengah setiap alamat. Alamat penuh anda hanya diperlukan oleh anda sendiri, dan hanya di tempat anda memberikannya.
  • Anggap had kadar sebagai masa menunggu, bukan kegagalan. Apabila had dikenakan, jawapan membawa retryMs. Tunggu selama itu dan cuba semula, jangan terus membanjiri permintaan.
  • Nyatakan siapa anda. User-Agent yang menamakan alat anda tidak wajib, tetapi dengannya kami boleh memberitahu anda tentang sesuatu perubahan dan bukan meneka apa yang rosak.