v3

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

Paginated global UTXO query

Returns a paginated list of UTXO records in ascending absolute_index order, spanning all Merkle trees.

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): UtxoResponse -- self-contained UtxoDataItem sub-messages.
  • Columnar (X-Response-Layout: columnar): UtxoColumnarResponse -- parallel field arrays. Smaller wire size; preferred for bulk transfers.

Absolute Index

absolute_index = tree_index * MAX_LEAVES_PER_TREE + insertion_index

where MAX_LEAVES_PER_TREE = 1,048,576.

Pagination

Use next_cursor from each response as start for the next page. Default page size: 1,000. Maximum: 5,000 (limit > 5000 -> 400).

get/v1/utxos

Query parameters

startinteger

Inclusive lower bound of the absolute index range to fetch. Defaults to 0.

endinteger

Inclusive upper bound of the absolute index range. When omitted, scans from start to end of dataset, bounded by limit.

limitinteger

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

Headers

X-Response-Layout'columnar'

Set to "columnar" for UtxoColumnarResponse (parallel arrays). Omit for the default row-oriented UtxoResponse.

Response

UTXO records for the requested absolute index range.