Derivations

Get UTXO scan status

Get the status of a UTXO scan. Results are kept for 24 hours after completion.

get/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/get.ts
A function with typed inputs. Its response is checked against the schema.

cryptoCodestring required

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

derivationSchemestring required

The derivation scheme (See documentation)

Scan status

errorstring nullable

queuedAtinteger

Unix timestamp when the scan was queued

status'Queued' | 'Pending' | 'Complete' | 'Error'

Current state of the scan