Skip to main content
POST
Retrieve commodity fixing history.

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 StartDate/EndDate; inherited provider selectors do not change the returned history.

Selects a commodity and calendar-date range for close-fixing history.

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

start_date
string<date-time>

First calendar date supplied to the commodity fixing-history lookup.

end_date
string<date-time>

Last calendar date supplied to the commodity fixing-history lookup.

Response

Returns available fixing dates and close values, or a no-data error in the response payload.

Returns the available commodity close fixings in ascending date order.

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

commodity_data
object[] | null

Dated commodity close fixings ordered from earliest to latest.