Stock Group Configuration

GEThttps://b-api.longbridge.xyz/v1/datasets/instrument_stock_groups

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

namestring

Filters results by Stock Group Name.

idstring

Filters results by Stock Group.

Values are dynamic. Call GET /v1/datasets/refs/stock_groups to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Stock Group Configuration records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

namestring

Returned value: Stock Group Name.

applicationstring

Returned value: Application Scenarios.

application_valstring

Raw value of application. The application field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

stock_countstring

Returned value: Stock Count.

remarkstring

Returned value: Remarks.

updated_atstring

Returned value: Update Time. The date or time format follows the value returned by the API.

last_operatorstring

Returned value: Last Operator.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/instrument_stock_groups' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "12502",
        "name": "裸卖空",
        "application": "Option Short Selling Whitelist",
        "application_val": "5",
        "stock_count": "1",
        "remark": "",
        "updated_at": "1784014380",
        "last_operator": "user@example.com"
      }
    ],
    "total": 38
  }
}

Export

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

POSThttps://b-api.longbridge.xyz/v1/datasets/instrument_stock_groups/download

Export options Export records Download result