Skip to content
Longport WhaleLongport Whale
Company Limit Setting

Query Financing Summary V2

Query the financing and trading-limit overview for the current company (tenant).

Request parameters

  • This endpoint has no required parameters. The primary credit currency and aggregation basis are determined by the server according to the currently signed-in tenant and account permissions.

Returns

On success, data returns the company-level primary credit currency, total financing limit, and total trading limit together with their used, remaining, and warning thresholds, plus per-currency financing detail in cp_finance_info_list, and per-currency limit detail for margin financing (normal_margin_list) and intraday trading (intraday_margin_list). See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/risk/v1/credit_amount_summary/query_v2

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_credit_limit.lb_credit_limit

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Responses

HTTP 200The request was processed successfully. data contains the company's financing/trading limit summary.
Standard response envelopecodemessagedata
dataobjectdata structure

Company financing/trading limit summary. All cp_total_* aggregate amounts are denominated in the credit_currency currency. Amount fields are integer or decimal strings.

credit_currencystring

Credit currency, such as HKD or USD. All cp_total_* aggregate amounts are denominated in this currency.

cp_total_financestring

Company total financing limit (in the credit currency).

account_finance_totalstring

Total approved financing limit at the account level (in the credit currency).

cp_total_finance_usedstring

Company financing limit used (in the credit currency).

cp_total_finance_used_warningstring

Alert threshold for the company's approved financing limit (in the credit currency).

cp_total_finance_remainedstring

Company remaining available financing limit (in the credit currency).

cp_total_trading_limitstring

Company total trading limit (in the credit currency).

cp_total_trading_limit_reviewedstring

Currently approved trading limit (in the credit currency).

cp_total_trading_limit_reviewed_warningstring

Alert threshold for the approved trading limit (in the credit currency).

cp_total_trading_limit_usedstring

Trading limit used (in the credit currency).

cp_total_trading_limit_used_warningstring

Alert threshold for the trading limit used (in the credit currency).

cp_finance_info_listobject

Per-currency financing information. Each key is a currency code (such as HKD or USD); the value is that currency's financing summary object.

normal_margin_listobject

Per-currency limit breakdown under normal margin. Each key is a currency code; the value is that currency's detail object.

intraday_margin_listobject

Per-currency limit breakdown under intraday margin. The structure is identical to normal_margin_list.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs