Query Account Withdrawable Balance by Currency

GEThttps://api.lbkrs.com/v1/rms_gateway/get_account_all_single_currency_withdraw

Parameters

aaidstringqueryRequired

Account aaid

currencystringquery

Filter by currency; if omitted, returns all currencies under the account

business_typeintegerquery

Business scenario: 0 All All scenarios, 1 QuickWithdraw Quick withdrawal, 2 Ipo IPO subscription, 3 Exchange Currency exchange, 4 OmnibusTransfer Omnibus transfer

01234

include_mmf_positionbooleanquery

Whether to include money market fund (MMF) holdings when calculating the withdrawable amount

Responses

HTTP 200The request succeeded. The response body contains the result of the “Query account withdrawable balance by currency” operation.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>

Balance list by currency

Child attributes

currencystring

Currency

withdrawstring

Maximum withdrawable amount (including MMF advance)

cash_withdrawstring

Cash-withdrawable amount

account_mmf_quotastring

MMF advance quota

origin_cash_withdrawstring

Cash-withdrawable amount (raw value, not floored at zero)

out_standing_frozenstring

Pending-settlement frozen amount

execution_buy_balancestring

Total amount of pending long buy orders

mmf_valuestring

MMF market value

total_available_cashstring

Total available cash in the account (not affected by the currency parameter filter)

HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.

codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Request

let request = WhaleCoreHTTPRequest(
    method: .get,
    path: "/v1/rms_gateway/get_account_all_single_currency_withdraw"
)
request.query = [
    "aaid": "<AAID>"
]

let response = try await WhaleCoreService.requestService.send(request)
print(response.bodyString)

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "withdraw": "99893.31",
        "currency": "HKD",
        "cash_withdraw": "0",
        "account_mmf_quota": "0",
        "origin_cash_withdraw": "0",
        "out_standing_frozen": "0",
        "execution_buy_balance": "0",
        "mmf_value": "99893.31"
      }
    ],
    "total_available_cash": "99893.31"
  }
}