Derivations

Scan UTXO Set

Changed on Sep 29, 2026

Scan the UTXO Set for outputs belonging to the derivation scheme. The scan is split into batches to conserve RAM, scanning the whole UTXO set sequentially. Three branches are scanned: 0/x, 1/x and x. If a UTXO in one branch is found at a specific x, all addresses inferior to index x will be considered used.

post/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos/scan

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP basic
TypeScript
https://skmtc.dev/btcpayserver/apis/nbxplorer-api/docs/v1/cryptos/:cryptoCode/derivations/:derivationScheme/utxos/scan/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

cryptoCodestring required

The cryptocurrency code to track (e.g., 'BTC' for Bitcoin, 'LTC' for Litecoin).

derivationSchemestring required

The derivation scheme (See documentation)

Query parameters

batchSizeinteger

The number of addresses scanned at once per derivation scheme branch

gapLimitinteger

If no UTXO are detected in this interval, the scan stops

frominteger

The first address index to check

Response

Scan request queued

Changes

Sep 29, 202652231f42c765 Revision changes
- info
  api operation id ScanDerivationUTXOSet was added
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
Nov 25, 2024cfaf4efd4ea8 Revision changes
- breaking
  the response's body type changed from string to object for status
- breaking
  the response's body type changed from string to object for status
- breaking
  the response's body type changed from string to object for status
- info
  response schema application/json enum value removed rpc-unavailable
- info
  response schema application/json enum value removed scanutxoset-in-progress
- info
  response schema application/json enum value removed scanutxoset-not-suported
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history (5 revisions)