Skip to content
Longport WhaleLongport Whale
Broker Contract

Institution Contract

Queries Institution Contract 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/booking_company_tasks

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
counter_idstring

Filters results by Counter ID.

trade_ledger_datestring

Filters results by Ledger Date.

trade_datestring

Filters results by Trade Date.

expected_balance_settlement_datestring

Filters results by Expected Settlement Date (Cash).

expected_equity_settlement_datestring

Filters results by Expected Settlement Date (Qty).

company_datasourcestring

Filters results by Data Source.

Allowed values:

  • 0 - Normal Contract
  • 1 - Broker Contract Overshooting
  • 2 - Broker Contract Adjustment

0 · Normal Contract1 · Broker Contract Overshooting2 · Broker Contract Adjustment

marketstring

Filters results by Market.

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

biz_typestring

Filters results by Biz Type.

Values are dynamic. Call GET /v1/datasets/refs/billing_agent_business_type 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 Institution Contract 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
custodian_idstring

Returned value: Custodian.

custodian_id_valstring

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

nostring

Returned value: No.

company_datasourcestring

Returned value: Source.

company_datasource_valstring

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

trade_ledger_datestring

Returned value: Ledger Date. The date or time format follows the value returned by the API.

trade_datestring

Returned value: Trade Date. The date or time format follows the value returned by the API.

expected_balance_settlement_datestring

Returned value: Expected Settlement Date (Cash). The date or time format follows the value returned by the API.

expected_equity_settlement_datestring

Returned value: Expected Settlement Date (Qty). The date or time format follows the value returned by the API.

settlement_channelstring

Returned value: Settlement Channel.

settlement_channel_valstring

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

biz_typestring

Returned value: Biz Type.

biz_type_valstring

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

settlement_accountstring

Returned value: Sub Account.

marketstring

Returned value: Market.

market_valstring

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

stagestring

Returned value: Trade Phase.

stage_valstring

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

counter_idstring

Returned value: Counter ID.

currencystring

Returned value: Currency.

directionstring

Returned value: Trade Direction.

direction_valstring

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

trade_quantitystring

Returned value: Trade Quantity.

trade_amountstring

Returned value: Trade Amount.

ibond_amountstring

Returned value: Interest.

fee_amountstring

Returned value: Fee.

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

Whale Docs