Find commodity instruments by identifier or search text.
Use this operation for a commodity picker or to resolve a linked commodity’s internal ID. Search text
matches names, sectors, and subsectors without regard to case. An exact, case-insensitive internal-ID
match also returns an inactive commodity so historical contract links can resolve their descriptor;
ordinary text searches exclude inactive commodities. HasVolData=true restricts all results to
commodities with volatility data; its default is
false. StartRow=1 selects the first result; the action does not define a conventional later-page
bound. IsPaginatedRequest does not affect this action. It is read-only and completes before returning.
Authorizations
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.
Derivitec.Web.Core.MarketData.ApiListCommodityInstrumentsRequest, Derivitec.Web.Core Compatibility paging-mode field with no observable effect in current MarketData listing operations.
Starting row selector for the requested page; indexing conventions are operation-specific.
Upper row selector for the requested page; each listing operation defines whether it is inclusive or exclusive.
Text used to filter the available instruments.
When true, keeps only instruments with volatility data; false does not apply that filter.
false
Response
Returns matching commodity descriptors and a last-page flag.
- Option 1
- Option 2
Shared page of instrument summaries with an end-of-results indicator.
Derivitec.Web.Core.MarketData.ApiBaseListPaginatedInstrumentsResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.
Instrument summaries in the current page.
Whether this page reaches the end of the result set.