Account Balance
Interface Description
Function description: Query account assets according to account id.
Applicable objects: Customers who integrate into Webull through Webull OpenAPI.
Request URL: /account/balance
Request method: GET
Frequency limit: The calling frequency of each App ID is limited to 10 times in 30 seconds.
Request Parameters
Parameter | Type | Required fields | Description | Example value |
---|---|---|---|---|
account_id | String | Yes | Account ID | 20150320010101001 |
total_asset_currency | String | No | Currency, USD only | USD |
Response Parameter
Parameter | Type | Description | Example value |
---|---|---|---|
account_id | String | Account ID | 13467788 |
total_asset_currency | String | Currency, USD only | USD |
total_asset | String | The total assets of the account: the currency refers to the value of the total_asset_currency field. total_market_value=sum(positions_market_value*exchange rate) | 1247724759.52 |
total_market_value | String | The total market value: the currency refers to the value of the total_asset_currency field. total_asset=sum(net_liquidation_value*exchange rate) | 89038914.52 |
total_cash_balance | String | The total amount of cash: the currency refers to the value of the total_asset_currency field.total_cash_balance=sum(cash_balance*exchange rate) | 1158685845.00 |
margin_utilization_rate | String | Financing utilization: percentage.Parameters reserved. | 1.00 |
account_currency_assets | []Account_Currency_Asset | Account Asset List |
The above exchange rate = the exchange rate at which the currency in Account_Currency_Asset is converted to total_asset_currency.
Account_Currency_Asset
Parameter | Type | Description | Example value |
---|---|---|---|
currency | String | Currency. | USD |
net_liquidation_value | String | Net assets. | 458809435.44 |
positions_market_value | String | The market value of the position. | 153208546.14 |
cash_balance | String | Cash balance. | 305600889.30 |
margin_power | String | Financing buying power. | 305587431.94 |
cash_power | String | The buying power of the cash account. | 305587431.94 |
pending_incoming | String | In-transit funds. | 0.00 |
cash_frozen | String | Frozen funds. | 13457.36 |
available_withdrawal | String | The withdrawable amount. | 305587431.94 |
interests_unpaid | String | Interest to be paid. | 0.00 |
Request Example
- Python
- Java
from webullsdktrade.api import API
from webullsdkcore.client import ApiClient
from webullsdkcore.common.region import Region
from webullsdktrade.common.currency import Currency
api_client = ApiClient(your_app_key, your_app_secret, Region.US.value)
api = API(api_client)
response = api.account.get_account_balance(account_id, Currency.USD.name)
if response.status_code == 200:
account_balance = response.json()
HttpApiConfig apiConfig = HttpApiConfig.builder()
.appKey(Env.APP_KEY)
.appSecret(Env.APP_SECRET)
.regionId(Region.us.name())
.build();
TradeApiService apiService = new TradeHttpApiService(apiConfig);
AccountBalance accountBalance = apiService.getAccountBalance(accountId, currency);
Response Example
{
"account_id":"6TGIBSMG28Q35OVA465T99VHPB",
"total_asset_currency":"USD",
"total_market_value":"0.00",
"margin_utilization_rate":"2.00",
"account_currency_assets":[
{
"currency":"USD",
"netAsset":"400000000.00",
"marketValue":"0.00",
"cashBalance":"400000000.00",
"marginPower":"1599995029.60",
"cashPower":"4799985859.00",
"cashInTransit":"0.00",
"cashFrozen":"485.10",
"cashWithdraw":"-2485.20",
"interestsUnpaid":"0.00"
}
]
}
Exception Example
{
"error_code": "INVALID_TOKEN",
"message": "401 UNAUTHORIZED \"app_id and account_id not related\""
}