Skip to content
Longport WhaleLongport Whale
Capital Setups

Query Company Capital

Returns the current company-level capital configuration, including currency, shareholder funds, and the shareholder capital adjustment amount.

Request parameters

  • This endpoint has no required parameters. Issue the GET request as the current account; the server returns the capital configuration for the caller's company.

Business notes

The capital configuration is read-only company-level information. It is modified through POST /risk/v1/cp_capital_adjust/modify (modify company capital).

Returns

On success the company's current capital configuration is returned in data. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/risk/v1/company_capital/query

Authorization

AuthorizationstringheaderRequired

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

Responses

HTTP 200The request was processed successfully. data contains the current company capital configuration.
Standard response envelopecodemessagedata
dataobjectdata structure

Current company capital configuration.

credit_currencystring

Currency of the capital configuration, for example USD or HKD. When modifying capital this field is not editable; the currency returned here is reused as-is.

shareholder_fundstring

Shareholder fund amount, denominated in credit_currency. Returned as a numeric string; may be 0 when not configured.

shareholder_amountstring

Shareholder capital adjustment amount, denominated in credit_currency. Returned as a numeric string; may be 0 when not configured.

ffr_fundstring

ffr_fund amount, denominated in credit_currency. Returned as a numeric string; may be 0 when not configured.

sfc_sub_ordinatedstring

SFC subordinated capital amount, denominated in credit_currency. Returned as a numeric string; may be 0 when not configured.

tmlcrstring

tmlcr configured value. Returned as a numeric string; may be 0 when not configured.

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