> ## 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 reference and market details.

> Use this operation for identifiers, name, country, currency, sector/industry, trading calendar, settlement
lag, spot, market capitalisation, and share figures for one equity and market date. Missing textual values
are represented as `N/A`; a missing spot is represented as zero. Provider/environment selection applies
to market-sensitive fields. 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/Equity/GetEquityInfo
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/GetEquityInfo:
    post:
      tags:
        - Equity
      summary: Retrieve equity reference and market details.
      description: >-
        Use this operation for identifiers, name, country, currency,
        sector/industry, trading calendar, settlement

        lag, spot, market capitalisation, and share figures for one equity and
        market date. Missing textual values

        are represented as `N/A`; a missing spot is represented as zero.
        Provider/environment selection applies

        to market-sensitive fields. The operation is read-only and completes
        before returning.
      operationId: GetEquityInfo
      requestBody:
        description: >-
          A supported equity `Identifier`, date-only `MarketDate`, and one
          authorised provider-selector form.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiEquityGetInfoRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiEquityGetInfoRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiEquityGetInfoRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiEquityGetInfoRequest'
      responses:
        '200':
          description: >-
            Returns available equity reference and market details, including the
            `N/A`/zero placeholder model when reference data is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiEquityGetInfoResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiEquityGetInfoRequest:
      required:
        - $type
      type: object
      additionalProperties: false
      description: >-
        Selects an equity and market-data date for descriptive, quote,
        share-count, and settlement details.
      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
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest,
              Derivitec.Web.Core
    ApiEquityGetInfoResponse:
      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
        cik:
          type: string
          description: Central Index Key, or the literal N/A when none is available.
          nullable: true
        country:
          type: string
          description: Country of origin, or the literal N/A when none is available.
          nullable: true
        currency:
          type: string
          description: >-
            Recorded trading currency code, or the literal N/A when none is
            available.
          nullable: true
        bbg_code:
          type: string
          description: Bloomberg code, or the literal N/A when none is available.
          nullable: true
        cusip:
          type: string
          description: CUSIP code, or the literal N/A when none is available.
          nullable: true
        identifier:
          type: string
          description: Equity identifier resolved from the request.
          nullable: true
        isin:
          type: string
          description: ISIN code, or the literal N/A when none is available.
          nullable: true
        name:
          type: string
          description: Equity name, or the literal N/A when none is available.
          nullable: true
        ric:
          type: string
          description: >-
            Reuters Instrument Code from the equity details; unlike the other
            text fields, a missing value is not replaced with N/A.
          nullable: true
        sector:
          type: string
          description: Sector classification, or the literal N/A when none is available.
          nullable: true
        industry:
          type: string
          description: Industry classification, or the literal N/A when none is available.
          nullable: true
        shares_outstanding:
          type: string
          description: >-
            Display text for the latest available outstanding-share count, using
            B/M abbreviations or grouped whole numbers; N/A when unavailable.
          nullable: true
        market_cap:
          type: string
          description: >-
            Market-capitalisation display text with a currency prefix and B/M
            abbreviation where applicable; N/A when unavailable.
          nullable: true
        free_float_shares:
          type: string
          description: >-
            Display text for the latest available free-float share count, using
            B/M abbreviations or grouped whole numbers; N/A when unavailable.
          nullable: true
        share_capital:
          type: string
          description: Share-capital display text, currently the literal N/A.
          nullable: true
        spot:
          type: number
          description: >-
            Latest available spot quote on or before the market-data date; zero
            is returned when unavailable.
          format: double
        stock_lag:
          type: integer
          description: >-
            Settlement lag returned when equity details are found; otherwise
            zero. The public contract does not establish its unit.
          format: int64
        trading_calendar:
          type: string
          description: >-
            Calendar identifier for display and holiday lookup, taken from the
            saved equity for the requested date and providers.

            If unavailable, uses the current StockInfo.HolidayCalendarId for
            either stocks or indices when non-empty, otherwise the index
            exchange

            or stock market identification code. N/A when no identifier is
            available.
          nullable: true
        treasury_shares:
          type: string
          description: >-
            Treasury-share display text using B/M abbreviations, grouped whole
            numbers, or N/A.
          nullable: true
        market_data_date:
          type: string
          description: >-
            Market-data date copied from the request when equity details are
            found; otherwise the response retains the default date value.
          format: date-time
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiEquityGetInfoResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns descriptive and market details for the selected equity.
    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'
    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

````