> ## Documentation Index > Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a bond coupon schedule. > Use this operation to retrieve coupon dates and values for one code-specified bond over a requested range. `Bond`, `MktDataDate`, `PricingDate`, `StartDate`, and `EndDate` are required. Omitting provider selection uses the shared Derivitec provider for this request. All date/time inputs are interpreted as calendar dates; no start/end ordering rule is established by this action. It is read-only and completes the schedule before returning. ## OpenAPI ````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Bond/GetCoupons openapi: 3.0.4 info: title: Derivitec Api 1.0 version: '1.0' servers: - url: https://api.riskportal.activeviam.com security: - oauth2: [] - apikey: [] tags: - name: AdminUser - name: AtotiReport - name: AtotiSession - name: BloombergOAuth - name: Bond - name: BondYieldCurvePage - name: BookAccess - name: Books - name: Commodity - name: Counterparties - name: Currencies - name: Equity - name: EquityDividend - name: EquityPage - name: FeatureFlag - name: Fx - name: FxPage - name: GroupAccess - name: Home - name: LegacyPosition - name: MarketData - name: MarketDataProvider - name: MarketDataProviderAccess - name: Meta - name: Notification - name: Organisation - name: PnLReport - name: PortfolioAccess - name: Portfolios - name: Position - name: PositionFilter - name: PricingEnvironment - name: PricingEnvironmentAccess - name: RateAsset - name: RateAssetPage - name: Report - name: ReportDefinition - name: ReportHistoryLauncherQuery - name: ReportLauncher - name: ReportQuery - name: ReportQueryViewUser - name: ReportRestriction - name: ReportView - name: RiskReport - name: Tradable - name: TradeBooking - name: User - name: VarReport - name: VarReportQuery - name: YieldCurvePage paths: /api/Bond/GetCoupons: post: tags: - Bond summary: Retrieve a bond coupon schedule. description: >- Use this operation to retrieve coupon dates and values for one code-specified bond over a requested range. `Bond`, `MktDataDate`, `PricingDate`, `StartDate`, and `EndDate` are required. Omitting provider selection uses the shared Derivitec provider for this request. All date/time inputs are interpreted as calendar dates; no start/end ordering rule is established by this action. It is read-only and completes the schedule before returning. operationId: GetCoupons requestBody: description: >- The bond `InstrumentIdentifier`, four calendar-date inputs, and at most one provider selector: `ProviderId` or `MarketDataEnvironmentName`. content: application/json-patch+json: schema: $ref: '#/components/schemas/ApiGetCouponsRequest' application/json: schema: $ref: '#/components/schemas/ApiGetCouponsRequest' text/json: schema: $ref: '#/components/schemas/ApiGetCouponsRequest' application/*+json: schema: $ref: '#/components/schemas/ApiGetCouponsRequest' responses: '200': description: >- Returns parallel coupon-date and coupon-value collections, or validation and domain errors in the response payload. content: application/json: schema: $ref: '#/components/schemas/ApiGetCouponsResponse' '400': description: BadRequest '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] - apikey: [] components: schemas: ApiGetCouponsRequest: required: - $type type: object properties: market_data_environment_name: type: string description: >- Name of the market-data environment to use. Supply either this name or `provider_id`, not both. nullable: true example: Example market data provider_id: type: string description: >- Opaque identifier of the market-data provider to use. Supply either this identifier or `market_data_environment_name`, not both. nullable: true bond: $ref: '#/components/schemas/BondByCode' mkt_data_date: type: string description: Date of market data used to determine coupon amounts. format: date-time pricing_date: type: string description: Date on which the bond is evaluated for the coupon request. format: date-time start_date: type: string description: >- Lower date bound of the requested coupon interval; inclusivity is not defined here. format: date-time end_date: type: string description: >- Upper date bound of the requested coupon interval; inclusivity is not defined here. format: date-time $type: type: string enum: - >- Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core additionalProperties: false description: >- Code-specified bond, valuation dates, and date interval used to request coupon amounts. ApiGetCouponsResponse: required: - $type type: object properties: is_success: type: boolean description: >- Whether the operation completed successfully. The default is `true`; error outcomes set it to `false`. example: true error_messages: type: array items: type: string description: >- Messages explaining operation-level failures. The collection is empty by default. nullable: true coupon_dates: type: array items: type: string format: date-time description: Dates of the returned coupon amounts. nullable: true coupons: type: array items: type: number format: double description: >- Returned coupon amounts; currency, units, and correspondence to dates are not defined here. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.Tradables.ApiGetCouponsResponse, Derivitec.Web.Core additionalProperties: false description: Coupon dates and amounts returned for the requested bond. BondByCode: required: - $type type: object additionalProperties: false description: >- Bond contract selected by an instrument code rather than fully specified bond terms. properties: identifier: type: string description: >- Contract identifier supplied by the caller or derived from contract terms when omitted; namespace and derivation format are not public here. nullable: true code: $ref: '#/components/schemas/InstrumentIdentifier' $type: type: string enum: - Derivitec.Web.Core.Tradables.BondByCode, Derivitec.Web.Core InstrumentIdentifier: description: >- Instrument code qualified by an identifier namespace and optional market code. discriminator: propertyName: $type mapping: Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core: '#/components/schemas/InstrumentIdentifierMintlifyShape' Derivitec.Web.Core.MarketData.InstrumentInfo, Derivitec.Web.Core: '#/components/schemas/InstrumentInfo' oneOf: - $ref: '#/components/schemas/InstrumentIdentifierMintlifyShape' - $ref: '#/components/schemas/InstrumentInfo' InstrumentIdentifierMintlifyShape: required: - $type type: object properties: code: type: string description: Instrument code interpreted in the selected identifier namespace. nullable: true identifier_type: enum: - Derivitec - Ric - Bloomberg - Isin - Figi - Sedol - RedCode - RedPairCode - BloombergYellow - XIgniteCode - CBondsId - EdiSecId - EdiSymbol - Cusip - NotSet type: string description: Namespace that determines how the instrument code is interpreted. market_identification_code: type: string description: >- Optional market identification code that further qualifies the instrument code. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core additionalProperties: false description: >- Instrument code qualified by an identifier namespace and optional market code. InstrumentInfo: required: - $type type: object properties: code: type: string description: Instrument code interpreted in the selected identifier namespace. nullable: true identifier_type: enum: - Derivitec - Ric - Bloomberg - Isin - Figi - Sedol - RedCode - RedPairCode - BloombergYellow - XIgniteCode - CBondsId - EdiSecId - EdiSymbol - Cusip - NotSet type: string description: Namespace that determines how the instrument code is interpreted. market_identification_code: type: string description: >- Optional market identification code that further qualifies the instrument code. nullable: true name: type: string description: Human-readable name of the identified instrument. nullable: true $type: type: string enum: - Derivitec.Web.Core.MarketData.InstrumentInfo, Derivitec.Web.Core additionalProperties: false description: Instrument identifier with a human-readable instrument name. securitySchemes: oauth2: type: oauth2 description: >- OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header flows: implicit: authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize scopes: {} apikey: type: apiKey description: API-Key requested via the site and provided as a header name: x-api-key in: header ````