post https://trade-hk.oslsandbox.com/api/3/settlement/accounts
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 )
| Field | Description | Type | Example |
|---|---|---|---|
| userUUID | A unique identifier assigned to each user of the digital asset trading platform | String | 29ffc2ce-9936-4f9b-9b56-c1e1d22906e1 |
| accountUUID | A unique identifier assigned to each account in the platform | String | 0d0be8d3-f8f7-48c6-9c79-4b9493c821a1 |
| Account Group UUID | A unique identifier assigned to each group of accounts | String | 29ffc2ce-9936-4f9b-9b56-c1e1d22906e1 |
| Account Group | A label or name given to a group of accounts | String | Default |
| User | The name or username associated with a userUUID | String | [email protected] |
| The email address associated with a userUUID | String | [email protected] | |
| mainType | A broad category that the account belongs to, such as "Individual" or "Corporate" | String | Client |
| subMainType | A more specific category that the account belongs to, such as "Retail" or "Institutional" | String | Trading account |
| Ccy | The currency associated with the account | String | BTC |
| Account in Ledger | Is the account included in the ledger (should always be TRUE) | Boolean | TRUE |
| System Account | Is the account a system account (should always be FALSE) | Boolean | FALSE |
| Total | The total balance of the account, including all types of funding | Numeric | 5.77 |
| Total Prefunding | The total balance of the account, including only assets that have been funded | Numeric | 5.77 |
| Available | The balance of the account that is available for trading or withdrawal | Numeric | 5.00 |
| Brokerage | The fees charged by the trading platform for executing trades | Numeric | 0.37 |
| Hold | The amount of the account balance that is being held for a pending transaction | Numeric | 0 |
| Suspense | An account balance that is held temporarily for investigation or verification purposes | Numeric | 0 |
| Order | No longer in use. Will be removed in later version. | Numeric | 0 |
| Trade Ahead | A balance that represents the amount of assets that are being used to cover an open position | Numeric | 0 |
| Pending Withdrawal | The amount of assets that have been requested for withdrawal but have not yet been processed | Numeric | 0 |
| Exchange | The amount of assets that are currently being used for trading | Numeric | 0 |
| Leverage | No longer in use. Will be removed in later version. | Numeric | 0 |
| Collateral | The amount of assets being used as collateral for a margin position | Numeric | 0 |
| Unsettle Buy | The amount of assets that have been purchased but have not yet settled in the capacity of a DVP trade (can be: RFQ, E-Trade or OTC) | Numeric | 0 |
| Unsettle Sell | The amount of assets that have been sold but have not yet settled in the capacity of a DVP trade (can be: RFQ, E-Trade or OTC) | Numeric | 0 |
| Unprocessed Deposit | The amount of assets that have been deposited but have not yet been processed | Numeric | 0 |
| Unprocessed Withdrawal | The amount of assets that have been requested for withdrawal but have not yet been processed | Numeric | 0 |
| Margin | No longer in use. Will be removed in later version. | Numeric | 0 |
| Margin Long | No longer in use. Will be removed in later version. | Numeric | 0 |
| Margin Short | No longer in use. Will be removed in later version. | Numeric | 0 |
| Margin Interest | No longer in use. Will be removed in later version. | Numeric | 0 |
| Unconfirmed | The amount of assets that are part of an unconfirmed transaction | Numeric | 0 |
| custody | A balance that represents the amount of assets held in custody for a user | Numeric | 0 |