Skip to main content
POST
Retrieve commodity market details.

Authorizations

Authorization
string
header
required

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

Body

A commodity name/exchange Identifier and date-only MarketDate; inherited provider selectors do not change the returned details.

Selects a commodity and market-data date for futures-price and settlement-calendar details.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiCommodityGetInfoRequest, Derivitec.Web.Core
identifier
object

Commodity business key formed from name and exchange.

market_date
string<date-time>

Market date used by the derived request.

provider_id
string | null

Opaque identifier of a single market-data provider to use instead of either environment-name option.

entity_access_type
enum<string>

Access classification associated with the selected market-data environment.

Available options:
view,
edit,
owner,
blocked
market_data_environment_names
string[] | null

Names of the market-data environments to use. Do not combine this list with the single-name or provider-ID alternatives.

market_data_environment_name
string | null

Single market-data environment name to use instead of market_data_environment_names or provider_id.

Example:

"Example market data"

Response

Returns the futures price and trading-calendar ID when commodity details are available.

Returns a commodity futures quote and its settlement calendar.

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

provider_id
string | null

Opaque identifier of the market-data provider associated with the returned data.

futures_price
number<double>

Futures quote returned for the selected commodity and market-data date.

trading_calendar_id
string | null

Settlement calendar name returned for the selected commodity.