Ceffu OpenAPI Documentation Platform
  • ChangeLog
  • Getting Started
  • System Endpoints
  • Wallet Endpoints
    • Get Prime Wallet supported coins listGET
    • Get Qualified Wallet supported coins listGET
    • Get Cosign Wallet supported coins listGET
    • Get Wallet ListGET
    • Get Asset DetailsGET
    • Get Wallet Asset SummaryGET
    • Get Deposit AddressGET
    • Get Deposit HistoryGET
    • Get Deposit Detail (V2)GET
    • Get Withdrawal Fee (estimated)GET
    • Get Withdrawal History (V2)GET
    • Get Withdrawal Details (V2)GET
    • Create WalletPOST
    • Update Wallet DetailsPOST
    • Withdrawal (V2)POST
    • Transaction History ListPOST
  • Sub-Wallet Endpoints
  • MirrorX Endpoints
  • Webhook
  • Archive
logoPowered by Apifox
  1. Wallet Endpoints

Get Wallet Asset Summary

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

This method allows you to get the specified wallet's asset summary, represented in its equivalent BTC & USD value. Please note that this equivalent value is provided for reference only and is based on our internal calculation.

API Key permission group : Enable Enquiry

Request

Query Params
walletIdStr
string 
required

Wallet id

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 Schema
data
required

response data, maybe null

Any of
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.

Example
{
  "data": {
    "walletIdStr": "1557971669384941569",
    "totalAmountInBTC": "0.000005978220849196",
    "totalAmountInUSD": "0.3898858805969329844000000000000000000000000",
    "lockedAmountInBTC": null
  },
  "code": "000000",
  "message": "Success"
}
Last modified: 9 days ago