Get Settlement Client Balance Report

Get client's account balance report in CSV or JSON format.
The Client Balances report provides a detailed overview of the balances for a client account on the platform. This report is useful for both clients and the platform administrators, as it helps to monitor account activity, identify trends, and manage risk.

Sample Settlement Account Balance Report (CSV )

FieldDescriptionTypeExample
userUUIDA unique identifier assigned to each user of the digital asset trading platformString29ffc2ce-9936-4f9b-9b56-c1e1d22906e1
accountUUIDA unique identifier assigned to each account in the platformString0d0be8d3-f8f7-48c6-9c79-4b9493c821a1
Account Group UUIDA unique identifier assigned to each group of accountsString29ffc2ce-9936-4f9b-9b56-c1e1d22906e1
Account GroupA label or name given to a group of accountsStringDefault
UserThe name or username associated with a userUUIDString[email protected]
EmailThe email address associated with a userUUIDString[email protected]
mainTypeA broad category that the account belongs to, such as "Individual" or "Corporate"StringClient
subMainTypeA more specific category that the account belongs to, such as "Retail" or "Institutional"StringTrading account
CcyThe currency associated with the accountStringBTC
Account in LedgerIs the account included in the ledger (should always be TRUE)BooleanTRUE
System AccountIs the account a system account (should always be FALSE)BooleanFALSE
TotalThe total balance of the account, including all types of fundingNumeric5.77
Total PrefundingThe total balance of the account, including only assets that have been fundedNumeric5.77
AvailableThe balance of the account that is available for trading or withdrawalNumeric5.00
BrokerageThe fees charged by the trading platform for executing tradesNumeric0.37
HoldThe amount of the account balance that is being held for a pending transactionNumeric0
SuspenseAn account balance that is held temporarily for investigation or verification purposesNumeric0
OrderNo longer in use. Will be removed in later version.Numeric0
Trade AheadA balance that represents the amount of assets that are being used to cover an open positionNumeric0
Pending WithdrawalThe amount of assets that have been requested for withdrawal but have not yet been processedNumeric0
ExchangeThe amount of assets that are currently being used for tradingNumeric0
LeverageNo longer in use. Will be removed in later version.Numeric0
CollateralThe amount of assets being used as collateral for a margin positionNumeric0
Unsettle BuyThe amount of assets that have been purchased but have not yet settled in the capacity of a DVP trade (can be: RFQ, RFS or OTC)Numeric0
Unsettle SellThe amount of assets that have been sold but have not yet settled in the capacity of a DVP trade (can be: RFQ, RFS or OTC)Numeric0
Unprocessed DepositThe amount of assets that have been deposited but have not yet been processedNumeric0
Unprocessed WithdrawalThe amount of assets that have been requested for withdrawal but have not yet been processedNumeric0
MarginNo longer in use. Will be removed in later version.Numeric0
Margin LongNo longer in use. Will be removed in later version.Numeric0
Margin ShortNo longer in use. Will be removed in later version.Numeric0
Margin InterestNo longer in use. Will be removed in later version.Numeric0
UnconfirmedThe amount of assets that are part of an unconfirmed transactionNumeric0
custodyA balance that represents the amount of assets held in custody for a userNumeric0
Language
Authorization
Click Try It! to start a request and see the response here!