Explorer
Using the node12.4.15+

Explorer

The explorer pages of the node, the search syntax, the REST routes each page reads, and the options of the explorer index.

The Explorer is the first tab of the node's web UI. It reads the node's own index: no other service is involved, and every figure on a page comes from a public REST route you can call yourself.

Pages #

PageURLWhat it shows
Blocks/dashboardChain tiles (height, block time, hashrate, difficulty, mempool, supply, burned, transactions), the latest blocks with a "Mined by" filter, the mempool and the latest transactions
Mempool/dashboard/mempoolTransactions waiting for a block, refreshed every 2 seconds, and the mempool depth over 24 hours
Rich list/dashboard/top100The 100 largest addresses by balance, or by total received (/dashboard/top100/received), and how the coins are spread
Charts/dashboard/statsHashrate, difficulty, mempool, supply and burned over time; block time, transactions per block, hashrate by proof, block size
Block/dashboard/block/<height or hash>Header fields, reward and coinbase outputs with a label on each, the transactions, the proof of a merged-mined block
Transaction/dashboard/tx/<txid>Inputs and outputs with spent or unspent, fee, burned amount, and one card per protocol payload (RANK, SLP, ALP, POKR, BLOB, POOL, coinbase tag)
Address/dashboard/address/<address>Balance, totals, first and last block, latest transactions with filters, unspent outputs, tokens held, NFTs owned

The address page has Send and Receive buttons that open the browser wallet.

The search bar is on every page. What you type decides where it goes:

You typeIt opens
Digits only, 1427139The block at that height
64 hex charactersThe token with that id if there is one, else the transaction, else the block with that hash
@handleThe RANK profile of that Twitter handle
twitter:, nostr:, telegram:, poker: or localbusiness: followed by an idThe RANK profile on that platform, for example nostr:npub1...
business:<id> or biz:<id>The local business profile with that id
Anything elseThe address page for that text

A search is also a URL, so you can link to one:

Text
/dashboard/search?q=@handle

The REST routes behind the pages #

All under /api/v1/ on the node's web port. The full list with parameters and schemas is in /api/v1/openapi.json and on the REST API page.

PageRoutes
Blocksstats/cards, blocks?limit=&offset=, mempool, mining/network
Mempoolmempool?limit=, mempool/history
Rich listaddresses?sort=balance, addresses?sort=received, addresses?mode=wealth
Chartsstats/charts?period=, mempool/history?period=
Blockblocks/{id}, blocks/{id}/txs
Transactiontxs/{txid}, txs/{txid}/inputs, txs/{txid}/outputs, txs/{txid}/raw
Addressaddresses/{address}, addresses/{address}/txs, addresses/{address}/utxos

{id} is a block height or a block hash. period is day (default), week, month, quarter or year. blocks takes limit from 1 to 100; addresses returns 20 rows by default and 100 at most. blocks?pow_algo= keeps only the blocks of one proof: lotushash, sha256d-auxpow or scrypt-auxpow.

Read the latest block #

Shell
curl -s 'http://127.0.0.1:10604/api/v1/blocks?limit=1'
JSON
{
  "data": [
    {
      "hash": "0000000000cc5180c5cf0168956fdc595fbf1ca3d8cb6bab47a3e36ca7fbd479",
      "height": 1427139,
      "time": 1794871913,
      "n_tx": 1,
      "size": 465,
      "difficulty": 201.1915383508419,
      "pow_algo": "lotushash",
      "confirmations": 1,
      "reward_sats": 1209636439
    }
  ],
  "pagination": { "total": 1427140, "limit": 1, "offset": 0, "has_more": true }
}

The example leaves some fields out. Amounts are in satoshis in fields ending in _sats; 1 XPI is 1,000,000 satoshis.

Read an address #

Shell
curl -s http://127.0.0.1:10604/api/v1/addresses/<address>

A row of the rich list has address, balance_sats, received_sats, sent_sats, tx_count and utxo_count.

Page through an address's history #

addresses/{address}/txs pages with limit and offset. For a long history use addresses/{address}/history, which pages with cursors and costs the same at any depth:

ParameterMeaning
limitRows per page: 25 by default, 50 at most (200 with details=none)
beforeCursor: rows older than that row
afterCursor: rows newer than that row
detailsfull (default) for whole transaction rows, none for txid, height and net amount
max_ioInputs and outputs listed per transaction: 50 by default, 1000 at most

Rows come newest first. A page read with before never shifts when new blocks arrive.

To read many items in one request there are POST routes with a JSON body: txs/batch (100 txids), utxos/status (500 outpoints), addresses/batch/balance and addresses/batch/history-summary (100 addresses).

Unconfirmed transactions #

Address, UTXO and transaction answers include what is in the mempool (-mempooloverlay, on by default). An answer says "unconfirmed_complete": false when the overlay reached its memory bound (-mempooloverlaymaxmb, 256 by default).

Explorer index options #

The explorer tables live in blocks/index.sqlite in the data directory. They are about 90% of a synced data directory.

OptionDefaultEffect
-explorerindex1With 0 the node validates and serves the chain but keeps no explorer tables; the routes that need them answer 503 explorer_disabled. Turning it back on needs -reindex
-deferanalyticsindexes1 (0 on regtest)During the first sync only, build the read-only indexes (rich list, address UTXOs, sitemaps) in bulk once the node is at the tip. The views that need them answer 503 explorer_indexing meanwhile
-explorersynccache=<n>RAM/16, between 64 and 1024Page cache of the explorer database during the first sync, in MiB
-explorersyncwal=<n>64WAL size in MiB after which the database is checkpointed during the first sync
-apireaders=<n>-rpcthreadsRead-only connections the REST API opens on the explorer database, so reads do not wait for block connection
-txindex0Not needed by the explorer: txs/{txid}/raw reads a confirmed transaction from its block file through the explorer index
-rebuildaddressbalancesoffMaintenance: rebuild the per-address balances from the indexed outputs at startup. The node answers no request while it runs

Since 12.4.14 the node writes each block to the explorer database in one atomic step, checks the database at startup, and applies schema migrations by itself.

12.4.16+

Coming in 12.4.16: the explorer and the chain modules are written by a background indexer (-asyncindex, on by default) instead of during block connection. /api/v1/chain, /api/v1/chain/sync and /api/v1/health gain an indexer object that says how far behind it is.

Source share/www/docs/explorer.md in the lotusd repository
Checked against doc/webui-explorer.md doc/explorer-sql.md share/www/dashboard/js/dashboard.js share/www/dashboard/index.html src/api/openapi_handler.cpp src/api/stats_handler.cpp src/init.cpp