Skip to main content
POST
Calculate prices 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, optional MarketDataOverride, and one unambiguous market-data environment selection.

Contracts, valuation dates, reporting currency, and optional market-data substitutions used to request prices.

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

contracts
object[] | null

Contracts to price.

Polymorphic base role shared by public contract definitions.

market_data_override
object

Optional market-data substitutions supplied with pricing, risk, or report calculations.

mkt_data_date
string<date-time>

Date of market data used for pricing.

pricing_date
string<date-time>

Date on which the contracts are priced.

reporting_currency
string | null

Currency in which price results are requested; code standard is not defined here.

Response

Returns aligned prices, market-data errors, and aligned pricing-error strings.

Contract prices with separate market-data and per-contract pricing diagnostics.

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

market_data_errors
object

Market-data failures grouped by the affected data category.

prices
number<double>[] | null

Returned contract prices; entries follow the order of contracts accepted for pricing, and unavailable calculated prices may be non-finite.

pricing_errors
string[] | null

Per-contract pricing diagnostic strings corresponding to the returned price entries.