Skip to main content
POST
List covered equity instruments.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

Optional SearchTerm (null behaves as empty), StartRow greater than or equal to 0, and EndRow greater than StartRow.

Selects a page of equity instruments.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiListEquityInstrumentsRequest, Derivitec.Web.Core
is_paginated_request
string | null

Compatibility paging-mode field with no observable effect in current MarketData listing operations.

start_row
integer<int32>

Starting row selector for the requested page; indexing conventions are operation-specific.

end_row
integer<int32>

Upper row selector for the requested page; each listing operation defines whether it is inclusive or exclusive.

search_term
string | null

Text used to filter the available instruments.

Response

Returns ordered Bloomberg instrument identifiers with names and market-identification codes, plus a last-page flag.

Shared page of instrument summaries with an end-of-results indicator.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiBaseListPaginatedInstrumentsResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

instruments
object[] | null

Instrument summaries in the current page.

last_row
boolean

Whether this page reaches the end of the result set.