Get HD Wallet (xPub, yPub, zPub) Assets

This endpoint will return details on assets we support for a specified from the customer extended public key (xPub). These could be cryptocurrencies, fungible or non-fungible (NFT) tokens. Each asset has a unique identifier - assetId, and a unique symbol in the form of a string, e.g. "USDT".

Single Result - This endpoint returns only one single result. GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/assets

Path Parameters

  • Required
    blockchain string

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

    Example : ethereum
    Possible Values : bitcoin bitcoin-cash litecoin dogecoin dash ethereum zcash ethereum-classic binance-smart-chain xrp
  • Required
    extendedPublicKey string

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

    Example : xpub68SyZPMPpZUy9QB2fk2J28b5Rwd6jeWKind3K8oziZuVcL7wWZiXZNCPKuh42ejSpTLYngQ9Gbzj9a1Ap2QQmoFs2sMSbUvkEr8D3GW7MrR
  • 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 : ropsten
    Possible Values : mainnet testnet ropsten mordor

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

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
      item object
      • Optional
        fungibleTokens array

        Represents fungible tokens'es detailed information

        • Required
          amount string

          Defines the amount of the fungible tokens.

          Example : 0.100000000000000000
        • Required
          identifier string

          Represents tokens' contract address.

          Example : 0x101848d5c5bbca18e6b4431eedf6b95e9adf82fa
        • Required
          symbol string

          Defines the symbol of the fungible token.

          Example : WEENUS
        • Required
          type string

          Defines the specific token type.

          Example : ERC-20
      • Optional
        nonFungibleTokens array

        Represents non-fungible tokens'es detailed information.

        • Required
          identifier string

          Represents tokens' contract address.

          Example : 0x90ca8a3eb2574f937f514749ce619fdcca187d45
        • Required
          symbol string

          Defines the symbol of the non-fungible token.

          Example : GA
        • Required
          tokenId string

          Represents tokens' unique identifier.

          Example : 0x000000000000000000000000000000000000000000000000000000000000195b
        • Required
          type string

          Defines the specific token type.

          Example : ERC-721
      • Required
        confirmedBalance object
        • Required
          amount string

          Represents the confirmed balance for the specified blockchain protocol.

          Example : 0.008516447598774679
        • Required
          unit string

          Specifies the unit of the amount of the confirmed balance.

          Example : ETH

Credits Cost : 25 Credits For 1 Result(s)

Try it out

Request Example

GET
https://rest.cryptoapis.io/blockchain-data/ethereum/ropsten/hd/xpub68SyZPMPpZUy9QB2fk2J28b5Rwd6jeWKind3K8oziZuVcL7wWZiXZNCPKuh42ejSpTLYngQ9Gbzj9a1Ap2QQmoFs2sMSbUvkEr8D3GW7MrR/assets?context=yourExampleString&derivation=account
Headers
Content-Type: application/json
X-API-Key: my-api-key

Response Example

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "fungibleTokens": [
                {
                    "amount": "0.100000000000000000",
                    "identifier": "0x101848d5c5bbca18e6b4431eedf6b95e9adf82fa",
                    "symbol": "WEENUS",
                    "type": "ERC-20"
                }
            ],
            "nonFungibleTokens": [
                {
                    "identifier": "0x90ca8a3eb2574f937f514749ce619fdcca187d45",
                    "symbol": "GA",
                    "tokenId": "0x000000000000000000000000000000000000000000000000000000000000195b",
                    "type": "ERC-721"
                }
            ],
            "confirmedBalance": {
                "amount": "0.008516447598774679",
                "unit": "ETH"
            }
        }
    }
}