> ## 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 equity forward points. > Use this operation for forward, discount-factor, and dividend information for one equity. A non-empty `ExpirationDates` list selects only those calendar dates; otherwise the action produces a weekly business-day series to approximately ten years. `IncludeExDates` defaults to `false` and controls inclusion of dividend ex-dates. A market date on or after the server's current date uses the latest available market-data date. Selected providers take precedence over caller-organisation and shared data. It is read-only and synchronous. ## OpenAPI ````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Equity/GetEquityForwards 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/Equity/GetEquityForwards: post: tags: - Equity summary: Retrieve equity forward points. description: >- Use this operation for forward, discount-factor, and dividend information for one equity. A non-empty `ExpirationDates` list selects only those calendar dates; otherwise the action produces a weekly business-day series to approximately ten years. `IncludeExDates` defaults to `false` and controls inclusion of dividend ex-dates. A market date on or after the server's current date uses the latest available market-data date. Selected providers take precedence over caller-organisation and shared data. It is read-only and synchronous. operationId: GetEquityForwards requestBody: description: >- A supported equity `Identifier`, date-only `MarketDate`, optional ISO 8601 `ExpirationDates`, optional `IncludeExDates` (default `false`), and one authorised provider-selector form. content: application/json-patch+json: schema: $ref: '#/components/schemas/ApiEquityGetForwardsRequest' application/json: schema: $ref: '#/components/schemas/ApiEquityGetForwardsRequest' text/json: schema: $ref: '#/components/schemas/ApiEquityGetForwardsRequest' application/*+json: schema: $ref: '#/components/schemas/ApiEquityGetForwardsRequest' responses: '200': description: >- Returns ordered equity forward points, or unavailable-equity or forward errors. content: application/json: schema: $ref: '#/components/schemas/ApiEquityGetForwardsResponse' '400': description: BadRequest '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] - apikey: [] components: schemas: ApiEquityGetForwardsRequest: 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 expiration_dates: type: array items: type: string format: date-time description: >- Requested forward expiries; when absent or empty, weekly business-day dates are generated from the effective market-data date to approximately ten years. nullable: true include_ex_dates: type: boolean description: Whether forward points include ex-dividend-date annotations. example: false $type: type: string enum: - >- Derivitec.Web.Core.MarketData.ApiEquityGetForwardsRequest, Derivitec.Web.Core additionalProperties: false description: >- Selects an equity, market-data date, optional expiries, and optional ex-dividend annotations for a forward curve. ApiEquityGetForwardsResponse: 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 equity_forwards: type: array items: $ref: '#/components/schemas/EquityForwardPoint' description: Equity forward points for the expiries resolved from the request. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.ApiEquityGetForwardsResponse, Derivitec.Web.Core additionalProperties: false description: Returns forward points for the selected equity and expiries. 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' EquityForwardPoint: required: - $type type: object properties: all_in_rate: type: number description: All-in rate reported for the forward observation. format: double borrow_factor: type: number description: Borrow factor reported for the forward observation. format: double date: type: string description: Date of the forward observation. format: date-time discount_factor: type: number description: Discount factor reported for the forward observation. format: double forward: type: number description: Equity forward value for the observation date. format: double is_ex_date: type: boolean description: Whether the forward date is a dividend ex-date. example: false gross_dividend: type: number description: Gross dividend contribution at the forward date. format: double net_dividend: type: number description: Net dividend contribution at the forward date. format: double dividend_currency: type: string description: Currency code carried for the dividend contribution. nullable: true fx_rate: type: number description: FX conversion value applied to the dividend contribution. format: double borrow_rate: type: number description: Borrow-rate value reported for the forward observation. format: double discount_rate: type: number description: Discount-rate value reported for the forward observation. format: double adjusted_strike: type: number description: Optional adjusted strike reported for this forward date. format: double nullable: true spot_date: type: string description: Spot date used for the forward observation. format: date-time settlement_date: type: string description: Settlement date used for the forward observation. format: date-time $type: type: string enum: - >- Derivitec.Web.Core.MarketData.EquityForwardPoint, Derivitec.Web.Core additionalProperties: false description: >- Dated equity forward observation with discount, borrow, dividend, and settlement context. 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 ````