Skip to main content
POST
Retrieve convertible-bond pricing details.

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 Identifiers, meaningful AsOfDate, optional MarketDataOverride, and at most one accessible market-data environment. The date is not otherwise constrained here.

Convertible-bond identifiers, valuation date, and optional market-data substitutions used to request grid details.

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

identifiers
object[] | null

Identifiers of the convertible bonds whose grid details are requested.

Instrument code qualified by an identifier namespace and optional market code.

as_of_date
string<date-time>

Date at which convertible-bond grid details are requested.

market_data_override
object

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

Response

Returns pricing details and errors.

Time, spot, and hazard-rate grids returned for requested convertible bonds.

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

time_grids
object[] | null

Requested instrument identifiers paired with time-grid values; units and ordering are not defined here.

spot_grids
object[] | null

Requested instrument identifiers paired with spot-grid values; scale and ordering are not defined here.

hazard_rates
object[] | null

Requested instrument identifiers paired with hazard-rate matrices; axes, scale, and units are not defined here.