> ## 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 client-visible stock reference details.

> Use this operation to retrieve reference details such as name, currency, listing venue, geography, sector,
and share attributes for requested equity identifiers. Repeated identifiers do not produce repeated entries.
The response exposes the supported attributes and reports unsupported identifiers.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetStockInfo
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/GetStockInfo:
    post:
      tags:
        - MarketData
      summary: Retrieve client-visible stock reference details.
      description: >-
        Use this operation to retrieve reference details such as name, currency,
        listing venue, geography, sector,

        and share attributes for requested equity identifiers. Repeated
        identifiers do not produce repeated entries.

        The response exposes the supported attributes and reports unsupported
        identifiers.
      operationId: GetStockInfo
      requestBody:
        description: >-
          The query payload containing a non-empty collection of equity
          `Identifiers`. Returned details are limited to those available to the
          caller's organisation or in shared Derivitec reference data.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetStockInfoRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetStockInfoRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetStockInfoRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetStockInfoRequest'
      responses:
        '200':
          description: >-
            Returns available stock reference details keyed by input identifier
            and any unsupported-identifier or retrieval errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetStockInfoResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetStockInfoRequest:
      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: Equity selectors whose reference details are requested.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetStockInfoRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Queries equity reference details by structured equity selector.
    ApiGetStockInfoResponse:
      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
        stock_info:
          type: array
          items:
            $ref: '#/components/schemas/InstrumentIdentifierStockInfoKeyValuePair'
          description: >-
            Equity reference details keyed by the requested instrument
            selectors.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetStockInfoResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Returns equity reference details keyed by the requested instrument
        selectors.
    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'
    InstrumentIdentifierStockInfoKeyValuePair:
      type: object
      properties:
        key:
          $ref: '#/components/schemas/InstrumentIdentifier'
        value:
          $ref: '#/components/schemas/StockInfo'
      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.
    StockInfo:
      required:
        - $type
        - id
        - name
        - ric
      type: object
      properties:
        asset_ratio_against:
          type: number
          description: Optional asset-ratio denominator recorded for the equity.
          format: double
          nullable: true
        asset_ratio_for:
          type: number
          description: Optional asset-ratio numerator recorded for the equity.
          format: double
          nullable: true
        bbg_code:
          type: string
          description: Bloomberg code recorded for the equity.
          nullable: true
        cik:
          type: string
          description: CIK recorded for the issuer.
          nullable: true
        consolidated_id:
          type: string
          description: Consolidated identifier recorded for the equity.
          nullable: true
        is_listed_primary_issue:
          type: boolean
          description: Whether the listing is marked as the issuer's primary issue.
        country:
          type: string
          description: Country of the listing exchange.
          nullable: true
        country_of_domicile:
          type: string
          description: Country in which the issuer is managed.
          nullable: true
        country_of_incorporation:
          type: string
          description: Country in which the issuer is incorporated.
          nullable: true
        country_of_risk:
          type: string
          description: Country-of-risk classification for the issuer.
          nullable: true
        currency:
          type: string
          description: Currency code recorded for the equity.
          nullable: true
        cusip:
          type: string
          description: CUSIP recorded for the equity.
          nullable: true
        id:
          minLength: 1
          type: string
          description: Required asset identifier of the equity.
        isin:
          type: string
          description: ISIN recorded for the equity.
          nullable: true
        issuer_id:
          type: string
          description: Issuer identifier of the equity.
          nullable: true
        issuer_name:
          type: string
          description: Display name of the issuer.
          nullable: true
        market_identification_code:
          type: string
          description: Market identification code of the listing.
          nullable: true
        operating_mic:
          type: string
          description: Operating market identification code of the listing venue.
          nullable: true
        morning_star_industry:
          type: string
          description: Morningstar sub-industry classification.
          nullable: true
        morning_star_industry_group:
          type: string
          description: Morningstar industry-group classification.
          nullable: true
        name:
          minLength: 1
          type: string
          description: Required display name of the equity.
        reuters_issuer_org_id:
          type: string
          description: Reuters issuer-organisation code recorded for the equity.
          nullable: true
        ric:
          minLength: 1
          type: string
          description: Required Reuters Instrument Code of the equity.
        region_of_domicile:
          type: string
          description: Region corresponding to the country of domicile.
          nullable: true
        region_of_incorporation:
          type: string
          description: Region corresponding to the country of incorporation.
          nullable: true
        region_of_risk:
          type: string
          description: Region corresponding to the country of risk.
          nullable: true
        sector:
          type: string
          description: Sector classification recorded for the equity.
          nullable: true
        share_class:
          type: string
          description: Share-class label recorded for the equity.
          nullable: true
        stock_lag:
          type: integer
          description: Settlement-lag count recorded for the stock.
          format: int32
        suspended:
          type: boolean
          description: Whether the equity is marked as suspended. Defaults to false.
        valoren:
          type: string
          description: Valoren code recorded for the equity.
          nullable: true
        voting_rights_per_share:
          type: number
          description: Optional voting-rights amount per share.
          format: double
          nullable: true
        x_ignite_option_code:
          type: string
          description: Xignite option code recorded for the equity.
          nullable: true
        x_ignite_stock_code:
          type: string
          description: Xignite stock code recorded for the equity.
          nullable: true
        x_ignite_option_file_code:
          type: string
          description: Xignite option-file code recorded for the equity.
          nullable: true
        option_metrics_security_id:
          type: string
          description: OptionMetrics security code recorded for the equity.
          nullable: true
        option_metrics_exchange_id:
          type: string
          description: OptionMetrics exchange code recorded for the equity.
          nullable: true
        edi_sec_id:
          type: string
          description: EDI security identifier recorded for the equity.
          nullable: true
        edi_symbol:
          type: string
          description: EDI symbol recorded for the equity.
          nullable: true
        provider_id:
          type: string
          description: >-
            Market-data provider code from which the reference data originated.
            Defaults to Derivitec.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.StockInfo, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Equity reference data, classifications, listing details, and supported
        identifier codes.
  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

````