Skip to main content
POST
List bonds for an issuer and market date.

Authorizations

Authorization
string
header
required

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

Body

Required issuer ID, currency code, debt-type name, date-only MktDataDate, and at most one provider selector; the action accepts the default market-date value.

Queries an issuer's bonds by market date, currency, and debt type.

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

issuer_id
string | null

Issuer whose bonds are requested.

currency
string | null

Currency that narrows the bonds for issuer operation.

debt_type
string | null

Debt type used to filter the issuer's bonds.

mkt_data_date
string

Market date on which bonds for issuer are requested.

Response

Returns matching bond IDs, display names, whole years to maturity, and convertible flags, or issuer, currency, debt-type, or missing-data errors.

Returns the bonds matching an issuer, currency, and debt-type query.

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

issuer_id
string | null

Issuer to which the returned bonds belong.

currency
string | null

Currency that narrows the bonds for issuer operation.

debt_type
string | null

Debt type represented by the returned bonds.

bonds
object[] | null

Bond summaries matching the issuer query.