Account Balance
Interface Description
Function description: Query account assets according to account id.
Applicable objects: Customers who connect to Webull through the OpenApi development platform.
Request URL: /account/balance
Request method: GET
Frequency limit: The calling frequency of each AppId is limited to 2 times in 2 seconds.
Request parameters
Parameter | Type | Required fields | Description | Example value |
---|---|---|---|---|
account_id | String | Yes | Account ID | 863417315629211648 |
Response parameter
Parameter | Type | Description | Example value |
---|---|---|---|
account_id | String | Account ID | 863417315629211648 |
total_asset_currency | String | Currency, USD only. For margin account only. | USD = |
total_market_value | String | The total market value of holding positions in margin account, which is same as the amount of ledger; the currency refers to the value of the total_asset_currency field. For margin account only. | 2006.00 |
margin_utilization_rate | String | Margin ratio, which is calculated by the value of positions and cash that are used as collateral, divided by the amount of ledger. For margin account only. | 495.4124 |
total_collateral_value | String | The total collateral value of collateralized positions and cash in margin account; the currency refers to the value of the total_asset_currency field. For margin account only. | 1000000.00 |
oneDayMarginPower | String | The buying power for intraday margin trading. For margin account only. | 97962.90 |
infiniteMarginPower | String | The buying power for regular margin trading. For margin account only. | 1000000.00 |
account_currency_assets | []Account_Asset | Account Asset List | Reference sample code |
The above exchange rate = the exchange rate at which the currency in Account_Currency_Asset is converted to total_asset_currency.
Account_Asset
Parameter | Type | Description | Example value |
---|---|---|---|
currency | String | Currency | USD |
positions_market_value | String | The market value of the collateralized positions. For margin account only. | 3538.00 |
total_collateral_value | String | Total collateral value (in different currencies); the currency refers to the value of the currency field.For margin account only. | 1000000.00 |
balance | String | The amount of collateralized cash in the margin account. For margin account only. | 1000000.00 |
total_cash | String | The total cash balance of this account, including settled and unsettled cash. | 1000000.00 |
unsettled_cash | String | The cash balance that has been reflected in the account but not settled yet. | 1000000.00 |
settled_cash | String | The cash balance that has been settled in the account. | 1000000.00 |
frozen_cash | String | The amount that is frozen from the cash balance due to pending orders, accrued fees and others. | 1000000.00 |
available_to_withdraw | String | The available amount that can be withdrawn from the brokerage account. | 1000000.00 |
available_to_exchange | String | The available amount that can be exchanged to other currency. | 1000000.00 |
stock_power | String | The cash buying power available for buying stocks and other equities in regular and extended hours. | 1000000.00 |
overnight_power | String | The cash buying power available for buying stocks and other equities in US overnight hours. | 1000000.00 |
Request example
- Python
- Java
from webullsdktrade.api import API
from webullsdkcore.client import ApiClient
from webullsdkcore.common.region import Region
api_client = ApiClient(your_app_key, your_app_secret, Region.JP.value)
api = API(api_client)
response = api.account.get_account_balance(account_id,currency)
if response.status_code == 200:
account_balance = response.json()
HttpApiConfig apiConfig = HttpApiConfig.builder()
.appKey(Env.APP_KEY)
.appSecret(Env.APP_SECRET)
.regionId(Region.jp.name())
.build();
TradeApiService apiService = new TradeHttpApiService(apiConfig);
BalanceBase accountBalance = apiService.getAccountBalance(accountId, currency);
Response example
Cash Account
Margin Account