v3

latestOpenAPI 3.0.3raw.githubusercontent.com2026-04-10101545.6 KB
trees
utxos

Paginated UTXO records for a specific tree

Returns a paginated page of UTXO records belonging to the specified Merkle tree, ordered by absolute_index ascending (= insertion order).

Always Protobuf -- responds with application/x-protobuf regardless of the Accept header.

Response layout

Set the X-Response-Layout header to switch between encoding strategies:

  • Row-oriented (default, X-Response-Layout absent or any other value): UtxoResponse -- each UTXO is a self-contained UtxoDataItem message.
  • Columnar (X-Response-Layout: columnar): UtxoColumnarResponse -- fields are transposed into parallel arrays. Smaller wire size and preferred by data-pipeline consumers.

Pagination

The cursor parameter is an absolute index (not a tree-local insertion index). Initialize it to tree_index * MAX_LEAVES_PER_TREE for the first page, then use next_cursor from each response for subsequent pages.

get/v1/trees/{tree_index}/utxos

Path parameters

tree_indexinteger required

Zero-based index of the Merkle tree whose UTXOs to fetch.

Query parameters

cursorinteger

Absolute index at which to start the current page (inclusive). Defaults to tree_index * MAX_LEAVES_PER_TREE (first slot of the tree). Values below the tree's start boundary are clamped up.

limitinteger

Maximum records per page. Default: 1000. Maximum: 5000. Passing 0 uses the default.

Headers

X-Response-Layout'columnar'

Set to "columnar" to receive a UtxoColumnarResponse (struct-of-arrays). Omit or use any other value for the default row-oriented UtxoResponse.

Response

UTXO records for the specified tree.