Skip to main content
POST
Retrieve tabular convertible-bond data by identifier.

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. ProviderId and MarketDataEnvironmentName are accepted but do not select the environment for this operation.

Instrument identifiers used to retrieve convertible-bond contract definitions.

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

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

Response

Returns flattened results and errors.

Tabular convertible-bond data returned for requested identifiers.

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

convertible_bonds
object[] | null

Flattened convertible-bond rows returned for the requested identifiers.