BIbitgo
Wallet

List a wallet's shielded notes

Changed on

Serves the ZEC/TZEC Ironwood pool — the ZIP-229 successor to Orchard; the indexer extracts Ironwood actions only, so notes received via legacy Orchard are not listed. By default only UNSPENT notes are returned; request PENDING_SPEND or SPENT explicitly to observe the indexer's recorded pending or spent notes. The page reflects the indexer's persisted on-chain state only: a note locked by one of the wallet's in-flight transactions (pending transaction requests, signed or unconfirmed transfers) still appears UNSPENT here until its spend is indexed — spend selection applies its own in-flight reservation, so treat the listing as observed value, not a spendability guarantee. The response proxies one page of the indexer's shielded-unspents listing — nextBatchPrevId is present only when the page came back full; feed it back as prevId for the next page. Coin-generic: any coin without shielded capability answers 400.

the shielded unspents listing; the request/response codecs here are the OpenAPI source of truth

get/api/v2/{coin}/wallet/{walletId}/shieldedunspents

Request

Path parameters

coinstring required

A cryptocurrency symbol or token ticker symbol

Example:btc

Coin or token identifier (e.g. zec, tzec)

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

Wallet ID to list shielded unspents for

Query parameters

limitstring number

Limit the number of results. Values above 2000 are clamped at the wallet-platform boundary (mirroring the transparent unspents endpoint), not rejected; values below 1 or non-integers are rejected with a 400.

prevIdstring

Continuation cursor: the nextBatchPrevId value from a previous response — the note commitment (cmx) of the last note on that page. Values that are not hex-shaped are rejected with a 400 at the wallet-platform boundary before the indexer is called.

spendState'UNSPENT' | 'PENDING_SPEND' | 'SPENT'

Spend state of the notes to list, as persisted by the indexer. This is the indexer's on-chain state only: unlike the transparent unspents endpoint, which excludes outputs locked in the send queue, this listing cannot exclude notes already selected by the wallet's in-flight transactions — such a note still appears UNSPENT until its spend is indexed (spend selection applies its own reservation). A PENDING_SPEND note is excluded from the default listing even if its spending transaction later fails; request that state explicitly to see it.

minValuestring

The minimum value of notes to return (in zatoshi). Must be a non-negative integer string (/^\d+$/); anything else is rejected with a 400 at the wallet-platform boundary before the indexer is called.

Response

OK

nextBatchPrevIdstring

The ID from where the results can continue; absent means end of results.

Changes