Derivations

Manual pruning

Manually prune transactions from a derivation scheme. This can be used to remove old transactions whose UTXOs have been spent.

post/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/prune

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/prune/post.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)

daysToKeepnumber double

The number of days of history to keep

{
  "daysToKeep": 1
}

Successfully pruned transactions

totalPrunedinteger

The number of transactions pruned from the derivation scheme

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