Skip to content
Longport WhaleLongport Whale
Private Stock

Private Stock

Queries security_private data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

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/security_private_instruments

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

Authorizationstringheadergemini.stock_infoRequired

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
counter_idstring

Symbol Name/Ticker. Filters results by Symbol Name/Ticker.

marketstring

Market. Filters results by Market.

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

security_typestring

Security Type. Filters results by Security Type.

Allowed values:

  • STOCK - Stock
  • BOND - Bond
  • OTHER - Other

STOCKBONDOTHER

"ISIN"string

ISIN. Filters results by ISIN.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated security_private 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.

name_symbolstring

Name/Ticker. Returned value: Name/Ticker.

counter_idstring

Counter Id. Returned value: Counter Id.

security_typestring

Security Type. Returned value: Security Type.

security_type_valstring

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

currencystring

Currency. Returned value: Currency.

group_namestring

Group Name). Returned value: Group Name).

ISINstring

ISIN. Returned value: ISIN.

risk_levelstring

Risk level. Returned value: Risk level.

updated_atstring

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

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

Whale Docs