Skip to main content
POST
Retrieve market data for contracts.

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 Contracts, meaningful PricingDate and MktDataDate, reporting currency, and at most one accessible market-data environment selected by name or identifier.

Requests the market data needed to price supplied contracts for a pricing date and reporting currency.

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

contracts
object[] | null

Contracts for which pricing market data is requested.

Polymorphic base role shared by public contract definitions.

pricing_date
string<date-time>

Pricing date applied to the requested contracts.

mkt_data_date
string<date-time>

Market date used to assemble the container.

reporting_currency
string | null

Reporting currency selecting the requested market data container.

Response

Returns the market-data container or an unsuccessful payload with errors.

Returns the assembled market-data container.

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

mkt_data
object

Serializable collection of the market data required by a valuation request.