/

/Teranode Asset Service API.

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

Checked 1h ago · Updated 3w ago

5bc9be41e029

latestSwagger 2.0Open BSV License2026-07-177164113.9 KB

admin3

postMark a block as invalid (requires authentication).
postRevalidate a previously invalidated block (requires authentication).
getGet a list of recently invalidated blocks.

block15

getGet a block by hash in binary format.
getGet the fork tree for a block.
getGet a block by hash in hexadecimal format.
getGet a block by hash in JSON format.
getGet the nearest fork heights relative to a block.
getGet a legacy format block by hash in binary format.
getGet block locator hashes for chain synchronization.
getGet block data points for charting.
getGet a paginated list of blocks.
getGet N blocks starting from hash in binary format.
getGet N blocks starting from hash in hexadecimal format.
getGet N blocks starting from hash in JSON format.
getGet aggregate blockchain statistics.
getGet the last N blocks.
getGet a legacy format block by hash in binary (REST interface).

chain1

getGet blockchain network parameters.

fsm4

getGet available FSM events for the current state.
getGet the current FSM state of the node.
postSend an FSM event to transition state (requires authentication).
getGet all possible FSM states.

header15

getGet the best (tip) block header in binary format.
getGet the best (tip) block header in hexadecimal format.
getGet the best (tip) block header in JSON format.
getGet a single block header by hash in binary format.
getGet a single block header by hash in hexadecimal format.
getGet a single block header by hash in JSON format.
getGet block headers starting from hash in binary format.
getGet block headers starting from hash in hexadecimal format.
getGet block headers starting from hash in JSON format.
getGet block headers from the common ancestor in binary format.
getGet block headers from the common ancestor in hexadecimal format.
getGet block headers from the common ancestor in JSON format.
getGet block headers to the common ancestor in binary format.
getGet block headers to the common ancestor in hexadecimal format.
getGet block headers to the common ancestor in JSON format.

health2

getCheck if the Asset service is running.
getCheck the health of the Asset service and its dependencies.

peers2

postReset reputation metrics for a peer or all peers (requires authentication).
getGet the current peer registry.

policy1

getGet the node's mining policy in ARC-compatible format.

proof3

getGet a merkle proof for a transaction in BUMP binary format (BRC-74).
getGet a merkle proof for a transaction in BUMP hexadecimal format.
getGet a merkle proof for a transaction in BUMP JSON format.

search1

getSearch for a blockchain entity by hash or block height.

settings2

getGet all node settings with sensitive values redacted (requires authentication).
getGet the list of settings categories (requires authentication).

status2

getGet the current catchup synchronization status.
getGet the current block heights reported by each service.

subtree7

getGet paginated subtree metadata for a block in JSON format.
getGet a subtree by hash in binary format.
getGet a subtree by hash in hexadecimal format.
getGet a subtree by hash in JSON format with pagination.
postGet transactions from a subtree by posting a list of transaction hashes.
getGet paginated transaction details from a subtree in JSON format.
getGet raw subtree data as a binary stream.

transaction5

postSubmit a raw transaction for propagation.
getGet a transaction by hash in binary format.
getGet a transaction by hash in hexadecimal format.
getGet a transaction by hash in JSON format.
postSubmit multiple raw transactions for propagation.

txmeta4

getGet enriched transaction metadata in JSON format.
getGet raw transaction metadata in binary format.
getGet raw transaction metadata in hexadecimal format.
getGet raw transaction metadata in JSON format.

utxo4

getGet a UTXO by transaction hash and output index in binary format.
getGet a UTXO by transaction hash and output index in hexadecimal format.
getGet a UTXO by transaction hash and output index in JSON format.
getGet all UTXOs for a transaction in JSON format.

health

Check if the Asset service is running.

Returns uptime information.

get/alive

Response

Alive check