Derivations

Get balance of tracked derivation scheme

get/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/balance

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/balance/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)

Balance information

unconfirmedinteger

Represents how the confirmed balance would be updated once all unconfirmed transactions are confirmed.

confirmedinteger

The balance of all funds in confirmed transactions.

availableinteger

The total spendable balance, calculated as total minus immature funds.

immatureinteger

The total unspendable funds (e.g., coinbase rewards that need 100 confirmations before being spendable).

totalinteger

The total funds owned, calculated as confirmed plus unconfirmed balances.

Sep 29, 202652231f42c765 Revision changes
- info
  api operation id GetDerivationSchemeBalance was added
Nov 25, 202432a04b45196c Revision changes
- info
  api tag Derivations added