> ## 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 borrow curve for one equity.

> Use this operation to retrieve a borrow curve on one market date. The response contains maturity day
offsets, expiry dates, and either forward rates or zero rates. The operation also supplies standardised
boundary points when the requested curve has no point at day 1 or day 3650. This single-curve action only
forwards environment-name selection; use `GetBorrowCurves` when selecting the source by provider ID.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetBorrowCurve
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/GetBorrowCurve:
    post:
      tags:
        - MarketData
      summary: Retrieve a borrow curve for one equity.
      description: >-
        Use this operation to retrieve a borrow curve on one market date. The
        response contains maturity day

        offsets, expiry dates, and either forward rates or zero rates. The
        operation also supplies standardised

        boundary points when the requested curve has no point at day 1 or day
        3650. This single-curve action only

        forwards environment-name selection; use `GetBorrowCurves` when
        selecting the source by provider ID.
      operationId: GetBorrowCurve
      requestBody:
        description: >-
          The query payload. Supply one equity `Identifier`, a date-only
          `MarketDate`, and optional `MarketDataEnvironmentName` or
          `MarketDataEnvironmentNames`; inherited `ProviderId` is not used by
          this action. `ReturnForwardRates` defaults to `true`, while `false`
          requests zero rates.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetBorrowCurveDataRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetBorrowCurveDataRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetBorrowCurveDataRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetBorrowCurveDataRequest'
      responses:
        '200':
          description: >-
            Returns the requested curve points, standardised boundary points
            where applicable, and errors for an unsupported identifier or
            unavailable curve.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetBorrowCurveDataResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetBorrowCurveDataRequest:
      required:
        - $type
      type: object
      properties:
        identifier:
          $ref: '#/components/schemas/InstrumentIdentifier'
        market_date:
          type: string
          description: Market date used by the derived request.
          format: date-time
        provider_id:
          type: string
          description: >-
            Opaque identifier of a single market-data provider to use instead of
            either environment-name option.
          nullable: true
        entity_access_type:
          enum:
            - view
            - edit
            - owner
            - blocked
          type: string
          description: >-
            Access classification associated with the selected market-data
            environment.
        market_data_environment_names:
          type: array
          items:
            type: string
          description: >-
            Names of the market-data environments to use. Do not combine this
            list with the single-name or provider-ID alternatives.
          nullable: true
        market_data_environment_name:
          type: string
          description: >-
            Single market-data environment name to use instead of
            `market_data_environment_names` or `provider_id`.
          nullable: true
          example: Example market data
        return_forward_rates:
          type: boolean
          description: >-
            True requests forward rates and false requests zero rates; defaults
            to `true`.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetBorrowCurveDataRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Selects a borrow curve and chooses forward-rate or zero-rate output.
    ApiGetBorrowCurveDataResponse:
      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
        curve_data:
          type: array
          items:
            $ref: '#/components/schemas/YieldCurvePoint'
          description: >-
            Borrow curve in the requested forward-rate or zero-rate
            representation.
          nullable: true
        additional_standardised_curve_data:
          type: array
          items:
            $ref: '#/components/schemas/YieldCurvePoint'
          description: >-
            Optional day-one or day-3650 boundary points returned when the curve
            does not already reach those maturities.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetBorrowCurveDataResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns the requested borrow curve plus standardized boundary points.
    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'
    YieldCurvePoint:
      required:
        - $type
      type: object
      properties:
        expiry:
          type: string
          description: Expiry date obtained from the curve's market date and maturity.
          format: date-time
        maturity:
          type: integer
          description: Calendar days after the curve market date.
          format: int32
        rate:
          type: number
          description: Zero rate as a decimal; 0.05 means 5%.
          format: double
        fitted_instrument_name:
          type: string
          description: Optional display name of the instrument fitted at this point.
          nullable: true
        fitted_instrument_rate:
          type: number
          description: >-
            Optional fitted-instrument quote in percentage points reported at
            this point.
          format: double
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.YieldCurvePoint, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        One dated yield-curve point with maturity, rate, and optional
        fitted-instrument details.
    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

````