Skip to content
Longport WhaleLongport Whale
Stock Group

Add Risk Stock Group

Create a stock-group configuration that gathers a set of stocks for a given application scenario.

Request parameters

  • Required: name (stock-group name), application (application scenario).
  • Optional: remark.
  • See the individual field descriptions for each field's format, allowed values, and business meaning.

Business notes

application determines which risk-control or business scenarios the stock group applies to.

Result

On success, the stock group is created; the resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/risk/stock_group

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

namestringrequired

This field is required.

applicationstringrequired

Application scenario for the stock group.

Allowed values: 1 Simulate Margin Call, 2 Report, 3 Margin Call, 4 Concentration Limit, 5 Option Short Selling Whitelist

Values
1
Simulate Margin Call
2
Report
3
Margin Call
4
Concentration Limit
5
Option Short Selling Whitelist
remarkstring

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

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