Skip to main content
POST
List covered equity and index assets.

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 1, and EndRow greater than or equal to StartRow; IsPaginatedRequest does not affect this action.

Searches covered stocks and indices with independent one-based paging for each result set.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetEquityAssetsRequest, 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 separate stock and index pages with IDs, names, RICs, Bloomberg codes, currencies, market-identification codes, and per-list last-page flags.

Returns independently paged stock and index search results.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetEquityAssetsResponse, 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.

stock_list
object

Contains one page of equity assets and indicates whether that page was short.

index_list
object

Contains one page of equity assets and indicates whether that page was short.