REST API Documentation

Returns the calling key's tier, per-minute limit, and today's request total. Requires a key (401 otherwise). Response: {"key_prefix", "tier", "limit_per_min", "used_today", "reset_at"}.

Returns the current chain tip block.

Returns the latest block (alias for tip).

Returns a block by height or hash.

Returns the protocol tag distribution for a block. Response: array of {"protocol", "name", "short", "color", "tx_count"} covering detected on-chain protocols (ORD, BSV21, MAP, B, etc.) within the block.

Returns a paginated list of blocks. Cursor-style: from is the upper-bound height (exclusive when paging back), limit defaults to 20, max 100.

Returns the raw 80-byte block header as binary (application/octet-stream) for a given height. Use /block/headers/latest for a hex-encoded variant.

Returns the 80-byte block header of the current chain tip as a hex string.

Returns JSON array of downloadable header chunk URLs (2016-block difficulty periods). Each entry has url and label fields.

Downloads concatenated raw 80-byte headers for a height range as binary. Max 2016 blocks per request. Useful for SPV header chain sync.

Returns the total number of blocks mined by a specific miner. Response: {"miner": "TAAL", "blocks": 12345}

Returns a parsed transaction with inputs, outputs, and spend status. Use the always-present confirmed boolean (or block_height) to test confirmation: confirmations is omitted while a transaction is unconfirmed and only appears once it is mined.

Returns the raw transaction as a hex string.

Returns the raw transaction as binary.

Returns the merkle proof for a transaction in TSC format. Optional ?targetType= selects what target carries: merkleRoot (the default) or hash for the block hash. header returns 501 — the 80-byte header cannot be built here. Any other value returns 400.

Returns the inscription content embedded in the specified output. Served with the original MIME type (e.g. image/png, text/html). Returns 404 if no inscription exists at that output.

