> ## 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 bond price observations.

> Use this operation to retrieve dated price observations for requested bonds over an inclusive range.
Results preserve the requested instrument identifiers as keys and can include supported bonds when other
identifiers are unavailable. Provider or environment scope determines the contribution returned; omitting
both selects the caller's organisation. The legacy `ReturnContributedData` flag is accepted, but the
provider scope selected for the request determines the source independently. This operation is read-only.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetBondData
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/MarketData/GetBondData:
    post:
      tags:
        - MarketData
      summary: Retrieve bond price observations.
      description: >-
        Use this operation to retrieve dated price observations for requested
        bonds over an inclusive range.

        Results preserve the requested instrument identifiers as keys and can
        include supported bonds when other

        identifiers are unavailable. Provider or environment scope determines
        the contribution returned; omitting

        both selects the caller's organisation. The legacy
        `ReturnContributedData` flag is accepted, but the

        provider scope selected for the request determines the source
        independently. This operation is read-only.
      operationId: GetBondData
      requestBody:
        description: >-
          The query payload. `Identifiers` must be non-empty supported bond
          identifiers, `StartDate` and `EndDate` are date-only inclusive
          boundaries, and provider or environment fields select one authorised
          source.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetBondDataRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetBondDataRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetBondDataRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetBondDataRequest'
      responses:
        '200':
          description: >-
            Returns available bond observations keyed by input identifier and
            errors for unknown bonds or missing data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetBondDataResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetBondDataRequest:
      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
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/InstrumentIdentifier'
          description: Instrument selectors whose bond observations are requested.
          nullable: true
        start_date:
          type: string
          description: Inclusive lower date-only boundary for the requested observations.
          format: date-time
        end_date:
          type: string
          description: Inclusive upper date-only boundary for the requested observations.
          format: date-time
        return_contributed_data:
          type: boolean
          description: >-
            Legacy compatibility flag; the resolved provider scope determines
            the public operation's source, so this value currently has no
            observable effect.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetBondDataRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Queries dated bond trading observations by bond selector and date range.
    ApiGetBondDataResponse:
      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
        bond_data:
          type: array
          items:
            $ref: '#/components/schemas/InstrumentIdentifierBondDataIListKeyValuePair'
          description: Bond trading observations returned by the query.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetBondDataResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns dated bond trading observations and query errors.
    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'
    InstrumentIdentifierBondDataIListKeyValuePair:
      type: object
      properties:
        key:
          $ref: '#/components/schemas/InstrumentIdentifier'
        value:
          type: array
          items:
            $ref: '#/components/schemas/BondData'
          nullable: true
      additionalProperties: false
    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.
    BondData:
      required:
        - $type
      type: object
      properties:
        provider_id:
          type: string
          description: >-
            Market-data provider code recorded as the source of the
            contribution. Defaults to Derivitec.
          nullable: true
        derivitec_created:
          type: string
          description: Timestamp at which the market-data record was created.
        derivitec_modified:
          type: string
          description: Optional timestamp of the record's latest modification.
          nullable: true
        uploaded_date_time:
          type: string
          description: >-
            Optional timestamp at which the contribution was uploaded.
            UploadRateAssets ignores the supplied value on each rate asset and
            stores the current UTC time.
          nullable: true
        derivitec_modified_by:
          type: string
          description: >-
            Principal recorded as the latest modifier. UploadRateAssets ignores
            the supplied value on each rate asset and stores the authenticated
            user identifier.
          nullable: true
        uploaded_by:
          type: string
          description: >-
            Principal recorded as the uploader. UploadRateAssets ignores the
            supplied value on each rate asset and stores the authenticated user
            identifier.
          nullable: true
        rolled:
          type: boolean
          description: Whether the contribution has been rolled.
          example: false
        bond_id:
          type: string
          description: Bond selector.
          nullable: true
        close:
          type: number
          description: Closing observation.
          format: double
        currency:
          type: string
          description: Currency reported with the bond observation.
          nullable: true
        date:
          type: string
          description: Observation date.
          format: date-time
        high:
          type: number
          description: Highest observation.
          format: double
          nullable: true
        low:
          type: number
          description: Lowest observation.
          format: double
          nullable: true
        open:
          type: number
          description: Opening observation.
          format: double
          nullable: true
        contributor:
          type: string
          description: Source contributor label carried with the observation.
          nullable: true
        volume:
          type: number
          description: Reported trading volume.
          format: double
          nullable: true
        liquidity_score:
          type: integer
          description: Liquidity score carried with the observation.
          format: int32
          nullable: true
        is_live_price:
          type: boolean
          description: Whether the observation is marked as a live price.
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.BondData, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Dated bond trading observation with open, high, low, close, volume,
        currency, contributor, liquidity, and live-price context.
  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

````