List HD Wallet (xPub, yPub, zPub) Transactions

This endpoint will list HD Wallet transactions.

GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/transactions

Path Parameters

  • Required
    blockchain string

    Represents the specific blockchain.

    Example : bitcoin
  • Required
    extendedPublicKey string

    Defines the master public key (xPub) of the account.

    Example : tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w
  • Required
    network string

    Represents the specific network.

    Example : testnet

Query parameters

  • 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.

    Default : ACCOUNT
    Example : BIP32
    Possible Values : ACCOUNT BIP32
  • Optional
    limit integer

    Number of items limit

    Default : 50
    Example : 50
  • Optional
    offset integer

    Number of skipped items

    Default : 0
    Example : 10

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 : 2.0
  • 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 : You can add any text here
  • Required
    data object
    • Required
      offset integer

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

      Example : 0
    • Required
      limit integer

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

      Example : 50
    • Required
      total integer

      Defines the total number of items returned in the response.

      Example : 100
    • Required
      items array
      Example : Array ( )
      • Required
        index integer

        Represents the index position of the transaction in the block.

        Example : 1
      • Required
        minedInBlockHash string

        Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.

        Example : 00000000407f119ecb74b44229228910400aaeb9f4e3b9869955b85a53e9b7db
      • Required
        minedInBlockHeight integer

        Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.

        Example : 1903849
      • Required
        recipients array

        Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.

        • Required
          address string

          The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.

          Example : 2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV
        • Required
          amount string

          Represents the amount received to this address.

          Example : 0.000144
      • Required
        senders array

        Represents a list of sender addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.

        • Required
          address string

          Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.

          Example : 2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1
        • Required
          amount string

          Represents the amount sent by this address.

          Example : 0.00873472
      • Required
        timestamp integer

        Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.

        Example : 1582202940
      • Required
        transactionHash string

        Represents the same as transactionId for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols hash is different from transactionId for SegWit transactions.

        Example : 1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2
      • 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 : 4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250
      • Required
        fee object
        • Required
          amount string

          Defines the amount of the transaction fee.

          Example : 0.00016932
Try it out

Request Example

GET
https://rest.cryptoapis.io/v2/blockchain-data/bitcoin/testnet/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/transactions?derivation=BIP32&limit=50&offset=10
Headers
Host: https://rest.cryptoapis.io/v2
Content-Type: application/json
X-API-Key: my-api-key

Response Example

{
    "apiVersion": "2.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "You can add any text here",
    "data": {
        "offset": 0,
        "limit": 50,
        "total": 100,
        "items": [
            {
                "index": 1,
                "minedInBlockHash": "00000000407f119ecb74b44229228910400aaeb9f4e3b9869955b85a53e9b7db",
                "minedInBlockHeight": 1903849,
                "recipients": [
                    {
                        "address": "2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV",
                        "amount": "0.000144"
                    }
                ],
                "senders": [
                    {
                        "address": "2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1",
                        "amount": "0.00873472"
                    }
                ],
                "timestamp": 1582202940,
                "transactionHash": "1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2",
                "transactionId": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250",
                "fee": {
                    "amount": "0.00016932"
                }
            }
        ]
    }
}