> ## 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 yield curve for display.

> Use this operation to display fitted issuer yield-curve points, fit status, contributing bonds, and any
reference curve. Issuer ID, currency, debt type, market-data date, and provider ID are required; the
provider pipeline supplies the authorised default when no selector is sent. A future `MktDataDate` is
replaced by the latest available market-data date. Yields and spreads use percentage-point display units and
maturities are day offsets. The operation is read-only and completes before returning.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Bond/GetBondYieldCurveData
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/GetBondYieldCurveData:
    post:
      tags:
        - Bond
      summary: Retrieve a bond yield curve for display.
      description: >-
        Use this operation to display fitted issuer yield-curve points, fit
        status, contributing bonds, and any

        reference curve. Issuer ID, currency, debt type, market-data date, and
        provider ID are required; the

        provider pipeline supplies the authorised default when no selector is
        sent. A future `MktDataDate` is

        replaced by the latest available market-data date. Yields and spreads
        use percentage-point display units and

        maturities are day offsets. The operation is read-only and completes
        before returning.
      operationId: GetBondYieldCurveData
      requestBody:
        description: >-
          Non-empty `IssuerId`, `Currency`, and `DebtType`; date-only
          `MktDataDate`; and at most one provider selector.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetBondYieldCurveDataRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetBondYieldCurveDataRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetBondYieldCurveDataRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetBondYieldCurveDataRequest'
      responses:
        '200':
          description: >-
            Returns scatter and line-plot curve points, fit metadata,
            rolled/reference-curve details, and any missing-curve or
            unknown-issuer errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetBondYieldCurveDataResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetBondYieldCurveDataRequest:
      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
        issuer_id:
          type: string
          description: Issuer selecting the curve.
          nullable: true
        currency:
          type: string
          description: Currency that narrows the bond yield curve operation.
          nullable: true
        debt_type:
          type: string
          description: Debt type used to select the issuer curve.
          nullable: true
        mkt_data_date:
          type: string
          description: Market date of the requested issuer curve.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Selects an issuer bond yield curve by issuer, currency, debt type, and
        market date.
    ApiGetBondYieldCurveDataResponse:
      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
        provider_id:
          type: string
          description: >-
            Opaque identifier of the market-data provider associated with the
            returned data.
          nullable: true
        fit_date:
          type: string
          description: >-
            Display-formatted completion time of the curve conversion, when
            available.
          nullable: true
        fit_status:
          type: string
          description: Status reported by the curve conversion.
          nullable: true
        fit_message:
          type: string
          description: Message reported by the curve conversion.
          nullable: true
        is_rolled:
          type: boolean
          description: Whether the displayed curve was rolled from another market date.
        yield_curve_id:
          type: string
          description: Identifier of the displayed issuer curve.
          nullable: true
        issuer_name:
          type: string
          description: Display name of the curve issuer.
          nullable: true
        mkt_data_date:
          type: string
          description: Market date represented by the displayed curve.
        yield_curve_data_scatter:
          type: array
          items:
            $ref: '#/components/schemas/BondYieldCurveDataPoint'
          description: Observed bond points shown with the displayed issuer curve.
          nullable: true
        yield_curve_data_line_plot:
          type: array
          items:
            $ref: '#/components/schemas/BondYieldCurveDataPoint'
          description: Points forming the displayed issuer-curve line.
          nullable: true
        is_referenced:
          type: boolean
          description: Whether the returned bond yield curve is referenced.
        reference_yield_curve_id:
          type: string
          description: Identifier of the reference curve.
          nullable: true
        reference_yield_curve_issuer_name:
          type: string
          description: Display name of the reference-curve issuer.
          nullable: true
        reference_yield_curve_currency:
          type: string
          description: Currency dimension of the reference curve.
          nullable: true
        reference_yield_curve_debt_type:
          type: string
          description: Debt-type dimension of the reference curve.
          nullable: true
        reference_yield_curve_data_line_plot:
          type: array
          items:
            $ref: '#/components/schemas/BondYieldCurveDataPoint'
          description: Plot points for the reference curve.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Returns fitted-curve status and plot-ready observed, fitted, and
        reference-curve series.
    BondYieldCurveDataPoint:
      required:
        - $type
        - expiry
        - maturity
        - ytm_pp
      type: object
      properties:
        maturity:
          type: integer
          description: Maturity expressed as a day offset.
          format: int32
        expiry:
          type: string
          description: Calendar date represented by the maturity coordinate.
        ytm_pp:
          type: number
          description: Issuer-curve yield to maturity expressed in percentage points.
          format: double
        spread:
          type: number
          description: >-
            Bond yield-curve spread at this point, expressed in percentage
            points.
          format: double
        reference_ytm_pp:
          type: number
          description: Reference-curve yield to maturity expressed in percentage points.
          format: double
        is_ref_point:
          type: boolean
          description: >-
            Whether the point is an exact curve knot rather than an interpolated
            point.
        bond_name:
          type: string
          description: Display name of the bond represented by this point.
          nullable: true
        bond_id:
          type: string
          description: Bond selector.
          nullable: true
        bond_is_convertible:
          type: boolean
          description: Whether the bond represented by this point is convertible.
        bond_mt_m_price:
          type: string
          description: >-
            Display-formatted mark-to-market price of the bond represented by
            this point.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.BondYieldCurveDataPoint,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Observed or reference bond point used to inspect a fitted issuer yield
        curve.
  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

````