Skip to content
Longport WhaleLongport Whale
Bizcode Management

Bizcode Query

Queries Bizcode Query data. Combine business filters in filters, and use page and page_size to control pagination.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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

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

6725148910

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

truefalse

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

Export

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

POSThttps://b-api.longbridge.xyz/v1/datasets/biz_codes_brief/download
Export optionsExport recordsDownload result
Whale Docs