Renders the NFT at the specified output, resolving the seed-inscription chain (re-inscriptions follow the prior tx's inscription content). Served with the original MIME type. Returns 404 if no inscription is reachable from that output.

Returns the B:// file content embedded in the specified output. Served with the original MIME type. Returns 404 if no B:// data exists at that output.

Returns embedded media from the output, auto-detecting the format (inscription, B://, or other on-chain media). Served with the detected MIME type. Returns 404 if no media is found.

Returns a BRC-95 Atomic BEEF bundle (transaction + ancestor chain + merkle proofs) as binary. Used for SPV verification.

Returns a BRC-95 Atomic BEEF bundle as a hex string.

Returns the confirmation status of a transaction.

Returns propagation status across BSV nodes — shows which nodes have seen the transaction and whether it is in mempool or confirmed.

Returns the transaction ancestry graph — a tree of input transactions and their ancestors. Useful for visualizing transaction lineage.

Two flags qualify the result. truncated means the node cap was reached and the traversal stopped early; what is present is complete and correct. partial means a backend lookup of the ROOT transaction's spends or input values failed, so the graph was built from incomplete data — outgoing edges may be missing entirely, or input values and fees absent. The request still answers 200, so a client that cares about completeness must check partial rather than read an empty fan-out as fact.

Broadcasts a raw transaction. Body: {"rawtx": "hex"}

Broadcasts multiple raw transactions. Body: array of hex strings.

Returns address info with balance and UTXO count.

Returns paginated transaction history for an address.

Returns paginated UTXOs for an address. Confirmed UTXOs only — unconfirmed change outputs still in the mempool are not included. Clients that spend unconfirmed change (e.g. faucets) should use the mempool-aware WoC-compatible endpoint /api/v1/bsv/main/address/<addr>/unconfirmed/unspent (bulk: POST /api/v1/bsv/main/addresses/unconfirmed/unspent).

Returns just the balance for an address as a single confirmed balance field. Confirmed only — for a WoC-style {confirmed, unconfirmed} split, use the WoC-compatible /api/v1/bsv/main/address/<addr>/balance (or /confirmed/balance and the mempool-aware /unconfirmed/balance).

Returns the locking scripts associated with an address.

Returns BSV-21 token holdings for an address.

Returns token transfer history for a specific token at an address.

Returns a specific transaction output.

Returns the spending transaction for an output, if spent.

Downloads the raw transaction as a binary file.

Downloads the raw transaction as a hex text file.

Downloads a specific output script as binary.

Downloads a specific output script as hex.

Downloads a specific input script as binary.

Downloads a specific input script as hex.

Downloads a PDF receipt for a transaction.

Downloads a PDF statement of recent transactions for an address.

Auto-detects query type (txid, block hash/height, address) and returns a redirect.

Returns chain summary (height, hashrate, difficulty, price, market cap).

Returns daily network statistics (blocks, txs, fees, hashrate).

Returns mining pool distribution.

Returns time-bucketed mining data. Bucket sizes: 24h→1h, 7d→6h, 30d→1d. Response: array of {"bucket": "...", "miner": "TAAL", "blocks": 5}

Returns time-bucketed block property averages (size, tx count, fees). Bucket sizes: 24h→1h, 7d→6h, 30d→1d.

Returns protocol tag counts from recent transactions. Response: array of {"protocol": "ord", "tx_count": 5000}

Returns time-bucketed protocol tag counts. Bucket sizes: 24h→1h, 7d→6h, 30d→1d. Response: array of {"bucket": "...", "protocol": "ord", "tx_count": 5000}

Returns the paginated transaction list for a single protocol (same data as the /protocol/{key} HTML page), including the daily activity chart series. 404s if key is not a known protocol tag.

Returns daily tx-count history for a single protocol. days is clamped to 1–365 (default 90). Response: array of {"bucket": "...", "protocol": "ord", "tx_count": 5000}. 404s if key is not a known protocol tag.

Returns paginated rich list.

Returns historical BSV price data.

Returns time-series data for a given stat metric. Valid metrics: tx_count, total_fees, avg_fee, avg_fee_rate, avg_tx_size, median_fee, median_tx_size, total_output_value, coin_days_destroyed, hashrate, difficulty, avg_block_size, total_size, avg_tx_rate, miners_revenue, circulating_supply, utxo_count, blockchain_size, total_tx_count, exchange_rate, mining. Supports ?days= query parameter (default 30, max 10000 — clamped to available history from genesis; long windows are downsampled). Note: exchange_rate is limited to 365 days (CoinGecko free tier).

Returns the current BSV exchange rate in USD.

Returns BSV exchange rates in multiple currencies.

Returns mempool summary (tx count, size, usage, min fee).

Returns mempool fee rate and size distribution histograms. Response includes tx_count, total_fee_bsv, avg_fee_bsv, fee_rate_buckets (sat/byte ranges), and size_buckets (byte ranges). Cached for 30 seconds.

Returns detected protocol tags in mempool transactions with counts. Each entry has protocol, short, color, and count. Parses every mempool tx for protocol detection (ORD, BSV21, MAP, B, etc.). Cached for 60 seconds.

Returns current mining fee statistics.

Returns the current fee policy.

Decodes a raw transaction. Body: {"rawtx": "hex"}

Decodes a script hex string.

Converts an address between formats. Returns the base58, scripthash, and script hex for a given address.

Returns the connected node peers (proxies the BSV node's getpeerinfo). Each entry includes addr, services, conntime, version, subver, and traffic counters.

Returns a paginated list of all BSV-21 tokens.

Returns details for a specific token (name, symbol, supply, holder count).

Returns paginated list of token holders with balances.

Returns paginated token transfer history.

Multi-address batch token balances. Body: {"addresses": ["addr1", "addr2", ...]} (max 20 addresses per request). Returns an array keyed per address: {"address", "tokens": [{"token_id", "symbol", "decimals", "balance"}]}. Invalid or failed addresses return a per-item "error" with "tokens": [] rather than failing the whole batch.

Multi-address batch unspent token outputs. Body: {"addresses": ["addr1", "addr2", ...]} (max 20 addresses per request). Returns an array keyed per address: {"address", "utxos": [{"txid", "vout", "token_id", "symbol", "decimals", "amount", "block_height"}]}. Each address returns up to 100 most-recent unspent token UTXOs. When the returned list is not guaranteed complete — the 100 cap was reached, or (in Pebble mode) the spent-status scan hit its work guard on an address with a very large spent-token history — the entry includes "incomplete": true; treat such a list as partial. Invalid or failed addresses return a per-item "error" with "utxos": [].

Returns "ok" if the server is running. (Not under /api/v1 prefix.)

Registers a subscription. Form fields: selector, callback_url. Session-authenticated (dashboard form), not part of the /api/v1 surface.