List HD Wallet (xPub, yPub, zPub) UTXOs

Through this endpoint you can list HD wallet's UTXOs (Unspent Transaction Outputs) by providing extended public key of an already synced HD wallet.

List of Results - This endpoint returns multiple objects which means pagination is applicable. GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/utxos

Path Parameters

  • Required
    blockchain string

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

    Example : bitcoin
    Possible Values : bitcoin bitcoin-cash litecoin dogecoin dash zcash
  • Required
    extendedPublicKey string

    Defines the account extended publicly known key which is used to derive all child public keys.

    Example : tpubDDCs6jf3Tg8VTts6EBCNpibVanPQpSkmYRLAXVvuhcuC6ZcbYtEizqERj8D4TBukuvjNSjtjEbKYdtFuRG5WuisrirZG9m5L8wUvf4bHhgQ
  • Required
    network string

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.

    Example : testnet
    Possible Values : mainnet testnet

Query parameters

  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : yourExampleString
  • Optional
    derivation string

    The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.

    Example : account
    Possible Values : account bip32
  • Optional
    limit integer

    Defines how many items should be returned in the response per page basis.

    Default : 50
    Example : 50
  • Optional
    offset integer

    The starting index of the response items, i.e. where the response should start listing the returned items.

    Default : 0
    Example : 0

Response schema

200 400 401 402 403 409 415 422 429 500
HTTP Status Code: 200
Content-Type: application/json

The request has been successful.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2021-03-20
  • Required
    requestId string

    Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

    Example : 601c1710034ed6d407996b30
  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : yourExampleString
  • Required
    data object
    • Required
      limit integer

      Defines how many items should be returned in the response per page basis.

      Example : 50
    • Required
      offset integer

      The starting index of the response items, i.e. where the response should start listing the returned items.

      Example : 0
    • Required
      total integer

      Defines the total number of items returned in the response.

      Example : 100
    • Required
      items array
      Example : Array ( )
      • Required
        address string

        Represents the public address, which is a compressed and shortened form of a public key.

        Example : muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB
      • Required
        addressPath string

        Defines a data which tells a Hierarchical Deterministic wallet how to derive a specific key within a tree of keys.

        Example : m/0/5
      • Required
        amount string

        Represents the UTXO amount value.

        Example : 0.0005
      • Required
        derivation string

        The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.

        Example : ACCOUNT
      • Required
        index integer

        Represents the output index. It refers to the UTXO sequence in the transaction outputs (vout).

        Example : 1
      • Required
        isAvailable boolean

        Represents if the UTXO has been used from another unconfirmed transaction. If it is - the value will be "false".

        Example : True
      • Required
        isConfirmed boolean

        Represents the state of the transaction whether it is confirmed or not confirmed.

        Example : True
      • Required
        referenceId string

        Represents the reference id of the record. It may be used for the startingAfter pagination attribute.

        Example : 5b1ea92e584bf50020130615
      • Required
        transactionId string

        Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.

        Example : 06af8234602b97f497496039a6eb99810db1287ce8aa3c501894dcd03bd4e544

Credits Cost : 5 Credits For 1 Result(s)

Try it out

Request Example

GET
https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/hd/tpubDDCs6jf3Tg8VTts6EBCNpibVanPQpSkmYRLAXVvuhcuC6ZcbYtEizqERj8D4TBukuvjNSjtjEbKYdtFuRG5WuisrirZG9m5L8wUvf4bHhgQ/utxos?context=yourExampleString&derivation=account&limit=50&offset=0
Headers
Content-Type: application/json
X-API-Key: my-api-key

Response Example

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "address": "muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB",
                "addressPath": "m/0/5",
                "amount": "0.0005",
                "derivation": "ACCOUNT",
                "index": 1,
                "isAvailable": true,
                "isConfirmed": true,
                "referenceId": "5b1ea92e584bf50020130615",
                "transactionId": "06af8234602b97f497496039a6eb99810db1287ce8aa3c501894dcd03bd4e544"
            }
        ]
    }
}