Skip to main content
POST
Retrieve commodity-future contracts by identifier.

Authorizations

Authorization
string
header
required

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

Body

JSON request with non-empty Identifiers; each identifier supplies its namespace and code.

Instrument identifiers used to retrieve commodity-future contract definitions.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Tradables.ApiGetCmdtyFuturesRequest, Derivitec.Web.Core
identifiers
object[] | null

Identifiers of the commodity futures to retrieve.

Instrument code qualified by an identifier namespace and optional market code.

Response

Returns matched commodity futures and errors.

Commodity-future definitions matched to requested instrument identifiers.

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

cmdty_futures
object[] | null

Requested instrument identifiers paired with their commodity-future definitions.