Query Company Capital

Query the current company-level capital configuration and return the currency, shareholder fund, and shareholder capital adjustment amount for read-only display on the Capital Setups page.

Request parameters

No request parameters. Send a GET request as the currently authenticated account; the server returns the capital configuration for the company that the caller belongs to.

Result

On success, data contains the company's current capital configuration. See the 200 response fields for the meaning of each field. Changes to the capital configuration are made through POST /risk/v1/cp_capital_adjust/modify (Modify Company Capital).

GEThttps://b-api.longbridge.xyz/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.

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

Request

curl --request GET \
  --url 'https://b-api.longbridge.xyz/risk/v1/company_capital/query' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "credit_currency": "USD",
    "shareholder_fund": "1000000",
    "shareholder_amount": "500000"
  }
}