{"openapi":"3.1.0","info":{"title":"Lotus Node API","description":"RESTful API for the Lotus blockchain node. All data is served directly from the node's embedded SQLite database and in-memory state — no external indexer required. Supports chain info, block and transaction queries, address balances with rich list, mempool monitoring with history, mining stats, network peers, historical charts (hashrate, difficulty, supply), real-time events via long-polling, and a combined overview endpoint for dashboards.","version":"v12.4.16-ae2eb6c2f"},"servers":[{"url":"/api/v1","description":"This node"}],"paths":{"/api/v1/chain":{"get":{"summary":"Get blockchain status and metadata","description":"Returns the current chain name, height, best block hash, difficulty, median time, cumulative chain work, and whether the node is still in initial block download (IBD). While the explorer database is not ready (a first sync and the work after it), an explorer_indexing object is added: state, phase, indexes_built of indexes_total, and the after-sync steps: step of steps_total, current_step and its label, step_done of step_total (slices of mark_spent, MiB of the final write), step_elapsed_s, step_eta_s and eta_s (estimates, -1 unknown), spent (deferred, marking, ready) and steps[] (name, kind, state, done, total, elapsed_s, eta_s, unlocks: what comes back when the step is done). Absent on a ready node.","operationId":"getChainInfo","tags":["Chain"],"responses":{"200":{"description":"Chain info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChainInfo"}}}}}}},"/api/v1/chain/tip":{"get":{"summary":"Get the latest block (chain tip)","description":"Returns a summary of the most recently mined block, including hash, height, timestamp, transaction count, and size.","operationId":"getChainTip","tags":["Chain"],"responses":{"200":{"description":"Chain tip","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockSummary"}}}}}}},"/api/v1/chain/sync":{"get":{"summary":"Live sync state and speed","description":"Height of the last block connected, best header, initial_block_download, verification_progress, blocks/s and tx/s averaged over the last 10 s, 1 min and 10 min (null until that much history exists), remaining_blocks and eta_seconds (null when unknown). Never waits on the validation lock and is not cached, so it stays live during initial sync. height is -1 until a block has been connected since startup. While the explorer database is not ready (a first sync and the work after it), an explorer_indexing object is added: state, phase, indexes_built of indexes_total, and the after-sync steps: step of steps_total, current_step and its label, step_done of step_total (slices of mark_spent, MiB of the final write), step_elapsed_s, step_eta_s and eta_s (estimates, -1 unknown), spent (deferred, marking, ready) and steps[] (name, kind, state, done, total, elapsed_s, eta_s, unlocks: what comes back when the step is done). Absent on a ready node.","operationId":"getChainSync","tags":["Chain"],"responses":{"200":{"description":"Sync state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChainInfo"}}}}}}},"/api/v1/chain/utxo-commitment/{height}":{"get":{"summary":"Coinbase UTXO set commitment of a block","description":"The getutxocommitment RPC for block {height} of the active chain: enabled and mandatory (the Napoleon rule for that block), present, committed_height (= height - 10), committed_blockhash, muhash (the committed MuHash3072 digest), vout, local_muhash and match (this node's hash for the committed height while it keeps it, the last 74 blocks), and tracker {ready, height, muhash, kept}: this node's UTXO set hash at the tip. With ?muhash=<hex>[&minconf=<n>, default 100]: the verifyutxocommitment RPC instead, checking that hash for the set after block {height} against the commitment of block {height}+10 (valid, reason, confirmations, committed_muhash). Read-only, cached 10 s.","operationId":"getUtxoCommitment","tags":["Chain"],"parameters":[{"name":"height","in":"path","description":"Block height","required":true,"schema":{"type":"integer"}},{"name":"muhash","in":"query","description":"UTXO set hash to verify (64 hex)","required":false,"schema":{"type":"string"}},{"name":"minconf","in":"query","description":"With muhash: confirmations required on the committing block (default 100)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Commitment of the block, or the verification","content":{"application/json":{"schema":{"type":"object","description":"UtxoCommitment"}}}}}}},"/api/v1/contracts":{"get":{"summary":"Contracts (CONTRACT module)","description":"Every contract id (Taproot commitment Q) seen on the chain, newest change first: commitment, outputCount, unspentCount, unspentValue, firstHeight, lastHeight, latestTxid, latestVout, latestState, transitionCount; 12.4.12: kind (counter, vault, alp-offer, claim-tree, or null: the example template its revealed rules match), stateDecoded (a number for counter and alp-offer, locked or moving for a vault, else null) and keyPath (none: the revealed internal key is NUMS; present: a key-path spend or a real key; unknown before the first rule spend). 404 when the module is off (-contractindex=1), 503 module_closed.","operationId":"listContracts","tags":["Contracts"],"parameters":[{"name":"page","in":"query","description":"1-based page (default 1)","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Rows per page (default 25, at most 100)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contracts (CONTRACT module)","content":{"application/json":{"schema":{"type":"object","description":"ContractList"}}}}}}},"/api/v1/contracts/stats":{"get":{"summary":"Contract index figures","description":"contracts, outputs, unspentOutputs, unspentValue, statefulOutputs, keySpends, scriptSpends, unknownSpends, transitions, spentOutputs, lastIndexedHeight.","operationId":"getContractStats","tags":["Contracts"],"responses":{"200":{"description":"Contract index figures","content":{"application/json":{"schema":{"type":"object","description":"ContractStats"}}}}}}},"/api/v1/contracts/{id}":{"get":{"summary":"One contract and its outputs","description":"The list row (with kind, stateDecoded, keyPath) and outputs[]: txid, vout, height, value, state, blockHash, spent, spentTxid, spentVin, spentHeight, spendPath (key or script), leafHash, leafSize. Also /utxos (unspent outputs) and /history (state changes: txid, vin, toVout, fromTxid, fromVout, fromState, toState, height, path, leafHash, leafSize).","operationId":"getContract","tags":["Contracts"],"parameters":[{"name":"id","in":"path","description":"Contract id: 66 hex characters (33 bytes)","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-based page (default 1)","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Rows per page (default 25, at most 100)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"One contract and its outputs","content":{"application/json":{"schema":{"type":"object","description":"Contract"}}}}}}},"/api/v1/contracts/{id}/rules":{"get":{"summary":"The rules a contract revealed (12.4.12)","description":"rules[]: leafHash, leaf (the leaf script, hex), size, kind (the example template it matches, or null) and uses (spends through it). A contract reveals only the rules used; spends indexed before 12.4.12 show after a reindex of the module.","operationId":"getContractRules","tags":["Contracts"],"parameters":[{"name":"id","in":"path","description":"Contract id: 66 hex characters (33 bytes)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The rules a contract revealed (12.4.12)","content":{"application/json":{"schema":{"type":"object","description":"ContractRules"}}}}}}},"/api/v1/contracts/block/{id}":{"get":{"summary":"Contract state changes in one block (12.4.12)","description":"height, changes[] (txid, vin, toVout, commitment, fromState, toState, path, leafHash, block_pos, kind, fromStateDecoded, toStateDecoded), outputsCreated, outputsSpent, lastIndexedHeight.","operationId":"getContractBlock","tags":["Contracts"],"parameters":[{"name":"id","in":"path","description":"Block height","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Contract state changes in one block (12.4.12)","content":{"application/json":{"schema":{"type":"object","description":"ContractBlock"}}}}}}},"/api/v1/script/trace":{"post":{"summary":"Replay one input step by step","description":"With -scripttrace=1 (rate limited, -scripttraceratelimit per minute, 429 rate_limited): the tracescript RPC on a JSON body {tx: hex, input: n, spent?: [{value, scriptPubKey}], flags?: mempool | contracts | legacy, maxsteps?}. 12.4.12: {txid, input} instead of tx replays an input of a known transaction (mempool or -txindex), the coins it spends read from their creating transactions, so confirmed and spent inputs work. Answer: ok, error, cost, sigchecks, scriptsig_size, leaf_budget, leaf, leaf_asm, failed_at, steps[], truncated. 400 bad_body, invalid_hex, invalid_txid, trace_failed; 404 tx_not_found, spent_not_found (and when the route is off).","operationId":"traceScript","tags":["Contracts"],"responses":{"200":{"description":"Trace","content":{"application/json":{"schema":{"type":"object","description":"ScriptTrace"}}}}}}},"/api/v1/upgrades":{"get":{"summary":"Network upgrades: activation times and state","description":"Every MTP-activated network upgrade this node knows, oldest first: name (exodus ... napoleon, firstChronicles), label, activation_time (median time past, this network's value with the -<name>activationtime override applied (napoleon: also its deprecated alias -secondkingsactivationtime); 1st Chronicles reads -replayprotectionactivationtime), active (the next block is validated under it: tip median time past >= activation_time), active_since_height (the first block validated under it, null while inactive), seconds_until (0 once active), overridden (an override is set) and features (napoleon: mmv2, contracts, coinbase-height, miner-fund; firstChronicles: replay-protection); napoleon (Second Kings upstream: upstream_name) also has feature_times {mmv2, contracts: {activation_time, active}} (test networks can move them apart). Also chain, tip_height, tip_mtp, initial_block_download, node_version, client_version and next (the first upgrade not yet active, null when none). Read-only; cached per tip.","operationId":"getUpgrades","tags":["Chain"],"responses":{"200":{"description":"Network upgrades: activation times and state","content":{"application/json":{"schema":{"type":"object","description":"Upgrades"}}}}}}},"/api/v1/chain/utxo-snapshot":{"get":{"summary":"UTXO snapshot state","description":"Same object as the getutxosnapshotinfo RPC: active (false on a node that never loaded a UTXO snapshot), base_hash, base_height, coins, nchaintx, muhash, state (validating, validated, failed), loaded_time, validated_time, failure, and while validating background_validation {enabled, running, height, target, progress, waiting_for_block}. chain/sync carries the same object as utxo_snapshot while the history is being checked. See doc/utxo-snapshot.md.","operationId":"getUtxoSnapshot","tags":["Chain"],"responses":{"200":{"description":"Snapshot state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChainInfo"}}}}}}},"/api/v1/chain/utxo-hash/{height}":{"get":{"summary":"UTXO set hash at a height","description":"height, block_hash, muhash: the incremental MuHash3072 of the UTXO set after that block of the active chain (-utxohash; doc/utxo-snapshot.md 16.2). 404 when not recorded, 503 utxo_hash_disabled.","operationId":"getUtxoHash","tags":["Chain"],"responses":{"200":{"description":"UTXO set hash at a height","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChainInfo"}}}}}}},"/api/v1/utxo-snapshots":{"get":{"summary":"Periodic UTXO snapshots","description":"snapshots: the sidecars of the periodic snapshots kept by this node (height, block_hash, coins, nchaintx, muhash, sha256, bytes, manifest of 4 MiB chunk hashes). /api/v1/utxo-snapshots/{height} with Range: bytes=a-b (or offset/length) serves at most 8 MiB of the file (206), 429 with Retry-After beyond the byte-rate budget. doc/utxo-snapshot.md 16.4.","operationId":"listUtxoSnapshots","tags":["Chain"],"responses":{"200":{"description":"Periodic UTXO snapshots","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChainInfo"}}}}}}},"/api/v1/blocks":{"get":{"summary":"List recent blocks","description":"Returns a paginated list of blocks from the tip backwards. Each entry includes hash, height, timestamp, tx count, size, difficulty, and confirmations.","operationId":"listBlocks","tags":["Blocks"],"parameters":[{"name":"limit","in":"query","description":"Max results (1-100)","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Skip N blocks from tip","required":false,"schema":{"type":"integer"}},{"name":"pow_algo","in":"query","description":"12.4.12: only the blocks of this proof (lotushash, sha256d-auxpow, scrypt-auxpow) among the last `scan` blocks; total = the matches","required":false,"schema":{"type":"string"}},{"name":"scan","in":"query","description":"With pow_algo: blocks scanned from the tip, 1-10000 (default 2000)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Block list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBlocks"}}}}}}},"/api/v1/blocks/{id}":{"get":{"summary":"Get block by hash or height","description":"Accepts either a block hash (64 hex chars) or a decimal height. Returns full block summary including coinbase, merkle root, and transaction count.","operationId":"getBlock","tags":["Blocks"],"parameters":[{"name":"id","in":"path","description":"Block hash or height","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Block details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockSummary"}}}}}}},"/api/v1/blocks/{id}/txs":{"get":{"summary":"Get transactions in a block","description":"For a block that is not in the active chain (stale, invalid, parked) the transactions are read from the block file: the answer carries in_active_chain false, status, source \"block_file\", and each entry orphaned true. 404 block_data_unavailable when the node has only its header. For a block of the active chain each entry also carries, from the explorer index: is_coinbase, input_count, output_count, output_value_sats, input_value_sats and fee_sats (not for the coinbase), and op_return_hex (the first OP_RETURN output's script, at most 223 bytes) when there is one.","operationId":"getBlockTxs","tags":["Blocks"],"parameters":[{"name":"id","in":"path","description":"Block hash or height","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max results","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Block txs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedTxRefs"}}}}}}},"/api/v1/txs/{txid}":{"get":{"summary":"Get transaction by txid","description":"Returns transaction details including inputs, outputs, fees, block height, confirmations, and OP_RETURN data if present. A transaction found only in a block that is not in the active chain is answered with orphaned true (see TxSummary).","operationId":"getTx","tags":["Transactions"],"parameters":[{"name":"txid","in":"path","description":"Transaction ID (64 hex chars)","required":true,"schema":{"type":"string"}},{"name":"block","in":"query","description":"Hash of a block that is not in the active chain to read the transaction from when it is in no active block and not in the mempool (also for /inputs and /outputs)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Tx summary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TxSummary"}}}}}}},"/api/v1/txs/{txid}/inputs":{"get":{"summary":"Get transaction inputs","operationId":"getTxInputs","tags":["Transactions"],"parameters":[{"name":"txid","in":"path","description":"Transaction ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Inputs array","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TxInputArray"}}}}}}},"/api/v1/txs/{txid}/outputs":{"get":{"summary":"Get transaction outputs","description":"Each output has spent (bool) and, when spent, spent_txid (the spending transaction, read from its inputs). During a node's first sync, until the spent-by index is built, the spent fields are absent and each output carries spent_indexing: true instead (never a wrong 'unspent'); spent_indexing is never present once the explorer is ready. An output without an address (OP_RETURN data, burn, non-standard) carries script_hex, its script (at most 223 bytes). Since 12.4.12: token (TokenData) when the output carries a token, and spent_in_mempool + pending_spend_txid for an unspent output a mempool transaction spends. Inputs carry token (what the spent output carried). The summary (/txs/{txid}) carries token_tx (TokenTx) for a transaction that carries or spends tokens.","operationId":"getTxOutputs","tags":["Transactions"],"parameters":[{"name":"txid","in":"path","description":"Transaction ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Outputs array","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TxOutputArray"}}}}}}},"/api/v1/txs/{txid}/raw":{"get":{"summary":"Raw transaction (hex)","description":"{txid, hex, blockhash?, in_active_chain?, orphaned?}: from the mempool, -txindex, or (without -txindex) the block file of a confirmed transaction found in the explorer index. /verbose decodes it (mempool or -txindex only). 404 tx_not_found otherwise.","operationId":"getTxRaw","tags":["Transactions"],"parameters":[{"name":"txid","in":"path","description":"Transaction ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Raw transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TxSummary"}}}}}}},"/api/v1/mempool":{"get":{"summary":"Get mempool info and pending transactions","description":"Returns current mempool size, byte total, and a list of unconfirmed transaction IDs with their fee rates and sizes.","operationId":"getMempool","tags":["Mempool"],"parameters":[{"name":"limit","in":"query","description":"Max transactions (1-500)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Mempool info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MempoolInfo"}}}}}}},"/api/v1/txs/send":{"post":{"summary":"Submit a raw transaction","operationId":"sendTx","tags":["Transactions"],"responses":{"201":{"description":"Accepted tx","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTxResult"}}}}}}},"/api/v1/txs/decode":{"post":{"summary":"Decode a raw transaction","operationId":"decodeTx","tags":["Transactions"],"responses":{"200":{"description":"Decoded tx","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecodedTx"}}}}}}},"/api/v1/txs/broadcast":{"post":{"summary":"Broadcast a raw transaction","description":"Relays through sendrawtransaction. The guard runs only with token_checks=true (default unchanged). Token burn guard: refuses (400 token_burn, TokenBurnError) a transaction whose token inputs are not fully carried by valid token outputs (or an ALP BURN of exactly that amount), or that spends a mint baton other than in a MINT of its token; 400 token_inputs_pending when it spends outputs of SLP txs of unknown validity. A transaction without token inputs is never refused. API entry points only: consensus, mempool policy and P2P relay are unchanged. Override: skip_token_checks or allow_burn (body or query).","operationId":"broadcastTx","tags":["Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hex":{"type":"string","description":"Raw transaction (hex)"},"maxfeerate":{"type":"number"},"token_checks":{"type":"boolean","description":"txs/broadcast, txs/send: run the token burn guard (off by default there)"},"skip_token_checks":{"type":"boolean","description":"Do not run the guard"},"allow_burn":{"type":"array","items":{"type":"string"},"description":"Token ids whose burns are accepted"}}}}}},"responses":{"201":{"description":"Accepted tx","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTxResult"}}}},"400":{"description":"Refused (token_burn, token_inputs_pending) or rejected by the node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenBurnError"}}}}}}},"/api/v1/txs/broadcast-checked":{"post":{"summary":"Broadcast a raw transaction, token burn guard on","description":"As txs/broadcast, with the guard on by default. Token burn guard: refuses (400 token_burn, TokenBurnError) a transaction whose token inputs are not fully carried by valid token outputs (or an ALP BURN of exactly that amount), or that spends a mint baton other than in a MINT of its token; 400 token_inputs_pending when it spends outputs of SLP txs of unknown validity. A transaction without token inputs is never refused. API entry points only: consensus, mempool policy and P2P relay are unchanged. Override: skip_token_checks or allow_burn (body or query).","operationId":"broadcastTxChecked","tags":["Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hex":{"type":"string","description":"Raw transaction (hex)"},"maxfeerate":{"type":"number"},"token_checks":{"type":"boolean","description":"txs/broadcast, txs/send: run the token burn guard (off by default there)"},"skip_token_checks":{"type":"boolean","description":"Do not run the guard"},"allow_burn":{"type":"array","items":{"type":"string"},"description":"Token ids whose burns are accepted"}}}}}},"responses":{"201":{"description":"Accepted tx","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTxResult"}}}},"400":{"description":"Refused (token_burn, token_inputs_pending) or rejected by the node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenBurnError"}}}}}}},"/api/v1/txs/token-check":{"post":{"summary":"Token verdict of a raw transaction (dry run)","description":"Never relays. Returns token_tx (TokenTx), the tokens of every input and output, would_burn (what the guard refuses, after allow_burn), inputs_pending and allowed.","operationId":"tokenCheckTx","tags":["Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hex":{"type":"string","description":"Raw transaction (hex)"},"maxfeerate":{"type":"number"},"token_checks":{"type":"boolean","description":"txs/broadcast, txs/send: run the token burn guard (off by default there)"},"skip_token_checks":{"type":"boolean","description":"Do not run the guard"},"allow_burn":{"type":"array","items":{"type":"string"},"description":"Token ids whose burns are accepted"}}}}}},"responses":{"200":{"description":"Token verdict","content":{"application/json":{"schema":{"type":"object","properties":{"txid":{"type":"string"},"token_tx":{"$ref":"#/components/schemas/TokenTx"},"would_burn":{"type":"array","items":{"$ref":"#/components/schemas/TokenBurn"}},"inputs_pending":{"type":"boolean"},"allowed":{"type":"boolean"},"input_tokens":{"type":"array","items":{"$ref":"#/components/schemas/TokenData"}},"output_tokens":{"type":"array","items":{"$ref":"#/components/schemas/TokenData"}}}}}}}}}},"/api/v1/txs/broadcast-batch":{"post":{"summary":"Broadcast up to 1000 raw transactions","description":"The sendrawtransactions RPC: decoding and script checks in parallel (batch Schnorr), then one mempool pass in the order given (parents first). atomic=false (default): one result per transaction. atomic=true: all or nothing, 400 batch_rejected with the results if any is refused. Limits: 1000 transactions, 8,000,000 bytes. Rate limited node-wide: -restbatchbroadcastrate batches (default 30) and -restbatchbroadcasttxs transactions (default 10000) per minute, 429 rate_limited beyond, 403 disabled when the rate is 0. No token burn guard. Public proxies keep this route closed unless opened on purpose.","operationId":"broadcastTxBatch","tags":["Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"txs":{"type":"array","items":{"type":"string"},"description":"Raw transactions (hex), parents first"},"atomic":{"type":"boolean","description":"All or nothing"},"maxfeerate":{"type":"number"}}}}}},"responses":{"200":{"description":"Per-transaction results","content":{"application/json":{"schema":{"type":"object","properties":{"atomic":{"type":"boolean"},"committed":{"type":"boolean"},"accepted":{"type":"integer"},"rejected":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"txid":{"type":"string"},"accepted":{"type":"boolean"},"already_in_mempool":{"type":"boolean"},"fee":{"type":"number"},"code":{"type":"integer"},"error":{"type":"string"},"reject_reason":{"type":"string"}}}}}}}}},"400":{"description":"Malformed request, over the limits, or atomic batch refused (batch_rejected, with the results)","content":{"application/json":{"schema":{"type":"object","properties":{"atomic":{"type":"boolean"},"committed":{"type":"boolean"},"accepted":{"type":"integer"},"rejected":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"txid":{"type":"string"},"accepted":{"type":"boolean"},"already_in_mempool":{"type":"boolean"},"fee":{"type":"number"},"code":{"type":"integer"},"error":{"type":"string"},"reject_reason":{"type":"string"}}}}}}}}},"403":{"description":"Disabled (-restbatchbroadcastrate=0)","content":{"application/json":{"schema":{"type":"object","description":"Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","description":"Error"}}}}}}},"/api/v1/addresses":{"get":{"summary":"Rich list / wealth distribution","description":"Without query params, returns addresses ranked by balance (descending). Use ?sort=received to rank by total received. Use ?mode=wealth to get wealth distribution buckets instead of individual addresses — returns counts of addresses in ranges like 0-1 XPI, 1-10 XPI, etc.","operationId":"listAddresses","tags":["Addresses"],"parameters":[{"name":"limit","in":"query","description":"Max results (default 20, max 100)","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Skip N entries for pagination","required":false,"schema":{"type":"integer"}},{"name":"sort","in":"query","description":"Sort order: 'balance' (default) or 'received'","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"Set to 'wealth' to return wealth distribution buckets instead of individual addresses","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Address list or wealth distribution","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAddresses"}}}}}}},"/api/v1/addresses/{address}":{"get":{"summary":"Get address summary","operationId":"getAddress","tags":["Addresses"],"parameters":[{"name":"address","in":"path","description":"Lotus address","required":true,"schema":{"type":"string"}},{"name":"include_unconfirmed","in":"query","description":"1 to also list rows of unconfirmed (mempool) transactions, marked confirmed: false and block_height -1. Off by default: the lists keep their content. Aliases: unconfirmed, mempool. Answers with it are never served from the response cache.","required":false,"schema":{"type":"boolean"}}],"description":"Confirmed totals (balance_sats, ...) and, since 12.4.12, the unconfirmed part from the mempool overlay (unconfirmed_delta_sats, pending_incoming_sats, ...). An address with only unconfirmed activity is 404 as before, or 200 with zero confirmed totals with include_unconfirmed=1.","responses":{"200":{"description":"Address info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressSummary"}}}}}}},"/api/v1/addresses/{address}/txs":{"get":{"summary":"Get address transaction history","description":"Rows carry confirmed (bool). With include_unconfirmed=1 the unconfirmed rows come first (newest first, block_height -1, time_first_seen), then the confirmed ones; limit, offset and pagination.total apply to the combined list. unconfirmed_tx_count is always given.","operationId":"getAddressTxs","tags":["Addresses"],"parameters":[{"name":"address","in":"path","description":"Lotus address","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max results","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset (deprecated: use /history cursors)","required":false,"schema":{"type":"integer"},"deprecated":true},{"name":"include_unconfirmed","in":"query","description":"1 to also list rows of unconfirmed (mempool) transactions, marked confirmed: false and block_height -1. Off by default: the lists keep their content. Aliases: unconfirmed, mempool. Answers with it are never served from the response cache.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Tx history","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedTxHistory"}}}}}}},"/api/v1/addresses/{address}/utxos":{"get":{"summary":"Get address unspent outputs","operationId":"getAddressUtxos","tags":["Addresses"],"parameters":[{"name":"address","in":"path","description":"Lotus address","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max results","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset","required":false,"schema":{"type":"integer"}},{"name":"include_mempool","in":"query","description":"1 to keep outputs spent in the mempool (marked spent_in_mempool, pending_spend_txid); default hides them","required":false,"schema":{"type":"boolean"}},{"name":"include_unconfirmed","in":"query","description":"1 to also list rows of unconfirmed (mempool) transactions, marked confirmed: false and block_height -1. Off by default: the lists keep their content. Aliases: unconfirmed, mempool. Answers with it are never served from the response cache.","required":false,"schema":{"type":"boolean"}}],"description":"Rows carry confirmed (bool) and token data (token) when the output carries an SLP or ALP token. With include_unconfirmed=1 the unspent outputs of mempool transactions are merged in (sorted by value like the others). unconfirmed_utxo_count is always given.","responses":{"200":{"description":"UTXOs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedUtxos"}}}}}}},"/api/v1/utxos/{txid}/{vout}":{"get":{"summary":"Check specific UTXO","description":"spent and spent_txid of one output (the spender is read from the spending transaction's inputs). During a node's first sync, until the spent-by index is built, answers 503 explorer_indexing.","operationId":"getUtxo","tags":["UTXOs"],"parameters":[{"name":"txid","in":"path","description":"Transaction ID","required":true,"schema":{"type":"string"}},{"name":"vout","in":"path","description":"Output index","required":true,"schema":{"type":"integer"}},{"name":"include_unconfirmed","in":"query","description":"1 to also list rows of unconfirmed (mempool) transactions, marked confirmed: false and block_height -1. Off by default: the lists keep their content. Aliases: unconfirmed, mempool. Answers with it are never served from the response cache.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"UTXO details (since 12.4.12 also confirmed, token; pending_spend / pending_spend_txid when a mempool tx spends it; an output of a mempool tx with include_unconfirmed=1)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtxoDetail"}}}}}}},"/api/v1/addresses/{address}/history":{"get":{"summary":"Address history with full transactions","description":"Newest first by (block_height DESC, txid DESC). Pass the opaque `next_cursor` of a page as `before` for the next (older) page, or `prev_cursor` as `after` for the rows newer than a page. Blocks that arrive while paging never shift a `before` page. `total` is the maintained tx_count of the address (no COUNT). Each row carries inputs (spent output value and address), outputs (value, script, address, spender), fee and the net amount for this address. Confirmed rows only.","operationId":"getAddressHistory","tags":["Addresses"],"parameters":[{"name":"address","in":"path","description":"Lotus address","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Rows per page (default 25; max 50, 200 with details=none)","required":false,"schema":{"type":"integer"}},{"name":"before","in":"query","description":"Cursor: rows older than this one","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","description":"Cursor: rows newer than this one","required":false,"schema":{"type":"string"}},{"name":"details","in":"query","description":"full (default): transaction rows; none: txid, height and net amount only","required":false,"schema":{"type":"string"}},{"name":"max_io","in":"query","description":"Inputs and outputs listed per transaction (default 50, max 1000; counts and sums cover all)","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset from the newest row, without cursors (deprecated)","required":false,"schema":{"type":"integer"},"deprecated":true}],"responses":{"200":{"description":"One page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressHistoryPage"}}}},"400":{"description":"Invalid cursor or parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/utxos/status":{"post":{"summary":"Status of up to 500 outpoints","description":"unspent / spent (with the spending txid, input and height) / unknown, in request order, from two set-based statements. Confirmed unspent outputs also carry pending_spend / pending_spend_txid from the mempool. During a first sync, until the spent-by index is built, answers 503 explorer_indexing.","operationId":"utxoStatusBatch","tags":["UTXOs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"outpoints":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"txid":{"type":"string"},"vout":{"type":"integer"}}},{"type":"string","description":"\"<txid>:<vout>\""}]},"maxItems":500}}}}}}}},"/api/v1/txs/batch":{"post":{"summary":"Full rows of up to 100 transactions","description":"Confirmed rows (as in /addresses/{address}/history) with found: true, in request order; others are {txid, found: false, in_mempool}. `max_io` (body or query, default 50) bounds the inputs and outputs listed per transaction.","operationId":"txBatch","tags":["Transactions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"txids":{"type":"array","items":{"type":"string"},"maxItems":100},"max_io":{"type":"integer"}}}}}}}},"/api/v1/addresses/batch/balance":{"post":{"summary":"Balances of up to 100 addresses","description":"One statement. Unknown addresses: found false, zeroes.","operationId":"batchAddressBalance","tags":["Address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"string"},"maxItems":100}}}}}}}},"/api/v1/addresses/batch/history-summary":{"post":{"summary":"History summary of up to 100 addresses","description":"tx_count, first and last height, and the newest `limit` rows (default 5, max 25) of each address, with the cursor to continue on /addresses/{address}/history.","operationId":"batchAddressHistorySummary","tags":["Address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"string"},"maxItems":100},"limit":{"type":"integer"}}}}}}}},"/api/v1/network":{"get":{"summary":"Get network status and connection counts","description":"Returns protocol version, user agent, inbound/outbound connection counts, and whether the network is active.","operationId":"getNetworkInfo","tags":["Network"],"responses":{"200":{"description":"Network info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkInfo"}}}}}}},"/api/v1/network/peers":{"get":{"summary":"List all connected peers with stats","description":"Returns per-peer details: address, user agent, direction (inbound/outbound), starting height, best height estimate (height, -1 = unknown) and its height_source (announced, sent, common, version, unknown), ping latency, bytes sent/received and traffic rates measured by the node over the last minute (recv_bps, send_bps, rate_window_s, rate_windowed, sampled_unix_ms), the transport (tcp or websocket, with tls for a wss:// peer) and the zstd compression state and savings.","operationId":"getPeers","tags":["Network"],"responses":{"200":{"description":"Peer list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeerArray"}}}}}}},"/api/v1/node":{"get":{"summary":"Get node software version and uptime","description":"Returns software version, protocol version, uptime in seconds, IBD status, current chain height, and the bounds and counters of the REST response cache (response_cache). No local path.","operationId":"getNodeInfo","tags":["Node"],"responses":{"200":{"description":"Node info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeInfo"}}}}}}},"/api/v1/mining":{"get":{"summary":"Get current mining difficulty and chain info","description":"Returns the current difficulty, target bits, chain name, and tip height. Useful for miners and pool operators.","operationId":"getMiningInfo","tags":["Mining"],"responses":{"200":{"description":"Mining info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningInfo"}}}}}}},"/api/v1/mining/status":{"get":{"summary":"Stratum server status","description":"Whether this node's Stratum server runs, its listener ports and algorithms, routing tier, payout address, pool hashrate (from the difficulty of accepted shares), shares and blocks found, and the network difficulty and hashrate. mmv2 {active, activation_time}: merged mining in force for the next block. Definitions of every figure: doc/mining-figures.md.","operationId":"getMiningStatus","tags":["Mining"],"responses":{"200":{"description":"Success"}}}},"/api/v1/mining/workers":{"get":{"summary":"Connected miners grouped by payout address","description":"One row per payout address and algorithm: number of connected workers, hashrate, shares accepted/rejected/stale, current share difficulty and last share time. No worker names or IP addresses.","operationId":"getMiningWorkers","tags":["Mining"],"parameters":[{"name":"sort","in":"query","required":false,"description":"hashrate (default), address or shares","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1-500 (default 100)","schema":{"type":"integer"}},{"name":"offset","in":"query","required":false,"description":"default 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success"}}}},"/api/v1/mining/blocks":{"get":{"summary":"Blocks found by this node's Stratum server","description":"The last 200 blocks submitted since the node started, newest first: height, hash, accepted/confirmed/orphaned/rejected with the reason, coinbase value and the payout address of the worker that found it.","operationId":"getMiningBlocks","tags":["Mining"],"parameters":[{"name":"limit","in":"query","required":false,"description":"1-100 (default 25)","schema":{"type":"integer"}},{"name":"offset","in":"query","required":false,"description":"default 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success"}}}},"/api/v1/mining/shares":{"get":{"summary":"Share and hashrate history","description":"Buckets of accepted, rejected and stale shares and credited work per algorithm (in memory, last 24 hours). Columns: bucket_unix_s, accepted, rejected, stale, work, hashrate, hashrate_lotus_equivalent.","operationId":"getMiningShares","tags":["Mining"],"parameters":[{"name":"hours","in":"query","required":false,"description":"1-24 (default 24)","schema":{"type":"integer"}},{"name":"bucket","in":"query","required":false,"description":"60, 300, 900, 1800 (default) or 3600 seconds","schema":{"type":"integer"}},{"name":"algo","in":"query","required":false,"description":"lotushash or scrypt-auxpow (default: all)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}}}},"/api/v1/mining/hashrate/series":{"get":{"summary":"Per-algorithm and merged hashrate history","description":"Read from SQLite only (doc/mining-sqlite.md). scope=pool: the fleet's verified shares (pool.sqlite pool_algo_hashrate, one sample per minute, per hour after 7 days); scope=node: this node's stratum, native, legacy Scrypt and ASIC listeners (mining.sqlite); scope=network: the chain's blocks over 120-block windows (explorer database chain_stats_snapshots). Body: scope, from_unix_s, to_unix_s, bucket_seconds, algorithms [lotushash, scrypt-auxpow, sha256d-auxpow], source, points [{t_unix_s, hashrate_merged_lotus_equivalent, by_algo: {<algo>: {hashrate_lotus_equivalent, hashrate, multiplier {num, den} or null, shares (pool, node) or blocks (network)}}}]. hashrate is in the algorithm's own hashes (= Lotus-equivalent x M); merged = lotushash + scrypt / M + sha256d / M. 503 when the scope's database is not open (POOL module off, -miningdb=0).","operationId":"getMiningHashrateSeries","tags":["Mining"],"parameters":[{"name":"scope","in":"query","required":false,"description":"pool (default), node or network","schema":{"type":"string"}},{"name":"range","in":"query","required":false,"description":"Seconds back, 3600-34560000 (default 86400)","schema":{"type":"integer"}},{"name":"bucket","in":"query","required":false,"description":"Seconds per point, a multiple of 60, raised to at most 500 points (default 60; network 300)","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success"}}}},"/api/v1/stats/cards":{"get":{"summary":"Live aggregate stats for dashboard cards","description":"Returns current tip height, difficulty, estimated hashrate, mempool size, total circulating supply, and burned sats. Data is computed live from the chain state and SQLite indexes.","operationId":"getStatsCards","tags":["Stats"],"responses":{"200":{"description":"Stats cards","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsCards"}}}}}}},"/api/v1/stats/charts":{"get":{"summary":"Historical time-series data for charts","description":"Returns an array of snapshots taken every 5 minutes, with hashrate, difficulty, mempool size, supply, and burned supply. On first start, historical data is backfilled from the block index (one sample per hour). Use the 'period' parameter to control the time window.","operationId":"getStatsCharts","tags":["Stats"],"parameters":[{"name":"period","in":"query","description":"Time window: day (default, 288 points), week, month, quarter, year, or 7d/30d/90d/365d aliases","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Chart series","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsChartSeries"}}}}}}},"/api/v1/overview":{"get":{"summary":"Combined overview of chain, mining, mempool, and network","description":"Single endpoint that aggregates chain info, latest block summary, mining stats, mempool status, and network peer counts. Useful for dashboard landing pages to avoid multiple round-trips.","operationId":"getOverview","tags":["Overview"],"responses":{"200":{"description":"Overview","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Overview"}}}}}}},"/api/v1/mempool/history":{"get":{"summary":"Mempool size history over time","description":"Returns time-series snapshots of mempool tx count and total bytes. Snapshots are recorded every 5 minutes by the stats collector. Useful for mempool congestion charts.","operationId":"getMempoolHistory","tags":["Mempool"],"parameters":[{"name":"period","in":"query","description":"Time window: day (default), week, month, quarter, year","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Mempool history","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MempoolHistorySeries"}}}}}}},"/api/v1/network/nodes":{"get":{"summary":"Get connected peer addresses as addnode/onetry strings","description":"Returns the currently connected peers formatted as 'addnode=' and 'onetry=' strings, ready to be used in lotus.conf or CLI. Useful for bootstrapping new nodes. Each node carries its service flags (services, services_names, is_pool: NODE_POOL, a swarm pool node; an unauthenticated hint).","operationId":"getNetworkNodes","tags":["Network"],"parameters":[{"name":"pool","in":"query","description":"1: only peers advertising NODE_POOL","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Node strings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkNodes"}}}}}}},"/api/v1/events":{"get":{"summary":"Poll chain events (long-poll style)","description":"Long-poll endpoint for real-time chain events. Returns new blocks, transactions, and other events since the given sequence number. The client should poll with the last received seq to get incremental updates. Times out after ~30s if no events.","operationId":"getEvents","tags":["Events"],"parameters":[{"name":"since_seq","in":"query","description":"Return events after this sequence number","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Max events to return (default 50)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventList"}}}}}}},"/api/v1/push/info":{"get":{"summary":"Push notification service: counters, limits","description":"Push notifications are served over WebSocket at /api/v1/ws (subprotocol lotus-push.v1, JSON messages; not an HTTP route: the browser miner port and -wslisten serve it) and over NNG (PushPollRequest, pub topics pushevent / pushblock). Subscriptions: address or script, txid, token id, LOKAD id, blocks, module topics. Events: tx_added_to_mempool, tx_removed_from_mempool (reason), tx_confirmed, tx_unconfirmed, block_connected, block_disconnected, resync. This route reports whether the service runs, its listeners, counters and limits.","operationId":"getPushInfo","tags":["Events"],"responses":{"200":{"description":"Push notification service state"}}}},"/api/v1/addresses/batch/summary":{"post":{"summary":"Batch address summaries","description":"Returns the singleton /addresses/<addr> payload for up to 100 addresses in a single request. Unknown addresses are returned as zeroed records (never 404).","operationId":"batchAddressSummary","tags":["Address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"string"},"maxItems":100}},"required":["addresses"]}}}},"responses":{"200":{"description":"Per-address payloads keyed by address","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AddressSummary"}}}}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/addresses/batch/utxos":{"post":{"summary":"Batch address UTXOs","description":"Returns the singleton /addresses/<addr>/utxos array for up to 100 addresses. The per-address limit (default 50, max 500) is taken from the `limit` query parameter.","operationId":"batchAddressUtxos","tags":["Address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"string"},"maxItems":100}},"required":["addresses"]}}}},"responses":{"200":{"description":"Per-address payloads keyed by address","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AddressUtxo"}}}}}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/addresses/batch/txs":{"post":{"summary":"Batch address transactions","description":"Returns the singleton /addresses/<addr>/txs array for up to 100 addresses. Per-address `limit` (default 25, max 200) and `offset` may be supplied either via query string or via the JSON body.","operationId":"batchAddressTxs","tags":["Address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"string"},"maxItems":100},"limit":{"type":"integer"},"offset":{"type":"integer"}},"required":["addresses"]}}}},"responses":{"200":{"description":"Per-address payloads keyed by address","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AddressTx"}}}}}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/social/activity":{"get":{"summary":"Recent RANK votes across all profiles","description":"Returns the latest RANK votes in reverse-chronological order. Used to power the global activity feed.","operationId":"getSocialActivity","tags":["Social"],"parameters":[{"name":"page","in":"query","description":"1-indexed page number","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Items per page (max 100)","required":false,"schema":{"type":"integer"}},{"name":"platform","in":"query","description":"Optional platform filter (twitter, telegram, localbusiness, …). Mutually exclusive with excludePlatform.","required":false,"schema":{"type":"string"}},{"name":"excludePlatform","in":"query","description":"Optional platform to exclude. Useful for filtering out a noisy seeding feed (e.g. localbusiness) while keeping every other source.","required":false,"schema":{"type":"string"}},{"name":"before","in":"query","description":"Keyset cursor of the form `blockHeight:vout`. Returns rows strictly older than the cursor. Strongly preferred over `page` past ~2000 pages: OFFSET pagination becomes O(n) on millions of rows and will time out. Use the `nextCursor` field from the previous response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recent RANK votes across all profiles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialActivityPage"}}}}}}},"/api/v1/social/profiles":{"get":{"summary":"Ranked RANK profiles list","description":"Returns RANK profiles sorted by ranking DESC. Supports both legacy page/pageSize and modern after-cursor pagination; the cursor form scales to arbitrary depth without OFFSET cost.","operationId":"getSocialProfiles","tags":["Social"],"parameters":[{"name":"page","in":"query","description":"1-indexed page number","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Items per page (max 200)","required":false,"schema":{"type":"integer"}},{"name":"platform","in":"query","description":"Optional platform filter (twitter, telegram, localbusiness, …).","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","description":"Keyset cursor of the form `ranking:profileId`. Returns profiles strictly below the cursor in leaderboard order. Use the `nextCursor` field from the previous response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ranked RANK profiles list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialProfilesPage"}}}}}}},"/api/v1/social/search":{"get":{"summary":"Search RANK profiles by handle","description":"Substring search over rank_profiles.profile_id, optionally narrowed to one platform. Results sorted by ranking DESC.","operationId":"searchSocialProfiles","tags":["Social"],"parameters":[{"name":"q","in":"query","description":"Substring to match on profile_id (1-64 chars; LIKE wildcards are escaped server-side)","required":true,"schema":{"type":"string"}},{"name":"platform","in":"query","description":"Optional platform name (twitter, telegram, ...)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max profiles returned (1-100, default 25)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Search RANK profiles by handle","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialSearchResult"}}}}}}},"/api/v1/social/{platform}/{profileId}":{"get":{"summary":"RANK profile detail","description":"Returns the cumulative ranking and vote counts for the given profile, or zeroed counters if it has never been voted on.","operationId":"getSocialProfile","tags":["Social"],"parameters":[{"name":"platform","in":"path","description":"Platform name (twitter, telegram, ...)","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Platform-specific profile identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"RANK profile detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialProfile"}}}}}}},"/api/v1/social/{platform}/{profileId}/posts":{"get":{"summary":"Posts ranked under a profile","description":"Posts attributed to this profile, sorted by ranking DESC.","operationId":"getSocialProfilePosts","tags":["Social"],"parameters":[{"name":"platform","in":"path","description":"Platform name (twitter, telegram, ...)","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Platform-specific profile identifier","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-indexed page number","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Items per page (max 100)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Posts ranked under a profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialProfilePostsPage"}}}}}}},"/api/v1/social/{platform}/{profileId}/votes":{"get":{"summary":"Votes received by a profile","description":"Individual RANK votes received by the profile, in reverse-block order.","operationId":"getSocialProfileVotes","tags":["Social"],"parameters":[{"name":"platform","in":"path","description":"Platform name (twitter, telegram, ...)","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Platform-specific profile identifier","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-indexed page number","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Items per page (max 100)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Votes received by a profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialProfileVotesPage"}}}}}}},"/api/v1/social/{platform}/{profileId}/post/{postId}":{"get":{"summary":"RANK post detail with vote feed","description":"Returns the post summary plus a paginated list of votes addressed to this specific post.","operationId":"getSocialPost","tags":["Social"],"parameters":[{"name":"platform","in":"path","description":"Platform name","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile identifier","required":true,"schema":{"type":"string"}},{"name":"postId","in":"path","description":"Platform-specific post identifier","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"1-indexed page number","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Items per page (max 100)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"RANK post detail with vote feed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialPostDetail"}}}}}}},"/api/v1/social/stats/{type}/{direction}":{"get":{"summary":"Top / bottom ranked profiles or posts","description":"Returns up to 10 profiles or posts sorted by ranking, in either direction. Used by the trending widgets.","operationId":"getSocialStats","tags":["Social"],"parameters":[{"name":"type","in":"path","description":"'profiles' or 'posts'","required":true,"schema":{"type":"string"}},{"name":"direction","in":"path","description":"'top' or 'bottom'","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Top / bottom ranked profiles or posts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialStatsList"}}}}}}},"/api/v1/health":{"get":{"summary":"Lightweight liveness probe","description":"Cheap liveness check intended for browsers and light wallets. Always returns 200 once the chain is loaded; the `ibd` flag indicates whether the node is still doing initial block download. Returns 503 only when no tip is available yet. While the explorer database is not ready (a first sync and the work after it), an explorer_indexing object is added: state, phase, indexes_built of indexes_total, and the after-sync steps: step of steps_total, current_step and its label, step_done of step_total (slices of mark_spent, MiB of the final write), step_elapsed_s, step_eta_s and eta_s (estimates, -1 unknown), spent (deferred, marking, ready) and steps[] (name, kind, state, done, total, elapsed_s, eta_s, unlocks: what comes back when the step is done). Absent on a ready node.","operationId":"getHealth","tags":["Node"],"responses":{"200":{"description":"Health snapshot","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthInfo"}}}},"503":{"description":"Chain not yet loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/docs":{"get":{"summary":"List the embedded documentation pages","description":"The documentation compiled into the binary (guides, reference and protocol documents): released, sections[] with id and title, docs[] in reading order with name, title, size, sha256, url, nav, section, order, since, summary, source and path of each page, and count.","operationId":"listDocs","tags":["Docs"],"responses":{"200":{"description":"Document index","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/api/v1/docs/{name}":{"get":{"summary":"One embedded documentation page (Markdown)","description":"text/markdown; charset=utf-8, with an ETag (its sha256; 304 on If-None-Match). `name` comes from /api/v1/docs, optionally with .md; `index` is the home page. Unknown names answer 404.","operationId":"getDoc","tags":["Docs"],"parameters":[{"name":"name","in":"path","description":"Document name, e.g. empp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The Markdown document","content":{"text/markdown":{"schema":{"type":"string"}}}},"404":{"description":"Unknown document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/stratum":{"get":{"summary":"Stratum server statistics (workers, shares)","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_stratum","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"Stratum server statistics (workers, shares)"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/stratum/workers":{"get":{"summary":"Stratum workers with their names","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_stratum_workers","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"Stratum workers with their names"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/stratum/history/{view}":{"get":{"summary":"mining.sqlite operator rows (workers, sessions, shares, ...)","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_stratum_history_view","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"parameters":[{"name":"view","in":"path","description":"Operator view name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"mining.sqlite operator rows (workers, sessions, shares, ...)"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/sharechain":{"get":{"summary":"Share-chain state","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_sharechain","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"Share-chain state"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/scryptchains":{"get":{"summary":"Litecoin / Dogecoin header chains","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_scryptchains","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"Litecoin / Dogecoin header chains"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/summary":{"get":{"summary":"Stratum pool mode, fee and payout address","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_summary","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"Stratum pool mode, fee and payout address"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/workers":{"get":{"summary":"POOL module: workers (names)","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_workers","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: workers (names)"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/sessions":{"get":{"summary":"POOL module: stratum sessions","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_sessions","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: stratum sessions"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/vardiff":{"get":{"summary":"POOL module: vardiff changes","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_vardiff","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: vardiff changes"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/rejects":{"get":{"summary":"POOL module: rejected shares","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_rejects","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: rejected shares"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/gossip":{"get":{"summary":"POOL module: share-ledger gossip events","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_gossip","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: share-ledger gossip events"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/stratum-blocks":{"get":{"summary":"POOL module: blocks found by stratum","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_stratum_blocks","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: blocks found by stratum"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/shares":{"get":{"summary":"POOL module: shares with worker names","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_shares","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: shares with worker names"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/peers":{"get":{"summary":"POOL module: gossip peers","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_peers","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: gossip peers"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/info":{"get":{"summary":"POOL module: configuration and state","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_info","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: configuration and state"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/ledger":{"get":{"summary":"POOL module: PPLNS ledger","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_ledger","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: PPLNS ledger"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool/relays":{"get":{"summary":"POOL module: thin share relays (source addresses, workers)","description":"Operator route: requires HTTP basic auth with the node's JSON-RPC credentials (rpcuser/rpcpassword, rpcauth or the .cookie file). Not reachable over the NNG tunnel.","operationId":"operator_pool_relays","tags":["Operator"],"security":[{"rpcBasicAuth":[]}],"responses":{"200":{"description":"POOL module: thin share relays (source addresses, workers)"},"401":{"description":"Missing or wrong credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"RPC user restricted by -rpcwhitelist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/summary":{"get":{"summary":"Pool summary","description":"Pool hashrate (10 min), miners, blocks found, luck over the last 10/50/200 blocks, fee, burn, float of pending balances, live round values of this node, and the connection details of the \"How to mine with us\" panel (public stratum URLs, ports and algos, never a bind address). 12.4.12: burnt_addressless_24h_sats and burnt_addressless_total_sats (the PPLNS part of ASIC work without a Lotus address, burnt by the pool blocks), addressless_miners (machines seen in the last hour without an address, a count) and blocks_24h_by_algo (lotushash, sha256d-auxpow, scrypt-auxpow).","operationId":"getPoolSummary","tags":["Pool"],"responses":{"200":{"description":"Pool summary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolSummary"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/miners":{"get":{"summary":"Miners by payout address","description":"Every payout address with shares in the last hour or a balance: hashrate, shares, percent of the work, owed, credited and paid. No worker name, IP or session. 12.4.12: by_algo {lotushash, sha256d-auxpow, scrypt-auxpow} {weight, shares, hashrate_lotus_equivalent, machines (distinct machines, a count; null for lotushash)} over the last hour, and addressless (ASIC work without a Lotus address: its part is burnt).","operationId":"getPoolMiners","tags":["Pool"],"parameters":[{"name":"limit","in":"query","description":"Rows, 1-500 (default 50)","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Rows skipped (default 0)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Miners by payout address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolMinersPage"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/miner/{address}":{"get":{"summary":"One payout address","description":"Balance, payouts, recent shares (difficulty, height, fleet node), ledger changes and 24 h hashrate samples of one payout address.","operationId":"getPoolMiner","tags":["Pool"],"parameters":[{"name":"address","in":"path","description":"Lotus payout address","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Rows per list, 1-500","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"One payout address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolMiner"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/relays":{"get":{"summary":"Thin share relays","description":"Thin share relays (doc/thin-share-relay.md) that forwarded shares to this node's pool bridge: relay label, active (a batch in the last 10 minutes), accepted / rejected / block shares, refusal reasons and the payout addresses mined through it. Never the relay's network address or worker names. Relays are not pool members.","operationId":"getPoolRelays","tags":["Pool"],"responses":{"200":{"description":"Thin share relays","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolRelays"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/next":{"get":{"summary":"Next block payout split","description":"The coinbase outputs this node would pay if it found the next block: payees (vout, address, amount, entitlement), miner fund and burn, and the POOL record hex.","operationId":"getPoolNext","tags":["Pool"],"responses":{"200":{"description":"Next block payout split","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolNext"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/blocks":{"get":{"summary":"Pool blocks","description":"Blocks carrying a POOL record (ours and other pools'), newest first: effort, status (immature, mature, orphaned), payee count, burn.","operationId":"getPoolBlocks","tags":["Pool"],"parameters":[{"name":"limit","in":"query","description":"Rows, 1-500 (default 50)","required":false,"schema":{"type":"integer"}},{"name":"before","in":"query","description":"Only blocks below this height","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Pool blocks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolBlocksPage"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/block/{hash}":{"get":{"summary":"One pool block","description":"A pool block with every payout output (vout, address, amount, entitlement, share and hashrate codes) and its decoded POOL record, which carries the coinbase txid.","operationId":"getPoolBlock","tags":["Pool"],"parameters":[{"name":"hash","in":"path","description":"Block hash (64 hex)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"One pool block","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolBlock"}}}},"400":{"description":"Malformed hash","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Unknown block","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/record/{hash}":{"get":{"summary":"Decode a block's POOL record","description":"Decodes the POOL record of any block on disk (same output as the decodepoolrecord RPC). found is false without a record; error names a malformed one.","operationId":"decodePoolRecord","tags":["Pool"],"parameters":[{"name":"hash","in":"path","description":"Block hash (64 hex)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Decode a block's POOL record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolRecord"}}}},"400":{"description":"Malformed hash","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Unknown block","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/balances":{"get":{"summary":"Pending balances","description":"Balances below the payout threshold, owed by future pool blocks (not held in a wallet).","operationId":"getPoolBalances","tags":["Pool"],"parameters":[{"name":"limit","in":"query","description":"Rows, 1-500 (default 50)","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Rows skipped (default 0)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Pending balances","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolBalances"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/hashrate":{"get":{"summary":"Hashrate samples","description":"One sample per minute: [time_ms, hashrate H/s, shares].","operationId":"getPoolHashrate","tags":["Pool"],"parameters":[{"name":"address","in":"query","description":"Payout address; empty for the whole pool","required":false,"schema":{"type":"string"}},{"name":"range","in":"query","description":"Seconds back, 60-2592000 (default 86400)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Hashrate samples","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolHashrate"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/pool-public/history":{"get":{"summary":"Pool blocks over time","description":"Our pool blocks per time bucket (block time): [start, blocks, orphaned, reward sats, average effort or null].","operationId":"getPoolHistory","tags":["Pool"],"parameters":[{"name":"range","in":"query","description":"Seconds back, 3600-7776000 (default 604800)","required":false,"schema":{"type":"integer"}},{"name":"bucket","in":"query","description":"Bucket seconds; raised so that there are at most 500 buckets (default 3600)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Pool blocks over time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolHistory"}}}},"503":{"description":"POOL module not loaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/mining/aux/status":{"get":{"summary":"Mining status of this node","description":"Algorithms offered by this node's Stratum server, the ASIC merged-mining rule state on this network, difficulty factors, eligibility, aggregate hashrate (native and Lotus-equivalent, H/s), share counters, expected and found blocks. Public data only: no worker names, addresses, IPs or pool endpoints. Answers 200 with enabled=false when mining is off. Present only when the mining module is loaded (see /api/v1/modules).","operationId":"getMiningAuxStatus","tags":["Mining"],"responses":{"200":{"description":"Mining status of this node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningStatus"}}}}}}},"/api/v1/mining/upstreams":{"get":{"summary":"Parent work sources (pools, parent nodes, embedded nodes, none)","description":"One entry per parent work source: kind, state, extranonce granted, Lotus anchor in use, share counters and pool reject reasons as codes. Pool host, port, account and error text are never returned. Present only when the mining module is loaded (see /api/v1/modules).","operationId":"getMiningUpstreams","tags":["Mining"],"responses":{"200":{"description":"Parent work sources (pools, parent nodes, embedded nodes, none)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningUpstreamList"}}}}}}},"/api/v1/mining/aux/workers":{"get":{"summary":"Miners, by anonymous label","description":"One row per miner, identified by a stable anonymous label (w- followed by 6 or 8 hex digits). Rows cover the last 7 days. Empty when per-worker publication is off (public=false; the default on mainnet). Present only when the mining module is loaded (see /api/v1/modules).","operationId":"getMiningAuxWorkers","tags":["Mining"],"parameters":[{"name":"algo","in":"query","description":"lotushash, scrypt-auxpow or sha256d-auxpow (short forms scrypt, sha256d accepted)","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"newest, algo (default) or state","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"1-500, default 100","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset, default 0","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Miners, by anonymous label","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningWorkerList"}}}},"400":{"description":"Bad parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/mining/aux/blocks":{"get":{"summary":"Blocks found by this node","description":"Lotus blocks, or parent-chain blocks, found by this node's miners, newest first, with a 24-hour summary. Present only when the mining module is loaded (see /api/v1/modules).","operationId":"getMiningAuxBlocks","tags":["Mining"],"parameters":[{"name":"chain","in":"query","description":"lotus (default) or parent","required":false,"schema":{"type":"string"}},{"name":"algo","in":"query","description":"lotushash, scrypt-auxpow or sha256d-auxpow (short forms scrypt, sha256d accepted)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"1-100, default 25","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset, default 0","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Blocks found by this node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningFoundBlockList"}}}},"400":{"description":"Bad parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/mining/aux/shares":{"get":{"summary":"Share and hashrate history per algorithm","description":"Accepted, rejected and stale shares, work (hashes) and hashrate per time bucket and algorithm. Buckets without shares are returned as zeros. Present only when the mining module is loaded (see /api/v1/modules).","operationId":"getMiningAuxShares","tags":["Mining"],"parameters":[{"name":"hours","in":"query","description":"1-720, default 24","required":false,"schema":{"type":"integer"}},{"name":"bucket","in":"query","description":"300, 1800, 10800 or 43200 seconds, default 300; at most 300 buckets","required":false,"schema":{"type":"integer"}},{"name":"algo","in":"query","description":"lotushash, scrypt-auxpow or sha256d-auxpow (short forms scrypt, sha256d accepted)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Share and hashrate history per algorithm","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningShareSeries"}}}},"400":{"description":"Bad parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/mining/network":{"get":{"summary":"Share of recent Lotus blocks per proof kind","description":"How the last N Lotus blocks were proven: LotusHash, Scrypt or SHA-256 parent proof, by metadata field ID. Available even when mining is off on this node. Present only when the mining module is loaded (see /api/v1/modules).","operationId":"getMiningNetwork","tags":["Mining"],"parameters":[{"name":"blocks","in":"query","description":"1-10080, default 720","required":false,"schema":{"type":"integer"}},{"name":"bucket","in":"query","description":"blocks per bucket, 0 = none, at most 300 buckets","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Share of recent Lotus blocks per proof kind","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningProofShare"}}}},"400":{"description":"Bad parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/mining/events":{"get":{"summary":"Upstream connection events (codes only)","description":"Connection events of parent work sources, as event and error codes. Present only when the mining module is loaded (see /api/v1/modules).","operationId":"getMiningEvents","tags":["Mining"],"parameters":[{"name":"algo","in":"query","description":"lotushash, scrypt-auxpow or sha256d-auxpow (short forms scrypt, sha256d accepted)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"1-100, default 25","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset, default 0","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Upstream connection events (codes only)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningEventList"}}}},"400":{"description":"Bad parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/v1/mining/proofs/{hash}":{"get":{"summary":"Parent proof of a Lotus block","description":"Decoded parent proof of any merged-mined block of the active chain (hash, or a height): as recorded by this node when the block was connected, else decoded from the block file (recorded: false; the anchor position is then unknown). 404 not_recorded for a native (LotusHash) block, not_found for an unknown block. Present only when the mining module is loaded (see /api/v1/modules).","operationId":"getMiningProof","tags":["Mining"],"parameters":[{"name":"hash","in":"path","description":"Block hash, 64 hex characters","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Parent proof of a Lotus block","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiningProof"}}}},"400":{"description":"Bad parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not recorded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"components":{"schemas":{"ApiError":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer"}}},"Pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"has_more":{"type":"boolean"}}},"BlockSummary":{"type":"object","properties":{"hash":{"type":"string"},"height":{"type":"integer"},"time":{"type":"integer"},"n_tx":{"type":"integer"},"size":{"type":"integer"},"difficulty":{"type":"number"},"confirmations":{"type":"integer","description":"Blocks on top of it in the active chain, itself included; -1 when the block is not in the active chain (Bitcoin Core getblock convention)."},"previous_hash":{"type":"string"},"in_active_chain":{"type":"boolean"},"status":{"type":"string","description":"active | stale (reorged out, or a competing block) | invalid | parked (this block or an ancestor on its branch)."},"next_hash":{"type":"string","description":"Next block in the active chain (active blocks only, absent at the tip)."},"replaced_by":{"type":"string","description":"Not in the active chain only: the active block at the same height (null when the active chain is shorter). Also fork_height / fork_hash (last block shared with the active chain) and have_data."},"fork_height":{"type":"integer"},"fork_hash":{"type":"string"},"have_data":{"type":"boolean"},"pow_algo":{"type":"string","description":"How the block was proven: lotushash, scrypt-auxpow or sha256d-auxpow"},"proof_field":{"type":"integer","description":"0 native, 1 Scrypt classic tag, 2 SHA-256d classic tag, 3 Scrypt positional anchor, 4 SHA-256d positional anchor"},"aux_parent_hash":{"type":["string","null"],"description":"Parent header hash (double SHA-256), null for native blocks"},"reward_sats":{"type":"integer","description":"Total output of the coinbase (subsidy plus claimed fees), from the explorer index; active-chain blocks only, absent until indexed"}}},"ChainInfo":{"type":"object","properties":{"chain":{"type":"string"},"height":{"type":"integer"},"best_block_hash":{"type":"string"},"difficulty":{"type":"number"},"median_time":{"type":"integer"},"chain_work":{"type":"string"},"initial_block_download":{"type":"boolean"},"headers":{"type":"integer"},"verification_progress":{"type":"number"},"replay_protection":{"type":"object","description":"First Chronicles replay protection for signers: activation_time (median time past), active (the next block is validated with replay protection: tip median_time >= activation_time) and fork_value, the sighash fork value a signature must be hashed with to be valid in the next block (0, or 16768685 = 0xffdead).","properties":{"activation_time":{"type":"integer"},"active":{"type":"boolean"},"fork_value":{"type":"integer"}}},"sync":{"type":"object","description":"Sync speed: blocks and transactions connected per second averaged over the last 10 s, 1 min and 10 min (null until that much history exists), blocks left to the best header, and the ETA in seconds (null when unknown)."}}},"TxSummary":{"type":"object","properties":{"txid":{"type":"string"},"block_height":{"type":"integer"},"block_pos":{"type":"integer"},"confirmations":{"type":"integer"},"input_count":{"type":"integer"},"output_count":{"type":"integer"},"input_value_sats":{"type":"integer"},"output_value_sats":{"type":"integer"},"fee_sats":{"type":"integer"},"in_active_chain":{"type":"boolean"},"orphaned":{"type":"boolean","description":"Present (true) for a transaction found only in a block that is not in the active chain, read from the block file: confirmations -1, block_hash, block_status, replaced_by, found_via (block_hint for ?block=<hash>, or txindex). Without -txindex such a transaction is only found with ?block=<hash>; the 404 says so in \"hint\"."}}},"AddressSummary":{"type":"object","properties":{"address":{"type":"string"},"balance_sats":{"type":"integer"},"received_sats":{"type":"integer"},"sent_sats":{"type":"integer"},"tx_count":{"type":"integer"},"utxo_count":{"type":"integer"},"first_height":{"type":"integer"},"last_height":{"type":"integer"},"confirmed_balance_sats":{"type":"integer","description":"Same as balance_sats (confirmed)"},"unconfirmed_delta_sats":{"type":"integer","description":"pending_incoming_sats - pending_outgoing_sats"},"pending_incoming_sats":{"type":"integer","description":"Sum of the mempool outputs paying the address"},"pending_outgoing_sats":{"type":"integer","description":"Sum of the address's coins spent by mempool transactions"},"balance_with_unconfirmed_sats":{"type":"integer","description":"balance_sats + unconfirmed_delta_sats"},"unconfirmed_tx_count":{"type":"integer"},"unconfirmed_utxo_count":{"type":"integer","description":"Mempool outputs paying the address not spent in the mempool"},"mempool_spent_utxo_count":{"type":"integer","description":"Confirmed coins of the address spent in the mempool"},"unconfirmed_available":{"type":"boolean","description":"False with -mempooloverlay=0"},"unconfirmed_complete":{"type":"boolean","description":"False while the overlay is past its memory bound (-mempooloverlaymaxmb)"}}},"StatsCards":{"type":"object","description":"Live aggregate stats for dashboard cards","properties":{"tip_height":{"type":"integer"},"difficulty":{"type":"number"},"hashrate":{"type":"number"},"mempool_count":{"type":"integer"},"mempool_bytes":{"type":"integer"},"total_supply_sats":{"type":"integer"},"burned_sats":{"type":"integer"},"tip_time":{"type":"integer","description":"Block time of the tip"},"avg_block_time":{"type":"number","description":"Mean seconds between blocks over the last 120 blocks (absent on a shorter chain)"},"blocks_24h":{"type":"integer","description":"Blocks with a block time in the last 24 hours (absent when the chain lock is busy)"},"tx_24h":{"type":"integer","description":"Transactions, coinbases excluded, in those blocks (explorer index)"}}},"StatsChartPoint":{"type":"object","description":"A single snapshot in a time-series chart","properties":{"ts":{"type":"integer"},"block_height":{"type":"integer"},"hashrate":{"type":"number"},"difficulty":{"type":"number"},"mempool_count":{"type":"integer"},"total_supply_sats":{"type":"integer"},"burned_supply_sats":{"type":"integer"}}},"StatsChartSeries":{"type":"object","description":"Time-series chart data with period label and array of snapshots ordered oldest-first. Snapshots are taken every 5 minutes; historical data is backfilled hourly from the block index.","properties":{"period":{"type":"string"},"series":{"type":"array","items":{"$ref":"#/components/schemas/StatsChartPoint"}}}},"Overview":{"type":"object","description":"Combined response with chain, mining, mempool, network, and latest block info. Avoids multiple round-trips for dashboard rendering.","properties":{"chain":{"$ref":"#/components/schemas/ChainInfo"},"latest_block":{"$ref":"#/components/schemas/BlockSummary"},"mining":{"type":"object"},"mempool":{"type":"object"},"network":{"type":"object"}}},"MempoolHistoryPoint":{"type":"object","description":"A single mempool snapshot","properties":{"ts":{"type":"integer"},"tx_count":{"type":"integer"},"total_bytes":{"type":"integer"}}},"MempoolHistorySeries":{"type":"object","description":"Time-series of mempool size snapshots, oldest-first. Useful for plotting mempool congestion over time.","properties":{"period":{"type":"string"},"series":{"type":"array","items":{"$ref":"#/components/schemas/MempoolHistoryPoint"}}}},"NetworkNodes":{"type":"object","description":"Connected peers as dialable addresses, one per ip:port, public first. Inbound peers are listed on the default P2P port (port_assumed). addnode/onetry are the same list as legacy strings.","properties":{"nodes":{"type":"array","items":{"type":"object","properties":{"addr":{"type":"string"},"scope":{"type":"string"},"network":{"type":"string"},"direction":{"type":"string"},"subver":{"type":"string"},"services":{"type":"string"},"port_assumed":{"type":"boolean"},"is_pool":{"type":"boolean"},"services_names":{"type":"array","items":{"type":"string"}}}}},"addnode":{"type":"array","items":{"type":"string"}},"onetry":{"type":"array","items":{"type":"string"}}}},"AddressUtxo":{"type":"object","properties":{"txid":{"type":"string"},"vout":{"type":"integer"},"value_sats":{"type":"integer"},"confirmed":{"type":"boolean"},"block_height":{"type":"integer","description":"-1, unconfirmed rows only"},"time_first_seen":{"type":"integer","description":"Unconfirmed rows only"},"spent_in_mempool":{"type":"boolean","description":"With include_mempool=1"},"pending_spend_txid":{"type":"string"},"token":{"$ref":"#/components/schemas/TokenData","description":"The token this output carries (SLP or ALP); absent when none"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/TokenData"},"description":"Only when an output carries more than one"}}},"TokenData":{"type":"object","properties":{"token_id":{"type":"string"},"protocol":{"type":"string","enum":["SLP","ALP"]},"token_type":{"type":"string","description":"type1, nft1-group, nft1-child, alp-standard, ..."},"token_type_num":{"type":"integer"},"amount":{"type":"string","description":"Atoms, decimal string (up to 2^64-1); \"0\" for a baton"},"is_mint_baton":{"type":"boolean"},"validity":{"type":"string","enum":["valid","pending","invalid"]},"provisional":{"type":"boolean","description":"Carried by an unconfirmed transaction: may change if it is replaced"}}},"TokenBurn":{"type":"object","properties":{"token_id":{"type":"string"},"protocol":{"type":"string"},"token_type":{"type":"string"},"amount":{"type":"string"},"burns_mint_batons":{"type":"boolean"},"intentional_amount":{"type":"string","description":"ALP BURN amount, if any"},"unintentional":{"type":"boolean"}}},"TokenTx":{"type":"object","properties":{"status":{"type":"string","enum":["non_token","normal","not_normal"]},"pending":{"type":"boolean"},"provisional":{"type":"boolean"},"entries":{"type":"array","items":{"type":"object","properties":{"token_id":{"type":"string"},"protocol":{"type":"string"},"token_type":{"type":"string"},"tx_type":{"type":"string"},"validity":{"type":"string"},"invalid_reason":{"type":"string"}}}},"burns":{"type":"array","items":{"$ref":"#/components/schemas/TokenBurn"}}}},"TokenBurnError":{"type":"object","properties":{"error":{"type":"string","description":"token_burn, token_inputs_pending (or the node's rejected)"},"message":{"type":"string"},"status":{"type":"integer"},"txid":{"type":"string"},"burns":{"type":"array","items":{"$ref":"#/components/schemas/TokenBurn"}},"token_tx":{"$ref":"#/components/schemas/TokenTx"},"override":{"type":"string"}}},"AddressTx":{"type":"object","properties":{"block_height":{"type":"integer"},"txid":{"type":"string"},"net_value":{"type":"integer"},"confirmed":{"type":"boolean"},"time_first_seen":{"type":"integer","description":"Unconfirmed rows only"}}},"ExplorerTxInput":{"type":"object","properties":{"vin":{"type":"integer"},"prev_txid":{"type":"string"},"prev_vout":{"type":"integer"},"value_sats":{"type":"integer"},"address":{"type":"string"}}},"ExplorerTxOutput":{"type":"object","properties":{"vout":{"type":"integer"},"value_sats":{"type":"integer"},"script_hex":{"type":"string"},"script_type":{"type":"string"},"address":{"type":"string"},"spent":{"type":"boolean"},"spent_txid":{"type":"string"},"spent_indexing":{"type":"boolean"}}},"ExplorerTx":{"type":"object","properties":{"txid":{"type":"string"},"block_height":{"type":"integer"},"block_pos":{"type":"integer"},"block_hash":{"type":"string"},"time":{"type":"integer"},"confirmations":{"type":"integer"},"coinbase":{"type":"boolean"},"input_count":{"type":"integer"},"output_count":{"type":"integer"},"input_value_sats":{"type":"integer"},"output_value_sats":{"type":"integer"},"fee_sats":{"type":"integer","nullable":true,"description":"null for a coinbase"},"net_sats":{"type":"integer","description":"received minus sent by the queried address (history)"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/ExplorerTxInput"}},"inputs_truncated":{"type":"boolean"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/ExplorerTxOutput"}},"outputs_truncated":{"type":"boolean"},"found":{"type":"boolean"},"in_mempool":{"type":"boolean"}}},"AddressHistoryPage":{"type":"object","properties":{"address":{"type":"string"},"order":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExplorerTx"}},"pagination":{"type":"object","properties":{"limit":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"},"has_newer":{"type":"boolean"},"next_cursor":{"type":"string"},"prev_cursor":{"type":"string"}}}}},"OutpointStatus":{"type":"object","properties":{"txid":{"type":"string"},"vout":{"type":"integer"},"status":{"type":"string","enum":["unspent","spent","unknown"]},"height":{"type":"integer"},"value_sats":{"type":"integer"},"script_type":{"type":"string"},"address":{"type":"string"},"spent_by":{"type":"object","properties":{"txid":{"type":"string"},"vin":{"type":"integer"},"height":{"type":"integer"}}},"pending_spend":{"type":"boolean"},"pending_spend_txid":{"type":"string"}}},"SocialVote":{"type":"object","properties":{"txid":{"type":"string"},"firstSeen":{"type":"integer"},"platform":{"type":"string"},"profileId":{"type":"string"},"sentiment":{"type":"string","enum":["positive","negative"]},"sats":{"type":"integer"},"postId":{"type":"string"}}},"SocialActivityPage":{"type":"object","properties":{"votes":{"type":"array","items":{"$ref":"#/components/schemas/SocialVote"}},"numPages":{"type":"integer"},"nextCursor":{"type":"string"}}},"SocialProfile":{"type":"object","properties":{"platform":{"type":"string"},"id":{"type":"string"},"ranking":{"type":"integer"},"votesPositive":{"type":"integer"},"votesNegative":{"type":"integer"}}},"SocialProfilesPage":{"type":"object","properties":{"profiles":{"type":"array","items":{"$ref":"#/components/schemas/SocialProfile"}},"numPages":{"type":"integer"},"nextCursor":{"type":"string"}}},"SocialSearchResult":{"type":"object","properties":{"query":{"type":"string"},"platform":{"type":"string"},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/SocialProfile"}},"numResults":{"type":"integer"}}},"SocialPost":{"type":"object","properties":{"id":{"type":"string"},"ranking":{"type":"integer"},"votesPositive":{"type":"integer"},"votesNegative":{"type":"integer"}}},"SocialProfilePostsPage":{"type":"object","properties":{"posts":{"type":"array","items":{"$ref":"#/components/schemas/SocialPost"}},"numPages":{"type":"integer"}}},"SocialProfilePostRef":{"type":"object","properties":{"id":{"type":"string"}}},"SocialProfileVote":{"type":"object","properties":{"txid":{"type":"string"},"timestamp":{"type":"integer"},"sentiment":{"type":"string","enum":["positive","negative"]},"sats":{"type":"integer"},"post":{"$ref":"#/components/schemas/SocialProfilePostRef"}}},"SocialProfileVotesPage":{"type":"object","properties":{"votes":{"type":"array","items":{"$ref":"#/components/schemas/SocialProfileVote"}},"numPages":{"type":"integer"}}},"SocialPostSummary":{"type":"object","properties":{"platform":{"type":"string"},"profileId":{"type":"string"},"postId":{"type":"string"},"ranking":{"type":"integer"},"votesPositive":{"type":"integer"},"votesNegative":{"type":"integer"}}},"SocialPostDetail":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/SocialPostSummary"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/SocialProfileVote"}},"numPages":{"type":"integer"}}},"SocialStatsRow":{"type":"object","properties":{"platform":{"type":"string"},"id":{"type":"string"},"ranking":{"type":"integer"}}},"SocialStatsList":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/SocialStatsRow"}}}},"HealthInfo":{"type":"object","description":"Liveness snapshot returned by GET /api/v1/health. Cheap to compute and cached for one second.","properties":{"status":{"type":"string","enum":["ok","syncing"]},"height":{"type":"integer"},"best_block_hash":{"type":"string"},"median_time":{"type":"integer"},"ibd":{"type":"boolean"},"uptime_seconds":{"type":"integer"},"version":{"type":"integer"},"subversion":{"type":"string"}}},"PoolConnect":{"type":"object","description":"Connection details for miners. stratumUrls come from -poolstratumurl; ports from the stratum listeners (no bind address).","properties":{"stratumUrls":{"type":"array","items":{"type":"string"}},"ports":{"type":"array","items":{"type":"object","properties":{"port":{"type":"integer"},"algo":{"type":"string"}}}},"userFormat":{"type":"string"},"password":{"type":"string"},"minerImage":{"type":"string"}}},"PoolSummary":{"type":"object","properties":{"poolId":{"type":"string"},"payoutsEnabled":{"type":"boolean"},"feeBps":{"type":"integer"},"burnBps":{"type":"integer"},"minPayout":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"maxPayees":{"type":"integer"},"tipHeight":{"type":"integer"},"burnPerBlockSats":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"burnPerYearAtTargetSats":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"poolHashrate":{"type":"number"},"miners":{"type":"integer"},"burnt_addressless_24h_sats":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"burnt_addressless_total_sats":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"addressless_miners":{"type":"integer"},"blocks_24h_by_algo":{"type":"object","properties":{"lotushash":{"type":"integer"},"sha256d-auxpow":{"type":"integer"},"scrypt-auxpow":{"type":"integer"}}},"algorithms":{"type":"object","description":"Pool-wide figures per algorithm","properties":{"lotushash":{"type":"object","description":"One algorithm, fleet-wide: Lotus-equivalent and own-unit hashrate (x M today) over 10 min and 1 h, shares, payout addresses and machines with a share in 10 min, pool blocks and expected blocks in 24 h","properties":{"hashrate_lotus_equivalent_10m":{"type":"number"},"hashrate_lotus_equivalent_1h":{"type":"number"},"hashrate_10m":{"type":"number"},"hashrate_1h":{"type":"number"},"multiplier":{"type":"number"},"shares_10m":{"type":"integer"},"shares_1h":{"type":"integer"},"shares_24h":{"type":"integer"},"miners_10m":{"type":"integer"},"machines_10m":{"type":"integer"},"last_share_unix_s":{"type":["number","null"]},"blocks_24h":{"type":"integer"},"expected_24h":{"type":"number"},"last_block_unix_s":{"type":["number","null"]}}},"sha256d-auxpow":{"type":"object","description":"One algorithm, fleet-wide: Lotus-equivalent and own-unit hashrate (x M today) over 10 min and 1 h, shares, payout addresses and machines with a share in 10 min, pool blocks and expected blocks in 24 h","properties":{"hashrate_lotus_equivalent_10m":{"type":"number"},"hashrate_lotus_equivalent_1h":{"type":"number"},"hashrate_10m":{"type":"number"},"hashrate_1h":{"type":"number"},"multiplier":{"type":"number"},"shares_10m":{"type":"integer"},"shares_1h":{"type":"integer"},"shares_24h":{"type":"integer"},"miners_10m":{"type":"integer"},"machines_10m":{"type":"integer"},"last_share_unix_s":{"type":["number","null"]},"blocks_24h":{"type":"integer"},"expected_24h":{"type":"number"},"last_block_unix_s":{"type":["number","null"]}}},"scrypt-auxpow":{"type":"object","description":"One algorithm, fleet-wide: Lotus-equivalent and own-unit hashrate (x M today) over 10 min and 1 h, shares, payout addresses and machines with a share in 10 min, pool blocks and expected blocks in 24 h","properties":{"hashrate_lotus_equivalent_10m":{"type":"number"},"hashrate_lotus_equivalent_1h":{"type":"number"},"hashrate_10m":{"type":"number"},"hashrate_1h":{"type":"number"},"multiplier":{"type":"number"},"shares_10m":{"type":"integer"},"shares_1h":{"type":"integer"},"shares_24h":{"type":"integer"},"miners_10m":{"type":"integer"},"machines_10m":{"type":"integer"},"last_share_unix_s":{"type":["number","null"]},"blocks_24h":{"type":"integer"},"expected_24h":{"type":"number"},"last_block_unix_s":{"type":["number","null"]}}}}},"hashrate_merged_lotus_equivalent":{"type":"object","description":"Merged hashrate, pool scope: lotushash + sha256d / M + scrypt / M over 10 minutes (doc/mining-figures.md)","properties":{"total":{"type":"number"},"by_algo":{"type":"object","properties":{"lotushash":{"type":"number"},"sha256d-auxpow":{"type":"number"},"scrypt-auxpow":{"type":"number"}}},"window_seconds":{"type":"integer"},"scope":{"type":"string"}}},"blocksFound":{"type":"object","properties":{"total":{"type":"integer"},"last24h":{"type":"integer"}}},"luck":{"type":"object","description":"1 / average effort; null without blocks","properties":{"last10":{"type":["number","null"]},"last50":{"type":["number","null"]},"last200":{"type":["number","null"]}}},"float":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"pendingAccounts":{"type":"integer"},"ownershipPending":{"type":"integer"},"spoofBlocks":{"type":"integer"},"floatCaveat":{"type":"string"},"live":{"type":"object","description":"From this node's memory, not SQLite","properties":{"roundWeight":{"type":"string"},"currentEffort":{"type":"number"},"poolPeers":{"type":"integer"},"alignedPeers":{"type":"integer"},"ledgerDigest":{"type":"string"},"fleet":{"type":"object","description":"Pool members including this node; aligned: same config and ledger digest at the tip; diverging: a different digest at the same tip (the only alarm); other_tip: announced for another tip (behind, ahead); waiting: a fleet pool node before its poolhello; light_clients: thin or light nodes from a fleet address (never pool members); refused: fleet node ids by reason (protocol, config, pool-id, node-id)","properties":{"nodeId":{"type":"integer"},"members":{"type":"integer"},"aligned":{"type":"integer"},"diverging":{"type":"array","items":{"type":"integer"}},"refused":{"type":"object","additionalProperties":{"type":"array","items":{"type":"integer"}}},"protocol":{"type":"integer"},"refusedProtocols":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"integer"},"version":{"type":"integer"}}}},"waiting":{"type":"integer"},"light_clients":{"type":"integer"},"other_tip":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"integer"},"height":{"type":["number","null"]},"blocks_behind":{"type":["number","null"]}}}},"msg_queue":{"type":"object","properties":{"items":{"type":"integer"},"bytes":{"type":"integer"},"max_items":{"type":"integer"},"full":{"type":"boolean"}}}}}}},"connect":{"$ref":"#/components/schemas/PoolConnect"}}},"PoolRelays":{"type":"object","properties":{"bridge":{"type":"boolean"},"relays":{"type":"array","items":{"type":"object","properties":{"relay":{"type":"string"},"active":{"type":"boolean"},"firstSeenMs":{"type":"integer"},"lastSeenMs":{"type":"integer"},"batches":{"type":"integer"},"accepted":{"type":"integer"},"rejected":{"type":"integer"},"blocks":{"type":"integer"},"rejectReasons":{"type":"object","properties":{}},"addresses":{"type":"integer"},"miners":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"accepted":{"type":"integer"},"rejected":{"type":"integer"},"blocks":{"type":"integer"},"lastShareMs":{"type":"integer"}}}}}}}}},"PoolMinersPage":{"type":"object","properties":{"miners":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"hashrate":{"type":"number"},"shares1h":{"type":"integer"},"sharePct":{"type":"number"},"lastShareMs":{"type":"integer"},"owed":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"totalPaid":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"totalCredited":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"by_algo":{"type":"object","description":"Last hour per algorithm (lotushash, sha256d-auxpow, scrypt-auxpow): weight, shares, hashrate_lotus_equivalent, machines","properties":{}},"addressless":{"type":"boolean"},"via_relays":{"type":"array","items":{"type":"string"}}}}},"total":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"}}},"PoolMiner":{"type":"object","properties":{"address":{"type":"string"},"owed":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"totalCredited":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"totalPaid":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"payouts":{"type":"array","items":{"type":"object","properties":{"blockHash":{"type":"string"},"height":{"type":"integer"},"vout":{"type":"integer"},"amount":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"entitlement":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"status":{"type":"string"}}}},"shares":{"type":"array","items":{"type":"object","properties":{"shareId":{"type":"string"},"difficulty":{"type":"number"},"height":{"type":"integer"},"timeMs":{"type":"integer"},"node":{"type":"integer"},"block":{"type":"boolean"}}}},"ledger":{"type":"array","items":{"type":"object","properties":{"blockHash":{"type":"string"},"height":{"type":"integer"},"delta":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"reason":{"type":"string"},"timeMs":{"type":"integer"}}}},"hashrate":{"type":"array","items":{"type":"array"}}}},"PoolNext":{"type":"object","properties":{"height":{"type":"integer"},"timeMs":{"type":"integer"},"outputs":{"type":"array","items":{"type":"object","description":"kind: payee, fund or burn","properties":{"kind":{"type":"string"},"vout":{"type":"integer"},"address":{"type":"string"},"amount":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"entitlement":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"owedBefore":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"shareCode":{"type":"integer"},"hashrateCode":{"type":"integer"}}}},"total":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"recordHex":{"type":"string"}}},"PoolBlocksPage":{"type":"object","properties":{"blocks":{"type":"array","items":{"type":"object","properties":{"blockHash":{"type":"string"},"height":{"type":"integer"},"poolId":{"type":"string"},"ours":{"type":"boolean"},"finderNode":{"type":"integer"},"effort":{"type":"number"},"reward":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"fund":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"burn":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"distributed":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"payees":{"type":"integer"},"flags":{"type":"integer"},"status":{"type":"string"},"confirmations":{"type":"integer"},"settleState":{"type":"string"},"blockTime":{"type":"integer"},"windowShares":{"type":"integer"},"poolHashrate":{"type":"number"},"algo":{"type":["string","null"],"description":"lotushash, sha256d-auxpow or scrypt-auxpow (null: block unknown)"}}}},"limit":{"type":"integer"}}},"PoolRecord":{"type":"object","description":"Decoded POOL record; more fields when found (doc/pool-payouts.md 5).","properties":{"found":{"type":"boolean"},"error":{"type":"string"},"blockHash":{"type":"string"},"height":{"type":"integer"},"coinbaseTxid":{"type":"string"},"payeeTotal":{"type":"integer"},"recordOutputs":{"type":"array","items":{"type":"integer"}}}},"PoolBlock":{"type":"object","properties":{"blockHash":{"type":"string"},"height":{"type":"integer"},"poolId":{"type":"string"},"ours":{"type":"boolean"},"finderNode":{"type":"integer"},"effort":{"type":"number"},"reward":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"fund":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"burn":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"distributed":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"payeeCount":{"type":"integer"},"flags":{"type":"integer"},"status":{"type":"string"},"settleState":{"type":"string"},"blockTime":{"type":"integer"},"windowCommit":{"type":"string"},"windowShares":{"type":"integer"},"windowWeight":{"type":"string"},"feeBps":{"type":"integer"},"burnBps":{"type":"integer"},"poolHashrate":{"type":"number"},"recordHex":{"type":"string"},"payouts":{"type":"array","items":{"type":"object","properties":{"vout":{"type":"integer"},"address":{"type":"string"},"amount":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"entitlement":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"shareCode":{"type":"integer"},"hashrateCode":{"type":"integer"},"hashrate":{"type":"number"}}}},"record":{"$ref":"#/components/schemas/PoolRecord"}}},"PoolBalances":{"type":"object","properties":{"balances":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"owed":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"totalCredited":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"totalPaid":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"updatedHeight":{"type":"integer"}}}},"float":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"},"minPayout":{"type":"integer","description":"satoshis (1 XPI = 1,000,000)"}}},"PoolHashrate":{"type":"object","properties":{"address":{"type":"string"},"rangeSec":{"type":"integer"},"samples":{"type":"array","items":{"type":"array"}}}},"PoolHistory":{"type":"object","properties":{"rangeSec":{"type":"integer"},"bucketSec":{"type":"integer"},"columns":{"type":"array","items":{"type":"string"}},"buckets":{"type":"array","items":{"type":"array"}}}},"MiningAlgorithmShares":{"type":"object","description":"Share counters, last 24 hours.","properties":{"accepted":{"type":"integer","description":""},"rejected":{"type":"integer","description":""},"stale":{"type":"integer","description":""},"lotus_stale":{"type":"integer","description":""},"forwarded":{"type":"integer","description":""},"upstream_accepted":{"type":"integer","description":""},"upstream_rejected":{"type":"integer","description":""}},"required":["accepted","rejected","stale","lotus_stale","forwarded","upstream_accepted","upstream_rejected"]},"MiningAlgorithm":{"type":"object","description":"One proof-of-work algorithm of this node.","properties":{"algo":{"type":"string","description":"lotushash, scrypt-auxpow or sha256d-auxpow"},"parent_pow":{"type":["string","null"],"description":"scrypt or sha256d; null for lotushash"},"multiplier":{"type":"number","description":"Consensus difficulty factor M (1 for lotushash); an integer on every built-in chain, a fraction (below 1 included) under a test network's -auxpowmultiplier"},"multiplier_info":{"type":"object","description":"{value, text, numerator, denominator, source (native, default or launch), default, activation_time_unix_s, next {value, text, activation_time_unix_s} or null, why, tip_median_time_past_unix_s, chain_difficulty, effective_target, block_share_difficulty, hashes_per_block}: what sets this algorithm's block target, and why"},"workers_10m":{"type":"integer","description":"This algorithm's machines with a share in the last 10 minutes"},"share_settings":{"type":"object","description":"{listener_difficulty, vardiff_floor, vardiff_floor_source (listener, launch or global), vardiff_ceiling, vardiff_target_seconds, units, worker_difficulty_min, worker_difficulty_max, expected_seconds_per_share, observed_hashrate, expected_seconds_to_block}"},"regime":{"type":"string","description":"native, mmv2, legacy or inactive"},"state":{"type":"string","description":"mining, not-eligible, no-miners, proxy-only, port-closed, lotus-only, upstream-down, port-held, paused-ibd, no-payout, error or off"},"listeners":{"type":"array","description":"{port, default_difficulty, accepting, accepting_again_unix_s}"},"source":{"type":["object","null"],"description":"{kind, parent_chain, upstream_index, forced, forced_since_unix_s}"},"anchor":{"type":["string","null"],"description":"tag, wide, compact or none"},"anchor_bytes":{"type":["integer","null"],"description":"Anchor size in bytes (tag 44)"},"eligible":{"type":["boolean","null"],"description":"A share meeting the Lotus bound can become a block now"},"eligible_reason":{"type":["string","null"],"description":"Why not, as a code"},"not_eligible_seconds":{"type":"integer","description":"Last 24 hours"},"expected_seconds_to_block":{"type":["number","null"],"description":"At the 10-minute rate"},"lotus_share_difficulty":{"type":"number","description":"Lotus block difficulty in this algorithm's share difficulty"},"upstream_refusals_24h":{"type":["object","null"],"description":"Pools refused to this algorithm's miners, last 24 hours, counts per code: extranonce-too-small, bad-password, private-host, unknown-host, connection-limit, all-pools-failed (no host, account or miner); null for lotushash"},"workers":{"type":"integer","description":"Sessions authorized now"},"workers_by_state":{"type":"object","description":"This algorithm's machines by state: ok, degraded, offline, connecting, auth-failed"},"sessions_closed_for_failover":{"type":"integer","description":"Last 30 minutes"},"hashrate":{"type":"number","description":"Hashes per second of this algorithm. 10 minutes."},"hashrate_1h":{"type":"number","description":"Hashes per second of this algorithm."},"hashrate_24h":{"type":"number","description":"Hashes per second of this algorithm."},"hashrate_lotus_equivalent":{"type":"number","description":"Hashrate divided by the algorithm's difficulty factor, in Lotus hashes per second (Lotus-equivalent)."},"hashrate_lotus_equivalent_1h":{"type":"number","description":"Hashrate divided by the algorithm's difficulty factor, in Lotus hashes per second (Lotus-equivalent)."},"hashrate_lotus_equivalent_24h":{"type":"number","description":"Hashrate divided by the algorithm's difficulty factor, in Lotus hashes per second (Lotus-equivalent)."},"shares_24h":{"$ref":"#/components/schemas/MiningAlgorithmShares"},"share_difficulty":{"type":["object","null"],"description":"{min, max} over sessions"},"best_share_difficulty_24h":{"type":["number","null"],"description":"Not measured in this build: null"},"last_share_unix_s":{"type":["integer","null"],"description":"Unix time, seconds."},"blocks":{"type":"object","description":"lotus_24h, lotus_7d, lotus_total, expected_24h, parent_24h, parent_total, last_lotus_unix_s, reward_24h_sats, reward_24h_mature_sats"}},"required":["algo","parent_pow","multiplier","multiplier_info","workers_10m","share_settings","regime","state","listeners","source","anchor","anchor_bytes","eligible","eligible_reason","not_eligible_seconds","expected_seconds_to_block","lotus_share_difficulty","upstream_refusals_24h","workers","workers_by_state","sessions_closed_for_failover","hashrate","hashrate_1h","hashrate_24h","hashrate_lotus_equivalent","hashrate_lotus_equivalent_1h","hashrate_lotus_equivalent_24h","shares_24h","share_difficulty","best_share_difficulty_24h","last_share_unix_s","blocks"]},"MiningStatus":{"type":"object","description":"Mining status of this node (public data only).","properties":{"enabled":{"type":"boolean","description":"Stratum server running"},"network":{"type":"string","description":"main, test or regtest"},"ibd":{"type":"boolean","description":"Initial block download"},"public_host":{"type":["string","null"],"description":"-miningpublichost"},"payout_address":{"type":["string","null"],"description":"-stratumcoinbase"},"payout":{"type":"string","description":"address (paid to payout_address) or burn (no payout address: the reward goes to an OP_RETURN output)"},"public_workers":{"type":"boolean","description":"-miningpublicworkers"},"mmv2":{"type":"object","description":"{active, activation_time, active_since_height, anchor_min_bytes, asert_half_life_seconds}"},"lotus":{"type":"object","description":"{height, headers, bits, target, difficulty, hashrate, target_per_algo}"},"errors":{"type":"array","description":"Listener errors"},"connection_failures_1h":{"type":"object","description":"Counts by reason, last hour"},"algorithms":{"type":"array","items":{"$ref":"#/components/schemas/MiningAlgorithm"},"description":"Always three entries"}},"required":["enabled","network","ibd","public_host","payout_address","payout","public_workers","mmv2","lotus","errors","connection_failures_1h","algorithms"]},"MiningUpstream":{"type":"object","description":"One parent work source. Never: name, host, port, url, account, password, authority key, error text.","properties":{"index":{"type":"integer","description":""},"algo":{"type":"string","description":""},"kind":{"type":"string","description":"pool-v1, pool-v2, rpc, thin-node, synthetic"},"parent_chain":{"type":["string","null"],"description":""},"active":{"type":"boolean","description":""},"state":{"type":"string","description":"connecting, connected, down, fallback-synthetic"},"since_unix_s":{"type":["integer","null"],"description":"Unix time, seconds."},"attempt":{"type":["integer","null"],"description":""},"next_retry_unix_s":{"type":["integer","null"],"description":"Unix time, seconds."},"reconnects_24h":{"type":"integer","description":""},"last_error_code":{"type":["string","null"],"description":""},"last_error_unix_s":{"type":["integer","null"],"description":"Unix time, seconds."},"latency_ms":{"type":["integer","null"],"description":"Not measured in this build: null"},"extranonce2_size":{"type":["integer","null"],"description":""},"prefix_bytes":{"type":["integer","null"],"description":""},"miner_bytes":{"type":["integer","null"],"description":""},"version_rolling":{"type":["boolean","null"],"description":""},"version_mask":{"type":["string","null"],"description":""},"anchor":{"type":"string","description":"tag, wide, compact or none"},"anchor_bytes":{"type":["integer","null"],"description":""},"anchor_reason":{"type":["string","null"],"description":"too-few-bytes, outside-script, no-work, rule-inactive"},"anchor_bytes_needed":{"type":["integer","null"],"description":""},"share_difficulty":{"type":["number","null"],"description":""},"parent_difficulty":{"type":["number","null"],"description":""},"template_height":{"type":["integer","null"],"description":""},"template_age_seconds":{"type":["integer","null"],"description":""},"channels":{"type":"integer","description":""},"pool_worker_suffix":{"type":"boolean","description":""},"last_job_unix_s":{"type":["integer","null"],"description":"Unix time, seconds."},"shares_24h":{"type":"object","description":"{forwarded, upstream_accepted, upstream_rejected}"},"upstream_reject_reasons_24h":{"type":"object","description":"{stale, job-not-found, low-difficulty, duplicate, ntime, other}"}},"required":["index","algo","kind","parent_chain","active","state","since_unix_s","attempt","next_retry_unix_s","reconnects_24h","last_error_code","last_error_unix_s","latency_ms","extranonce2_size","prefix_bytes","miner_bytes","version_rolling","version_mask","anchor","anchor_bytes","anchor_reason","anchor_bytes_needed","share_difficulty","parent_difficulty","template_height","template_age_seconds","channels","pool_worker_suffix","last_job_unix_s","shares_24h","upstream_reject_reasons_24h"]},"MiningUpstreamList":{"type":"object","description":"","properties":{"enabled":{"type":"boolean","description":""},"upstreams":{"type":"array","items":{"$ref":"#/components/schemas/MiningUpstream"},"description":""}},"required":["enabled","upstreams"]},"MiningWorker":{"type":"object","description":"One miner, by anonymous label. Never: name, payout_address, ip, remote_address, user_agent.","properties":{"label":{"type":"string","description":"w- followed by 6 or 8 hex digits"},"algo":{"type":"string","description":""},"state":{"type":"string","description":""},"stage":{"type":"string","description":""},"new":{"type":"boolean","description":""},"listener_port":{"type":"integer","description":""},"sessions":{"type":"integer","description":""},"share_difficulty":{"type":["number","null"],"description":""},"upstream_difficulty":{"type":["number","null"],"description":""},"capped_by_pool":{"type":"boolean","description":""},"hashrate":{"type":"number","description":"Hashes per second of this algorithm."},"hashrate_1h":{"type":"number","description":"Hashes per second of this algorithm."},"hashrate_24h":{"type":"number","description":"Hashes per second of this algorithm."},"hashrate_7d_median_1h":{"type":["number","null"],"description":"Not computed: null"},"hashrate_lotus_equivalent":{"type":"number","description":"Hashrate divided by the algorithm's difficulty factor, in Lotus hashes per second (Lotus-equivalent)."},"hashrate_lotus_equivalent_1h":{"type":"number","description":"Hashrate divided by the algorithm's difficulty factor, in Lotus hashes per second (Lotus-equivalent)."},"hashrate_lotus_equivalent_24h":{"type":"number","description":"Hashrate divided by the algorithm's difficulty factor, in Lotus hashes per second (Lotus-equivalent)."},"extranonce2_size":{"type":["integer","null"],"description":""},"miner_bytes":{"type":["integer","null"],"description":""},"version_rolling":{"type":["boolean","null"],"description":""},"version_mask":{"type":["string","null"],"description":""},"eligible_reason":{"type":["string","null"],"description":""},"shares_24h":{"type":"object","description":""},"upstream_reject_reasons_24h":{"type":"object","description":""},"best_share_difficulty_24h":{"type":["number","null"],"description":""},"last_share_unix_s":{"type":["integer","null"],"description":"Unix time, seconds. Null once older than 1 h."},"offline_since_day":{"type":["string","null"],"description":"YYYY-MM-DD (UTC)"},"last_forwarded_unix_s":{"type":["integer","null"],"description":"Unix time, seconds."},"connected_since_unix_s":{"type":["integer","null"],"description":"Unix time, seconds. Rounded down to the hour."},"last_reject_reason":{"type":["string","null"],"description":""},"last_reject_unix_s":{"type":["integer","null"],"description":"Unix time, seconds."},"lotus_blocks_24h":{"type":"integer","description":""},"last_block_unix_s":{"type":["integer","null"],"description":"Unix time, seconds."},"auth_error_code":{"type":["string","null"],"description":""}},"required":["label","algo","state","stage","new","listener_port","sessions","share_difficulty","upstream_difficulty","capped_by_pool","hashrate","hashrate_1h","hashrate_24h","hashrate_7d_median_1h","hashrate_lotus_equivalent","hashrate_lotus_equivalent_1h","hashrate_lotus_equivalent_24h","extranonce2_size","miner_bytes","version_rolling","version_mask","eligible_reason","shares_24h","upstream_reject_reasons_24h","best_share_difficulty_24h","last_share_unix_s","offline_since_day","last_forwarded_unix_s","connected_since_unix_s","last_reject_reason","last_reject_unix_s","lotus_blocks_24h","last_block_unix_s","auth_error_code"]},"MiningWorkerList":{"type":"object","description":"","properties":{"enabled":{"type":"boolean","description":""},"public":{"type":"boolean","description":"-miningpublicworkers"},"counts":{"type":"object","description":""},"data":{"type":"array","items":{"$ref":"#/components/schemas/MiningWorker"},"description":""},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["enabled","public","counts","data","pagination"]},"MiningFoundBlock":{"type":"object","description":"A block found by this node's miners.","properties":{"id":{"type":"integer","description":""},"time_unix_s":{"type":"integer","description":"Unix time, seconds."},"chain":{"type":"string","description":"lotus or parent"},"parent_chain":{"type":["string","null"],"description":""},"algo":{"type":"string","description":""},"height":{"type":["integer","null"],"description":"Null on parent rows"},"parent_height":{"type":["integer","null"],"description":""},"hash":{"type":["string","null"],"description":"Null on parent rows"},"parent_hash":{"type":["string","null"],"description":""},"worker_label":{"type":["string","null"],"description":""},"anchor":{"type":["string","null"],"description":""},"anchor_bytes":{"type":["integer","null"],"description":""},"state":{"type":"string","description":""},"reject_reason":{"type":["string","null"],"description":""},"confirmations":{"type":["integer","null"],"description":""},"reward_sats":{"type":["integer","null"],"description":""}},"required":["id","time_unix_s","chain","parent_chain","algo","height","parent_height","hash","parent_hash","worker_label","anchor","anchor_bytes","state","reject_reason","confirmations","reward_sats"]},"MiningFoundBlockList":{"type":"object","description":"","properties":{"enabled":{"type":"boolean","description":""},"summary":{"type":"object","description":""},"data":{"type":"array","items":{"$ref":"#/components/schemas/MiningFoundBlock"},"description":""},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["enabled","summary","data","pagination"]},"MiningShareSeries":{"type":"object","description":"","properties":{"enabled":{"type":"boolean","description":""},"hours":{"type":"integer","description":""},"bucket_seconds":{"type":"integer","description":""},"columns":{"type":"array","description":""},"series":{"type":"array","description":"{algo, points}"}},"required":["enabled","hours","bucket_seconds","columns","series"]},"MiningProofShare":{"type":"object","description":"","properties":{"enabled":{"type":"boolean","description":""},"blocks":{"type":"integer","description":""},"from_height":{"type":["integer","null"],"description":""},"to_height":{"type":["integer","null"],"description":""},"counts":{"type":"object","description":""},"by_field":{"type":"object","description":""},"found_here":{"type":"integer","description":""},"hashrate_lotus_equivalent":{"type":"object","description":"Network hashrate per algorithm (lotushash, scrypt-auxpow, sha256d-auxpow), Lotus-equivalent: chain_hashrate split by the blocks of each kind (an estimate; also in each bucket)"},"chain_hashrate":{"type":"number","description":"Chain hashrate over the last 120 blocks"},"hashrate_merged_lotus_equivalent":{"type":"object","description":"Merged hashrate, network scope: {total, by_algo, scope, source}; total = the sum of the Lotus-equivalents = chain_hashrate (doc/mining-figures.md)"},"buckets":{"type":"array","description":""}},"required":["enabled","blocks","from_height","to_height","counts","by_field","found_here","hashrate_lotus_equivalent","chain_hashrate","hashrate_merged_lotus_equivalent","buckets"]},"MiningEvent":{"type":"object","description":"","properties":{"time_unix_s":{"type":"integer","description":"Unix time, seconds."},"algo":{"type":["string","null"],"description":""},"upstream_index":{"type":["integer","null"],"description":""},"kind":{"type":["string","null"],"description":""},"event":{"type":"string","description":""},"code":{"type":["string","null"],"description":""},"anchor":{"type":["string","null"],"description":""},"anchor_bytes":{"type":["integer","null"],"description":""},"extranonce2_size":{"type":["integer","null"],"description":""},"sessions_closed":{"type":["integer","null"],"description":""},"listener_port":{"type":["integer","null"],"description":""}},"required":["time_unix_s","algo","upstream_index","kind","event","code","anchor","anchor_bytes","extranonce2_size","sessions_closed","listener_port"]},"MiningEventList":{"type":"object","description":"","properties":{"enabled":{"type":"boolean","description":""},"data":{"type":"array","items":{"$ref":"#/components/schemas/MiningEvent"},"description":""},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["enabled","data","pagination"]},"MiningProof":{"type":"object","description":"","properties":{"enabled":{"type":"boolean","description":""},"hash":{"type":"string","description":""},"height":{"type":"integer","description":""},"proof_field":{"type":"integer","description":"1 to 4"},"algo":{"type":"string","description":""},"regime":{"type":"string","description":""},"multiplier":{"type":"number","description":""},"multiplier_text":{"type":"string","description":"5, 181000, 1/8192"},"bits":{"type":"string","description":""},"bound":{"type":"string","description":""},"lotus_share_difficulty":{"type":"number","description":""},"header_share_difficulty":{"type":"number","description":""},"work_ratio":{"type":"number","description":""},"time_unix_s":{"type":"integer","description":"Unix time, seconds."},"prev_mtp_unix_s":{"type":"integer","description":"Unix time, seconds."},"parent":{"type":"object","description":""},"anchor":{"type":"object","description":""},"merkle_branch_len":{"type":"integer","description":""},"found_here":{"type":["object","null"],"description":""},"recorded":{"type":"boolean","description":"Recorded when the block was connected; false: decoded from the block file (anchor position unknown)"}},"required":["enabled","hash","height","proof_field","algo","regime","multiplier","multiplier_text","bits","bound","lotus_share_difficulty","header_share_difficulty","work_ratio","time_unix_s","prev_mtp_unix_s","parent","anchor","merkle_branch_len","found_here","recorded"]},"MiningInfo":{"type":"object","description":"Mining info of the tip (no cs_main)","properties":{"height":{"type":"integer","description":""},"difficulty":{"type":"number","description":""},"bits":{"type":"string","description":"8 hex digits"},"chain_work":{"type":"string","description":""},"mempool_size":{"type":"integer","description":""},"mempool_bytes":{"type":"integer","description":""},"chain":{"type":"string","description":"main, test or regtest"}},"required":["height","difficulty","bits","chain_work","chain"]}},"securitySchemes":{"rpcBasicAuth":{"type":"http","scheme":"basic","description":"The node's JSON-RPC credentials. Only the operator routes (security: rpcBasicAuth) need them; every other route is public."}}}}
