Stock Group Details

Query the stock-group details.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Lists the stocks contained in a stock group — security code, name, market, add date and operator; used to view a group's constituents.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

POSThttps://b-api.lbkrs.com/v1/datasets/stock_group_details

Authorization

AuthorizationstringheaderRequired

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

Permission

risk_config.stock_group_details_query

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

Request body application/json

filtersobject

Child attributes

counter_idstring

Filters results by Stock code.

Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

pageinteger

page_sizeinteger

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

counter_idstring

Stock code. Returned value: Counter ID formatted {type}/{market}/{code} (display value; the raw code is in the matching _val field).

counter_id_valstring

Raw value behind field counter_id: counter_id returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

stock_namestring

Stock name. Returned value: Stock name.

marketstring

Market. Returned value: Market (display value; the raw code is in the matching _val field).

market_valstring

Raw value behind field market: market returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

stock_countstring

No. of stocks. Returned value: Number of stocks in the stock group.

updated_atstring

Updated at. Returned value: Unix timestamp in seconds, returned as a string.

operatorstring

Updated by. Returned value: Back-office account that last updated the record.

totalintegerrequired

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 POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/stock_group_details' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "counter_id": "1000000001",
        "counter_id_val": "1",
        "stock_name": "Apple Inc.",
        "market": "US",
        "market_val": "US",
        "stock_count": "1200",
        "updated_at": "1789713827",
        "operator": "admin"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/stock_group_details/download

risk_config.stock_group_details_export

Export options Export records Download result