Skip to main content
POST
Store commodity-futures observations.

Authorizations

Authorization
string
header
required

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

Body

The upload payload. Provide either ProviderId or MarketDataEnvironmentName, not both; omitting both selects the caller's organisation scope. CmdtyFuturesData must be non-empty and each row supplies a contract identifier, date-only market date, prices, currency, and optional volume; a supplied ExpirationDate is replaced by the date implied by the contract.

Submits dated commodity-futures observations.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiUploadCmdtyFuturesDataRequest, Derivitec.Web.Core
market_data_environment_name
string | null

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

cmdty_futures_data
object[] | null

Dated commodity-futures observations to upload.

Response

Returns whether any rows were stored and errors for invalid providers, unsupported or ambiguous contracts, duplicate dates, or write failures.

Common operation outcome containing a success indicator and any error messages.

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