Get Sub-Wallet Asset Summary

GET/open-api/v1/subwallet/asset/summary

This method allows you to retrieves the asset summary in BTC equivalent value under the specified walletId including Prime and Sub Wallets. Please note that this equivalent value is provided for reference only and is based on our internal calculation.
When a parent prime wallet ID is passed as a parameter, the values of the total amount and locked amount represent the sum of all sub-wallets under the given parent prime wallet.
When a sub-wallet ID is passed as a parameter, the values of the total amount and locked amount represent the given sub-wallet.
To get the asset summary for a parent prime wallet, use the "Get Wallet Asset Summary" endpoint instead.

API Key permission group : Enable Enquiry

Notes: Prime walletId or Sub walletId is required.

Request

Query Params

walletIdStr

string

required

Prime Wallet id / Sub Wallet id in string format

Example:

12936129221

timestamp

integer

required

Current timestamp in millisecond

Example:

1640995200000

Header Params

open-apikey

string

required

OpenAPI key string

signature

string

required

Signature of the request

Request samples

Responses

The operation succeeded(200)

The operation succeeded

HTTP Code: 200

Content Type : JSONapplication/json

data

optional

response data, maybe null

Any of

TotalAsset

null

walletIdStr

string

required

totalAmountInBTC

string

required

total asset balance in BTC equivalent value under the specified walletID

totalAmountInUSD

string

required

total asset balance in USD equivalent value under the specified walletID

lockedAmountInBTC

string | null

optional

locked asset balance in BTC equivalent value

data

array [object {3}] | null

optional

code

string

required

'000000' indicates success, while any others indicate failure.

message

string

required

When the code is '000000' (success), it represents the details of the response. Otherwise, it represents the details of the error.

{
  "data": {
    "walletIdStr": "370387791055810560",
    "totalAmountInBTC": "10.000000000000000000",
    "totalAmountInUSD": "642319.5590337927000000000000000000000",
    "lockedAmountInBTC": "0",
    "data": [
      {
        "walletIdStr": "370388040948248576",
        "subTotalAmountInBTC": "10.000000000000000000",
        "subTotalAmountInUSD": "642319.5590337927000000000000000000000"
      }
    ]
  },
  "code": "000000",
  "message": "Success"
}

Last modified: 8 months ago