Get HD Wallet (xPub, yPub, zPub) Details

HD wallet details is useful endpoint to get the most important data about HD wallet without the need to do a lot of calculations, once the HD Wallet is synced using Sync endpoint we keep it up to date and we calculate these details in advance.

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

Path Parameters

  • Required
    blockchain string

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

    Example : bitcoin
  • Required
    extendedPublicKey string

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

    Example : upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ
  • 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", "rinkeby" are test networks.

    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

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
      item object
      • Required
        confirmedBalance string

        Specifies the confirmed coins balance of the Wallet.

        Example : 0.0021
      • Required
        totalReceived string

        Defines the total currency received to the Wallet.

        Example : 0.0002
      • Required
        totalSpent string

        Defines the total currency spent from the Wallet.

        Example : 0.0001
Try it out

Request Example

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": {
        "item": {
            "confirmedBalance": "0.0021",
            "totalReceived": "0.0002",
            "totalSpent": "0.0001"