Bizcode Query

Query the business-code definition list, used to maintain cash/fund detail business codes together with their multilingual names and client-display configuration.

Request parameters

Combine business filters through filters (optional fields are described under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data source is the business-code configuration, with one record per business code.
Each record identifies the business code, asset type, business name (multilingual: Simplified Chinese, Traditional Chinese, English), client-display flag, and remark.
Records also include creation time, update time, and operator, so a code's definition and maintenance can be verified.

Returns

On success, returns the list of matching records together with pagination information. See the response definition for the meaning of each column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

biz_code.biz_code_query

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

Request body application/json

filtersobject

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

Child attributes

biz_codestring

Biz Code. Filters results by Biz Code.

business_typestring

Asset Type. Filters results by Asset Type.

Allowed values: 6 Option, 7 Bond, 2 Stock, 5 Fund, 1 Cash, 4 Mmf, 8 Other, 9 Crypto, 10 Derivatives

Values

6: Option
7: Bond
2: Stock
5: Fund
1: Cash
4: Mmf
8: Other
9: Crypto
10: Derivatives

transfer_biz_namestring

Biz Name. Filters results by Biz Name.

visiblestring

Display to Client. Filters results by Display to Client.

Allowed values: true Y, false N

Values

true: Y
false: N

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

Responses

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

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

ID. Returned value: Unique identifier of the current record.

business_typestring

Asset Type. Returned value: Asset Type.

business_type_valstring

Asset Type (raw value). Raw value of business_type. The business_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

biz_codestring

Biz Code. Returned value: Biz Code.

visiblestring

Display to Client. Returned value: Indicates whether display to client.

visible_valstring

Display to Client (raw value). Raw value of visible. The visible field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

languagestring

Biz Code Name. Returned value: Biz Code Name.

remarkstring

Remarks. Returned value: Remarks.

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

op_userstring

Processed By. Returned value: Processed By.

totalintegerrequired

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "5439",
        "business_type": "Option",
        "business_type_val": "6",
        "biz_code": "NANALSTESTX",
        "visible": false,
        "visible_val": "false",
        "language": "{\"en\":\"测试13\",\"zh-CN\":\"测试11\",\"zh-HK\":\"测试12\"}",
        "remark": "aaa",
        "created_at": "1783663728",
        "updated_at": "1783663728",
        "op_user": "user@example.com"
      }
    ],
    "total": 560
  }
}

Export

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

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

biz_code.biz_code_query

Export options Export records Download result