> ## 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 fully described equity market data. > Use this operation when callers need complete equity market data for requested identifiers, descriptors, and market dates rather than raw stock observations. Each descriptor is associated with an identifier and can control the required history. Results can include data from authorised provider scopes, with Derivitec fallback; this is read-only. ## OpenAPI ````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetEquities 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/GetEquities: post: tags: - MarketData summary: Retrieve fully described equity market data. description: >- Use this operation when callers need complete equity market data for requested identifiers, descriptors, and market dates rather than raw stock observations. Each descriptor is associated with an identifier and can control the required history. Results can include data from authorised provider scopes, with Derivitec fallback; this is read-only. operationId: GetEquities requestBody: description: >- The query payload. `Identifiers`, date-only `MarketDates`, and identifier-to-`Descriptor` pairs must all be non-empty; provider or environment fields select authorised sources. content: application/json-patch+json: schema: $ref: '#/components/schemas/ApiGetEquitiesRequest' application/json: schema: $ref: '#/components/schemas/ApiGetEquitiesRequest' text/json: schema: $ref: '#/components/schemas/ApiGetEquitiesRequest' application/*+json: schema: $ref: '#/components/schemas/ApiGetEquitiesRequest' responses: '200': description: >- Returns available equity assets with their requested market data and any invalid-provider, unsupported-identifier, missing-asset, or retrieval errors. content: application/json: schema: $ref: '#/components/schemas/ApiGetEquitiesResponse' '400': description: BadRequest '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] - apikey: [] components: schemas: ApiGetEquitiesRequest: 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 equities are requested. nullable: true market_dates: type: array items: type: string format: date-time description: Market dates on which equities are requested. nullable: true descriptors: type: array items: $ref: >- #/components/schemas/InstrumentIdentifierEquityDescriptorKeyValuePair description: Structured selectors for the requested equities. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.ApiGetEquitiesRequest, Derivitec.Web.Core additionalProperties: false description: >- Queries equity market data by identifier or descriptor across market dates. ApiGetEquitiesResponse: 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 equities: type: array items: $ref: '#/components/schemas/Equity' description: Equity market-data records returned by the query. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.ApiGetEquitiesResponse, Derivitec.Web.Core additionalProperties: false description: Returns equity market-data records 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' InstrumentIdentifierEquityDescriptorKeyValuePair: type: object properties: key: $ref: '#/components/schemas/InstrumentIdentifier' value: $ref: '#/components/schemas/EquityDescriptor' additionalProperties: false Equity: 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 reference_date: type: string description: Date to which the data applies. format: date-time borrow_curve: $ref: '#/components/schemas/BorrowCurve' dividends: $ref: '#/components/schemas/Dividends' fixings: $ref: '#/components/schemas/Fixings' futures_date: type: string description: Date of the futures quote carried for the equity. format: date-time futures_price: type: number description: Futures quote carried for the equity. format: double fx_cross_map: type: object additionalProperties: $ref: '#/components/schemas/FxCross' description: >- FX-pair market data made available for constituent currency conversion. nullable: true holiday_calendar: $ref: '#/components/schemas/Calendar' name: $ref: '#/components/schemas/InstrumentIdentifier' roll_fixing: type: number description: Fixing value carried for roll treatment. format: double settlement_lag: type: integer description: Settlement-lag count for the equity. format: int32 yield_curve: $ref: '#/components/schemas/DiscountCurve' divisor: type: number description: Divisor carried for index or basket aggregation. Defaults to 1. format: double constituents: type: array items: type: string description: >- Constituent codes carried when the equity represents an index or basket. nullable: true currencies: type: object additionalProperties: type: string nullable: true description: Constituent-currency mapping carried for an index or basket. nullable: true shares: type: object additionalProperties: type: number format: double description: Constituent share amounts keyed by constituent code. nullable: true weights: type: object additionalProperties: type: number format: double description: Constituent weights keyed by constituent code. nullable: true spots: type: object additionalProperties: type: number format: double description: Constituent spot observations keyed by constituent code. nullable: true is_index: type: boolean description: Whether this equity record represents an index. example: false index_premium: type: number description: >- Premium adjustment carried when the equity represents an index. Defaults to 0. format: double $type: type: string enum: - Derivitec.Web.Core.MarketData.Equity, Derivitec.Web.Core additionalProperties: false description: >- Equity or equity-index market data with curves, fixings, settlement details, and optional constituent data. 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. EquityDescriptor: required: - $type type: object properties: dividend_end_date: type: string description: >- Last date included when selecting dividend data. Defaults to no upper bound. format: date-time dividend_start_date: type: string description: >- First date included when selecting dividend data. Defaults to no lower bound. format: date-time spot_fixing_end_date: type: string description: >- Last date included when selecting equity spot fixings. Defaults to no upper bound. format: date-time spot_fixing_start_date: type: string description: >- First date included when selecting equity spot fixings. Defaults to no lower bound. format: date-time include_index_component_data: type: boolean description: Whether index or basket component data is requested. example: false include_index_constituent_spots: type: boolean description: >- Whether spot observations for index or basket constituents are requested. example: false $type: type: string enum: - Derivitec.Web.Core.MarketData.EquityDescriptor, Derivitec.Web.Core additionalProperties: false description: >- Date windows and index-detail switches used when selecting equity market data. BorrowCurve: 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 asset_name: type: string description: Asset name. nullable: true discount_factors: type: array items: type: number format: double description: Dimensionless curve factors paired by index with Maturities. nullable: true extrapolate: type: boolean description: >- Whether the curve may be evaluated beyond its supplied maturities; initialized to true. maturities: type: array items: type: integer format: int32 description: >- Maturities expressed as day offsets and paired by index with DiscountFactors. nullable: true value_date: type: string description: Curve value date. format: date-time $type: type: string enum: - Derivitec.Web.Core.MarketData.BorrowCurve, Derivitec.Web.Core additionalProperties: false description: >- Asset borrow curve represented by day-offset maturities and dimensionless discount factors. Dividends: 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 all_in_rates: type: array items: type: number format: double description: All-in rates aligned by index with ExDates. nullable: true asset_ids: type: array items: $ref: '#/components/schemas/InstrumentIdentifier' description: >- Asset identifiers aligned by index with ExDates; reconstruction supplies empty identifiers only when this collection is empty. nullable: true cash_divs: type: array items: type: number format: double description: Cash-dividend inputs aligned by index with ExDates. nullable: true confirmed_flags: type: array items: type: boolean description: Confirmation flags aligned by index with ExDates. nullable: true currencies: type: array items: type: string description: Currencies aligned by index with ExDates. nullable: true declared_dates: type: array items: type: string format: date-time description: Declaration dates aligned by index with ExDates. nullable: true div_types: type: array items: enum: - Regular - Extraordinary - Scrip type: string description: Classifies a dividend as regular, extraordinary, or scrip. description: Dividend classifications aligned by index with ExDates. nullable: true div_yields: type: array items: type: number format: double description: Dividend-yield inputs aligned by index with ExDates. nullable: true ex_dates: type: array items: type: string format: date-time description: >- Ex-dividend dates; their indexes define the rows reconstructed from the parallel collections. nullable: true pay_dates: type: array items: type: string format: date-time description: Payment dates aligned by index with ExDates. nullable: true record_dates: type: array items: type: string format: date-time description: Record dates aligned by index with ExDates. nullable: true withholding_tax_rates: type: array items: type: number format: double description: >- Withholding-tax rates aligned by index with ExDates; reconstruction supplies zero rates only when this collection is empty. nullable: true reference_date: type: string description: Date to which this projected-dividend set applies. format: date-time $type: type: string enum: - Derivitec.Web.Core.MarketData.Dividends, Derivitec.Web.Core additionalProperties: false description: >- Columnar projected-dividend data whose per-dividend collections are consumed at matching indexes. Fixings: required: - $type type: object properties: asset_id: type: string description: Series code to which the fixing observations belong. nullable: true dates: type: array items: type: string description: Observation dates in the fixing series. nullable: true values: type: array items: type: number format: double description: Observed values in the fixing series. nullable: true $type: type: string enum: - Derivitec.Web.Core.MarketData.Fixings, Derivitec.Web.Core additionalProperties: false description: Dated observations for one market-data series. FxCross: 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 reference_date: type: string description: Date to which the data applies. format: date-time domestic_discount_curve: $ref: '#/components/schemas/DiscountCurve' fixings_by_source: type: array items: $ref: '#/components/schemas/StringFixingsKeyValuePair' description: Source labels paired with fixing series for the FX pair. nullable: true high_fixings_by_source: type: array items: $ref: '#/components/schemas/StringFixingsKeyValuePair' description: Source labels paired with high-observation fixing series. nullable: true low_fixings_by_source: type: array items: $ref: '#/components/schemas/StringFixingsKeyValuePair' description: Source labels paired with low-observation fixing series. nullable: true fx_pair: type: string description: Currency-pair code represented by this market data. nullable: true roll_fixing: type: number description: Fixing value carried for roll treatment. format: double settlement: $ref: '#/components/schemas/FxSettlement' spot: type: number description: Spot observation carried for the FX pair. format: double foreign_discount_curve: $ref: '#/components/schemas/DiscountCurve' is_quoted_fx_cross: type: boolean description: Whether the pair is marked as the quoted FX-cross orientation. example: false $type: type: string enum: - Derivitec.Web.Core.MarketData.FxCross, Derivitec.Web.Core additionalProperties: false description: >- FX-pair market data with spot, discount curves, settlement details, and fixing series. Calendar: description: Named business-day calendar with holiday dates and weekend treatment. discriminator: propertyName: $type mapping: Derivitec.Web.Core.StaticData.Calendar, Derivitec.Web.Core: '#/components/schemas/CalendarMintlifyShape' Derivitec.Web.Core.StaticData.CalendarIntersection, Derivitec.Web.Core: '#/components/schemas/CalendarIntersection' Derivitec.Web.Core.StaticData.CalendarUnion, Derivitec.Web.Core: '#/components/schemas/CalendarUnion' oneOf: - $ref: '#/components/schemas/CalendarMintlifyShape' - $ref: '#/components/schemas/CalendarIntersection' - $ref: '#/components/schemas/CalendarUnion' DiscountCurve: 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 currency: type: string description: Currency represented by the discount curve. nullable: true curve_name: type: string description: Name distinguishing the curve within its currency. nullable: true discount_factors: type: array items: type: number format: double description: Dimensionless discount factors paired by index with Maturities. nullable: true extrapolate: type: boolean description: >- Whether the curve may be evaluated beyond its supplied maturities; initialized to true. maturities: type: array items: type: integer format: int32 description: >- Maturities expressed as day offsets and paired by index with DiscountFactors. nullable: true value_date: type: string description: Curve value date. format: date-time $type: type: string enum: - Derivitec.Web.Core.MarketData.DiscountCurve, Derivitec.Web.Core additionalProperties: false description: >- Named currency discount curve represented by day-offset maturities and dimensionless discount factors. StringFixingsKeyValuePair: type: object properties: key: type: string nullable: true value: $ref: '#/components/schemas/Fixings' additionalProperties: false FxSettlement: required: - $type type: object properties: domestic_calendar: $ref: '#/components/schemas/Calendar' foreign_calendar: $ref: '#/components/schemas/Calendar' is_special_lat_am_cross: type: boolean description: >- Whether the settlement marks the foreign currency as a special Latin American currency. settlement_lag: type: integer description: >- Settlement lag for the currency pair; unit and adjustment rule are not defined here. format: int32 usd_calendar: $ref: '#/components/schemas/Calendar' $type: type: string enum: - Derivitec.Web.Core.StaticData.FxSettlement, Derivitec.Web.Core additionalProperties: false description: >- Calendar and lag terms used to determine settlement for a foreign-exchange pair. CalendarMintlifyShape: required: - $type type: object properties: holidays: type: array items: type: string format: date-time description: Dates treated as holidays by the calendar. nullable: true include_weekends: type: boolean description: >- Whether weekend dates are included in the calendar's non-business-day set. name: type: string description: Name of the business-day calendar. nullable: true $type: type: string enum: - Derivitec.Web.Core.StaticData.Calendar, Derivitec.Web.Core additionalProperties: false description: Named business-day calendar with holiday dates and weekend treatment. CalendarIntersection: required: - $type type: object properties: holidays: type: array items: type: string format: date-time description: Dates treated as holidays by the calendar. nullable: true include_weekends: type: boolean description: >- Whether weekend dates are included in the calendar's non-business-day set. name: type: string description: Name of the business-day calendar. nullable: true calendars: type: array items: $ref: '#/components/schemas/Calendar' description: Gets or sets the list of underlying calendars in the intersection. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.StaticData.CalendarIntersection, Derivitec.Web.Core additionalProperties: false description: The calendar intersection. CalendarUnion: required: - $type type: object properties: holidays: type: array items: type: string format: date-time description: Dates treated as holidays by the calendar. nullable: true include_weekends: type: boolean description: >- Whether weekend dates are included in the calendar's non-business-day set. name: type: string description: Name of the business-day calendar. nullable: true calendars: type: array items: $ref: '#/components/schemas/Calendar' description: Gets or sets the list of underlying calendars in the union. nullable: true $type: type: string enum: - Derivitec.Web.Core.StaticData.CalendarUnion, Derivitec.Web.Core additionalProperties: false description: The calendar union. 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 ````