Derivations

List tracked derivation schemes

Retrieves a list of all derivation schemes (wallets) that are currently being tracked for the specified cryptocurrency. This endpoint allows you to see all the wallets that NBXplorer is monitoring for transactions and balance changes.

get/v1/cryptos/{cryptoCode}/derivations

Path parameters

cryptoCodestring required

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

Response

Successfully retrieved the list of tracked derivation schemes.

derivationSchemestring required

The extended public key (xpub, ypub, zpub, etc.) representing the derivation scheme.

trackedSourcestring required

The tracked source identifier for the derivation scheme, formatted as 'DERIVATIONSCHEME:{derivationScheme}'.

derivationStrategystring required

The derivation strategy used, including any script type suffixes (e.g., '-[p2sh]').

networkstring required

The cryptocurrency network (e.g., 'BTC').

Example response

[
  {
    "derivationScheme": "tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C...",
    "trackedSource": "DERIVATIONSCHEME:tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C...",
    "derivationStrategy": "tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C...-[p2sh]",
    "network": "BTC",
    "metadata": {
      "label": "My Wallet",
      "createdAt": "2023-10-01T12:34:56Z"
    }
  }
]

Changes

Changed in 3 of the 40 revisions of this API.34

  • cfaf4efd4ea823See the full diff
    • the code response's property type/format changed from integer/ to string/ for status 404

      response-property-type-changed

    • removed the required property error from the response with the 404 status

      response-required-property-removed

    • added the optional property httpCode to the response with the 404 status

      response-optional-property-added

    • added the optional property message to the response with the 404 status

      response-optional-property-added

    • added the optional property reason to the response with the 404 status

      response-optional-property-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog