Ceffu OpenAPI Documentation Platform
  1. Sub-Wallet Management
Ceffu OpenAPI Documentation Platform
  • Changes
    • Upcoming Changes
    • Change log
  • Development Tools and Resource
    • Overview
      • Welcome to Ceffu OpenAPI
    • Quickstart
      • Initial Setup
      • Using the Ceffu SDK
    • Authentication
    • Rate limit
    • Error Codes
    • Webhook Introduction
  • Concepts
    • Ceffu Custody
    • API Use Case
  • System Endpoints
    • Get System status
  • Wallet Management
    • Ceffu Supported Asset Endpoint
      • Get Prime Wallet supported coins list
      • Get Qualified Wallet supported coins list
      • Get Cosign Wallet supported coins list
    • Qualified Wallets and Prime Wallets Endpoint
      • Create Wallet
      • Update Wallet Details
      • Get Wallet List
      • Get Asset Details
      • Get Wallet Asset Summary
    • Deposits
      • Get Deposit Address
      • Get Deposit History
      • Get Deposit Details
    • Withdrawals
      • Withdrawal
      • Get Withdrawal Fee (estimated)
      • Get Withdrawal History
      • Get Withdrawal Details
    • Whitelisted Addresses
      • Get Whitelisted Address List
      • Get Correspondent’s Options
      • Add/Edit Whitelisted Address
    • Transactions
      • Transaction History List
  • PW Sub Wallets
    • Sub-Wallet Management
      • Create Sub-Wallet
        POST
      • Update Sub-Wallet Details
        POST
      • Get Sub-Wallet List
        GET
      • Get Sub-Wallet Asset Details
        GET
      • Get Sub-Wallet Asset Summary
        GET
    • Sub-Wallet Deposits
      • Get Sub-Wallet Deposit Address
      • Get Deposit Address List under Prime Wallet
      • Get Deposit History under Sub-Wallet
      • Get Sub-Wallet Deposit History By Prime Wallet
    • Internal Transfers
      • Transfer between Sub Wallet and Prime Wallet
      • Get Transfer History between Sub-Wallet and Prime Wallet
    • Transactions
      • Get Transaction Details of Prime Wallet Internal Transfer
  • MirrorX
    • Link & Account
      • Get MirrorX LinkId List
    • Balances & Positions
      • Check MirrorX Available amount
      • Get MirrorX Asset Positions
    • Orders
      • Get MirrorX Orders
      • Place MirrorX Orders
  • Webhooks & Notifications
    • Resend webhook notifications
  • Archive
    • Mirror Endpoints
      • Get Mirror Linked Binance UID List
      • MIrror Assets Application
      • MIrror Assets Settlement
      • Get Mirror Operation Records
      • Get Mirrored Asset Positions
      • Get Mirrored Asset Summary
    • Wallet Endpoints
      • Get Transfer Detail with Exchange
      • Get Transfer History with Exchange
      • Transfer with Exchange
      • Get Withdrawal History
      • Get Withdrawal Details
      • Withdrawal
      • Get Sub-Wallet List (V1)
  1. Sub-Wallet Management

Get Sub-Wallet Asset Summary

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

This method retrieves the BTC-equivalent asset summary for the specified wallet ID, including Prime and Sub Wallets. Values are for reference only, based on internal calculations. For a parent Prime Wallet ID, total and locked amounts include all sub-wallets. For a Sub Wallet ID, amounts reflect only that sub-wallet. To get the summary for a parent Prime Wallet, use the ‘Get Wallet Asset Summary’ endpoint.

API Key permission group : Enable Enquiry

Designated Wallet : Allow to set a designated wallet.

Notes: Prime walletId or Sub walletId is required.

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/open-api/v1/subwallet/asset/summary?walletIdStr=12936129221&timestamp=1640995200000' \
--header 'open-apikey;' \
--header 'signature;'

Responses

🟢200The operation succeeded
application/json
Body

Example
{
    "data": {
        "walletIdStr": "370387791055810560",
        "totalAmountInBTC": "10.000000000000000000",
        "totalAmountInUSD": "642319.5590337927000000000000000000000",
        "lockedAmountInBTC": "0",
        "data": [
            {
                "walletIdStr": "370388040948248576",
                "subTotalAmountInBTC": "10.000000000000000000",
                "subTotalAmountInUSD": "642319.5590337927000000000000000000000"
            }
        ]
    },
    "code": "000000",
    "message": "Success"
}
Previous
Get Sub-Wallet Asset Details
Next
Get Sub-Wallet Deposit Address