Skip to content
Tradable Quantity and Margin

Get Buying Power for Order Entry

Retrieves the maximum buying power of the current account for a security when the order page loads or the user switches accounts or settlement currencies, to show the amount available to buy and to validate the order amount. For a market order (including an untriggered market conditional order), available buying power equals buy_limit multiplied by channel_infos.mo_avail_ratio from Get Order Configuration. When amending an order, pass the original order ID; omit order_id when the order being amended is an untriggered conditional order. When you call this endpoint through WhaleCore requestService(), set requiresTradeToken to true.

GEThttps://api.lbkrs.com/v1/app/risk/account_info/purchase

Parameters

counter_idstringqueryRequired

Security ID (counter_id), for example ST/US/AAPL or ST/HK/700

currencystringqueryRequired

Trading (settlement) currency, for example USD or HKD. Use the first item of channel_infos.settlement_currency returned by Get Order Configuration.

account_channelstringqueryRequired

Broker channel

order_idstringquery

Original order ID when amending an order. Omit it for a new order or when amending an untriggered conditional order.

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Buying Power for Order Entry” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
buy_limitstring

Maximum buying power

Whale Docs