Skip to main content
POST
Find commodity instruments by identifier or search text.

Authorizations

Authorization
string
header
required

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

Body

A non-null SearchTerm containing an internal commodity ID or search text (empty selects all active commodities), StartRow greater than or equal to 1, EndRow greater than or equal to StartRow, and optional HasVolData (default false).

Searches commodity descriptors by internal ID or by name, sector, and subsector, with an optional volatility-data filter.

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

has_vol_data
boolean

When true, keeps only instruments with volatility data; false does not apply that filter.

Example:

false

Response

Returns matching commodity descriptors and 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.