Skip to main content
POST
Retrieve the pricing, cash flows and unit risks of a booked contract.

Authorizations

Authorization
string
header
required

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

Body

JSON request with the TradableId of a booked contract, the ReportingCurrency its values are quoted in, and optionally UseReportMarketData with the ReportId supplying that data.

Requests the legacy Details-page presentation of a saved contract by its tradable identifier, with optional report market data. Loads the contract directly without parsing or validating a candidate trade. Details-page units and table visibility may differ from booking output.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.TradeBooking.ApiGetTradableDetailsRequest, Derivitec.Web.Core
reporting_currency
string | null

Currency in which monetary results are expressed. When null, the service uses the caller's configured reporting currency or USD.

Example:

"USD"

tradable_id
string | null

Identifies the booked tradable to describe, as the contract identifier the portfolio holds rather than a position or trade id.

use_report_market_data
boolean

Whether to resolve market data from the report's saved container or its dates and providers. Without a saved container, a live risk report priced today can fetch a fresh live snapshot through the legacy resolver. Defaults to false, which uses the latest close data.

report_id
string | null

The report whose saved market data or valuation context prices the contract when Derivitec.Web.Core.TradeBooking.ApiGetTradableDetailsRequest.UseReportMarketData is set. Ignored otherwise.

Response

Returns the contract's identity, quantity, pricing, tables and unit risks. A contract that could not be priced carries the reason in its pricing details rather than failing the request.

Describes a saved contract using its legacy Details-page parameter rows, pricing units, and supporting tables. Unit-risk output is also returned for API consumers.

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

contract_type
string | null

The contract type this tradable is, which selects the schema used to render its own fields read-only.

Example:

"CmdtyFuture"

title
string | null

The tradable's name as the portfolio shows it, used as the page heading.

description
string | null

The longer description shown beneath the title, naming the contract type in the words a trader would use.

quantity
number<double>

Display quantity from the loaded contract after legacy Details-page preparation. Some contract types normalize this to one for unit valuation. This is not a portfolio holding or a sum across books; multiply only pricing entries marked ScalesByQty by this value.

pricing_details
object

Collection of display-ready pricing details with an optional overall error message.

show_live_data_refresh
boolean

Whether the legacy market-data resolver applied live data for this valuation and the caller can request a fresh snapshot by repeating the same details request. False for close data, saved report containers, or when no valid live-data override was applied.

Example:

true

live_data_snapshot_time
string<date-time> | null

Time the legacy market-data resolver applied the live snapshot used for this valuation, in ISO 8601 format with the server's UTC offset. This is the snapshot acquisition time, not the report run time or an individual quote's timestamp. Null when Derivitec.Web.Core.TradeBooking.ApiGetTradableDetailsResponse.ShowLiveDataRefresh is false.

Example:

"2026-09-17T11:23:45+01:00"

data_tables
object[] | null

Legacy Details-page parameter and supporting tables, including cash flows and fixings when that page exposes them. Each table supplies ordered rows, column captions, and display formats. Developer-only rows and tables require the authenticated developer claim. Null when market data is unavailable; otherwise empty when no tables are available.

tradable_risk_data
object

Unit-risk values and an optional diagnostic for one tradable.