Skip to content
Longport WhaleLongport Whale
Billing Management

Securities Lending Contracts

Query the securities lending contract records. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

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

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

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>.

Permission

billing.short_selling_management_view

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

Query parameters

filtersobject

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

Child attributes
aaidstring

Filters results by Client.

currencystring

Filters results by Currency.

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

year_monthstring

Filters results by Month.

statusstring

Filters results by Status.

1 · Settled failed2 · Unsettled3 · Settled

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Securities Lending 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
idstring

Returned value: Unique identifier of the current record.

member_idstring

Returned value: Member Id.

origin_idstring

Returned value: A/C No..

real_namestring

Returned value: Client Name.

year_monthstring

Returned value: Month.

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.

counter_idstring

Returned value: Counter ID.

currencystring

Returned value: Currency.

currency_valstring

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

nostring

Returned value: No.

amountstring

Returned value: Current Interest Amt.

begin_biz_datestring

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

last_biz_datestring

Returned value: Expected Posting Day (Reset Date). The date or time format follows the value returned by the API.

statusstring

Returned value: State.

status_valstring

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

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