---
title: "Get Basic Reference view"
url: "https://developer-beta.morningstar.com/apis/investment-details-api/versions/1101e487-2040-43e8-8548-06647294be56/operations/getBasicReferencePackage"
---

> Full API specification: https://developer-beta.morningstar.com/apis/investment-details-api/versions/1101e487-2040-43e8-8548-06647294be56.md

# Get Basic Reference view

`GET` `/direct-web-services/v1/investments/{id}/basic-reference`

Operation ID: `getBasicReferencePackage`

Most recent data supported.

## Path parameters

- `id` (string, required) - Specifies the investment to query. Morningstar Performance ID is the default identifer for the API. Use the Universe API to retrieve Performance IDs for investments in your entitled universe.

## Query parameters

- `idType` (string, optional) - Specifies the type of the value passed in the `id` parameter. Morningstar Performance ID is the default identifer for the API. Use the Universe API to retrieve Performance IDs for investments in your entitled universe.
- `baseCurrency` (string, optional) - Base currency to use for investment lookup. Accepts 3‑character ISO 4217 currency codes.
- `domicile` (string, optional) - Domicile to use for investment lookup. Accepts 3-character ISO 3166-1 country codes.
- `exchangeCountry` (string, optional) - Exchange country to use for investment lookup. Accepts 3-character ISO 3166-1 country codes.
- `exchangeId` (string, optional) - Exchange identifier to use for investment lookup.
- `startDate` (string, yyyy-MM-dd, optional) - Time series start date. Accepts `yyyy-MM-dd`.
- `endDate` (string, yyyy-MM-dd, optional) - Time series end date. Accepts `yyyy-MM-dd`.
- `languageId` (string, optional) - Language to filter results by. Language support varies depending on the data and package. - `ENG` = English - `SPA` = Spanish - `FRA` = French - `DEU` = German - `ITA` = Italian - `JPN` = Japanese - `CHI` = Chinese Simplified - `ZHO` = Chinese Traditional - `KOR` = Korean

## Responses

- `200` - OK
- `400` - Bad Request
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Investment Details API
  version: "1.0"
servers:
  - url: https://www.us-api.morningstar.com
    description: Americas
  - url: https://www.apac-api.morningstar.com
    description: APAC
  - url: https://www.emea-api.morningstar.com
    description: EMEA
paths:
  /direct-web-services/v1/investments/{id}/basic-reference:
    get:
      summary: Get Basic Reference view
      parameters:
        - name: id
          in: path
          description: >-
            
            Specifies the investment to query. 

            Morningstar Performance ID is the default identifer for the API. Use
            the Universe API to retrieve Performance IDs for investments in your
            entitled universe.
          required: true
          schema:
            type: string
            example: 0P00000046
          examples:
            performanceId:
              summary: Morningstar Performance ID
              value: 0P00000046
            isin:
              summary: ISIN
              value: US0042391096
        - name: idType
          in: query
          description: >-
            Specifies the type of the value passed in the `id` parameter.

            Morningstar Performance ID is the default identifer for the API. Use
            the Universe API to retrieve Performance IDs for investments in your
            entitled universe.
          schema:
            enum:
              - performanceId
              - isin
              - securityId
              - cusip
              - tradingSymbol
              - fundCode
              - msid
            type: string
            default: performanceId
        - name: baseCurrency
          in: query
          description: Base currency to use for investment lookup. Accepts 3‑character ISO
            4217 currency codes.
          schema:
            type: string
          examples:
            baseCurrencyExample1:
              summary: US Dollar
              value: USD
            baseCurrencyExample2:
              summary: Swiss Franc
              value: CHF
        - name: domicile
          in: query
          description: Domicile to use for investment lookup. Accepts 3-character ISO
            3166-1 country codes.
          schema:
            type: string
          examples:
            domicileExample1:
              summary: CAN (Canada)
              value: CAN
            domicileExample2:
              summary: JPN (Japan)
              value: JPN
            domicileExample3:
              summary: USE (United States)
              value: USA
        - name: exchangeCountry
          in: query
          description: Exchange country to use for investment lookup. Accepts 3-character
            ISO 3166-1 country codes.
          schema:
            type: string
          examples:
            exchangeCountryExample1:
              summary: CAN (Canada)
              value: CAN
            exchangeCountryExample2:
              summary: JPN (Japan)
              value: JPN
            exchangeCountryExample3:
              summary: USA (USA)
              value: USA
        - name: exchangeId
          in: query
          description: Exchange identifier to use for investment lookup.
          schema:
            type: string
            externalDocs:
              description: List of exchange IDs.
              url: https://developer.morningstar.com/content/hidden-from-navigation/DwsIdLookUpExchangeIds.xlsx
          examples:
            exchangeIdExample1:
              summary: NASDAQ - ALL Markets (NAS)
              value: EX$$$$XNAS
            exchangeIdExample2:
              summary: London Stock Exchange (LSE)
              value: EX$$$$XLON
        - name: startDate
          in: query
          schema:
            type: string
            format: yyyy-MM-dd
          description: Time series start date. Accepts `yyyy-MM-dd`.
          examples:
            startDateExample1:
              summary: Example 1
              value: 2025-06-01T00:00:00.000Z
            startDateExample2:
              summary: Example 2
              value: 2025-06-30T00:00:00.000Z
        - name: endDate
          in: query
          schema:
            type: string
            format: yyyy-MM-dd
          description: Time series end date. Accepts `yyyy-MM-dd`.
          examples:
            endDateExample1:
              summary: Example 1
              value: 2025-12-01T00:00:00.000Z
            endDateExample2:
              summary: Example 2
              value: 2025-12-31T00:00:00.000Z
        - name: languageId
          in: query
          description: >-
            
            Language to filter results by. Language support varies depending on
            the data and package.

              - `ENG` = English
              - `SPA` = Spanish
              - `FRA` = French
              - `DEU` = German
              - `ITA` = Italian
              - `JPN` = Japanese
              - `CHI` = Chinese Simplified
              - `ZHO` = Chinese Traditional
              - `KOR` = Korean
          schema:
            type: string
            example: ENG
            x-enumDescriptions:
              ENG: English
              SPA: Spanish
              FRA: French
              DEU: German
              ITA: Italian
              JPN: Japanese
              CHI: Chinese Simplified
              ZHO: Chinese Traditional
              KOR: Korean
          examples:
            languageExample1:
              summary: English
              value: ENG
            languageExample2:
              summary: Spanish
              value: SPA
            languageExample3:
              summary: French
              value: FRA
            languageExample4:
              summary: German
              value: DEU
            languageExample5:
              summary: Italian
              value: ITA
            languageExample6:
              summary: Japanese
              value: JPN
            languageExample7:
              summary: Chinese Simplified
              value: CHI
            languageExample8:
              summary: Chinese Traditional
              value: ZHO
            languageExample9:
              summary: Korean
              value: KOR
      description: Most recent data supported.
      operationId: getBasicReferencePackage
      tags:
        - Investment Details
      responses:
        "200":
          $ref: "#/components/responses/ResponseBasicReference"
        "400":
          $ref: "#/components/responses/ResponseBadRequest"
        "500":
          $ref: "#/components/responses/ResponseInternalServerError"
      x-cpqId: 1
security:
  - Bearer: []
components:
  responses:
    ResponseBasicReference:
      description: OK
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ResponseBasicReference"
    ResponseBadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OutputErrorDetails"
    ResponseInternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OutputErrorDetails"
  schemas:
    ResponseBasicReference:
      type: object
      properties:
        basicReference:
          $ref: "#/components/schemas/OutputBasicReference"
        identifiers:
          $ref: "#/components/schemas/OutputIdentifiers"
        metadata:
          $ref: "#/components/schemas/OutputMetadata"
    OutputErrorDetails:
      type: object
      properties:
        statusCode:
          type: integer
          description: Status Code
          format: int32
        errorCode:
          type: string
          description: Custom error code
          nullable: true
        message:
          type: string
          description: Message
          nullable: true
        requestId:
          type: string
          description: RequestId
          nullable: true
      additionalProperties: false
      description: Error details
      title: OutputErrorDetails
    OutputBasicReference:
      type: object
      properties:
        assetsUnderAdvisementDate:
          type: string
          description: ""
          nullable: true
        associatedShareClass:
          type: string
          description: ""
          nullable: true
        baseCurrency:
          $ref: "#/components/schemas/CodeMappingString"
        baseUnit:
          type: number
          description: ""
          format: double
          nullable: true
        brandingCompanyAsOfDate:
          type: string
          description: ""
          nullable: true
        brandingName:
          type: string
          description: ""
          nullable: true
        brandingNameId:
          type: string
          description: ""
          nullable: true
        caFundCode:
          type: string
          description: ""
          nullable: true
        countryAfsPerformanceLevel:
          type: array
          items:
            $ref: "#/components/schemas/CodeMappingString"
          description: ""
          nullable: true
        countryAvailableForSale:
          type: array
          items:
            $ref: "#/components/schemas/CodeMappingString"
          description: ""
          nullable: true
        countryRegisteredForSale:
          type: array
          items:
            $ref: "#/components/schemas/CodeMappingString"
          description: ""
          nullable: true
        custodianFee:
          type: number
          description: ""
          format: double
          nullable: true
        custodianFeeAmountCn:
          type: integer
          description: ""
          format: int32
          nullable: true
        delistingDate:
          type: string
          description: ""
          nullable: true
        domicile:
          $ref: "#/components/schemas/CodeMappingString"
        domicileCountry:
          $ref: "#/components/schemas/CodeMappingString"
        externalManagementCompany:
          type: string
          description: ""
          nullable: true
        firmLegalStructure:
          $ref: "#/components/schemas/CodeMappingString"
        firmName:
          type: string
          description: ""
          nullable: true
        firmNameId:
          type: string
          description: ""
          nullable: true
        firmType:
          $ref: "#/components/schemas/CodeMappingString"
        fundCode:
          type: string
          description: ""
          nullable: true
        fundid:
          type: string
          description: ""
          nullable: true
        fundLegalName:
          type: string
          description: ""
          nullable: true
        fundLegalStructure:
          $ref: "#/components/schemas/CodeMappingString"
        fundStandardName:
          type: string
          description: ""
          nullable: true
        germanWkn:
          type: string
          description: ""
          nullable: true
        grossAssetsCurrency:
          $ref: "#/components/schemas/CodeMappingString"
        iaPrimaryShareClass:
          $ref: "#/components/schemas/CodeMappingString"
        inceptionDate:
          type: string
          description: ""
          nullable: true
        inceptionDateOfFundSOldestShareClass:
          type: string
          description: ""
          nullable: true
        indexFamilyId:
          type: string
          description: ""
          nullable: true
        indexFamilyName:
          type: string
          description: ""
          nullable: true
        investmentType:
          $ref: "#/components/schemas/CodeMappingString"
        ipoAssetRaised:
          type: number
          description: ""
          format: double
          nullable: true
        ipoEndDate:
          type: string
          description: ""
          nullable: true
        ipoStartDate:
          type: string
          description: ""
          nullable: true
        isin:
          type: string
          description: ""
          nullable: true
        secId:
          type: string
          description: ""
          nullable: true
        itaCode:
          type: string
          description: ""
          nullable: true
        latestAccountingDate:
          type: string
          description: ""
          nullable: true
        legalName:
          type: string
          description: ""
          nullable: true
        lifeTriggerEventDate:
          type: string
          description: ""
          nullable: true
        lifeTriggerEventType:
          $ref: "#/components/schemas/CodeMappingString"
        listingDate:
          type: string
          description: ""
          nullable: true
        localFirmNameJp:
          type: string
          description: ""
          nullable: true
        localFirmNameKr:
          type: string
          description: ""
          nullable: true
        localFirmShortNameJp:
          type: string
          description: ""
          nullable: true
        localFundLegalNameKr:
          type: string
          description: ""
          nullable: true
        localLegalNameJp:
          type: string
          description: ""
          nullable: true
        localLegalNameKr:
          type: string
          description: ""
          nullable: true
        localNameAfrikaans:
          type: string
          description: ""
          nullable: true
        localNameCn:
          type: string
          description: ""
          nullable: true
        localNameHebrew:
          type: string
          description: ""
          nullable: true
        localNameHk:
          type: string
          description: ""
          nullable: true
        localNameJp:
          type: string
          description: ""
          nullable: true
        localNameKr:
          type: string
          description: ""
          nullable: true
        localNameSg:
          type: string
          description: ""
          nullable: true
        localNameThai:
          type: string
          description: ""
          nullable: true
        localNameTw:
          type: string
          description: ""
          nullable: true
        masterFundid:
          type: string
          description: ""
          nullable: true
        masterPortfolioId:
          type: integer
          description: ""
          format: int32
          nullable: true
        maximumSwingFactorDownwards:
          type: number
          description: ""
          format: double
          nullable: true
        maximumSwingFactorUpwards:
          type: number
          description: ""
          format: double
          nullable: true
        mexCode:
          type: string
          description: ""
          nullable: true
        name:
          type: string
          description: ""
          nullable: true
        nameOfFundSOldestShareClass:
          type: string
          description: ""
          nullable: true
        obsoleteDate:
          type: string
          description: ""
          nullable: true
        obsoleteType:
          $ref: "#/components/schemas/CodeMappingString"
        oldestShareClass:
          $ref: "#/components/schemas/CodeMappingString"
        operationsDataReady:
          $ref: "#/components/schemas/CodeMappingString"
        performanceDataReady:
          $ref: "#/components/schemas/CodeMappingString"
        performanceId:
          type: string
          description: ""
          nullable: true
        performanceStartDate:
          type: string
          description: ""
          nullable: true
        pieConversionDate:
          type: string
          description: ""
          nullable: true
        portfolioCurrency:
          $ref: "#/components/schemas/CodeMappingString"
        portfolioDataReady:
          $ref: "#/components/schemas/CodeMappingString"
        portfolioDate:
          type: string
          description: ""
          nullable: true
        previousNameOfFirm:
          type: string
          description: ""
          nullable: true
        priceDataReady:
          $ref: "#/components/schemas/CodeMappingString"
        primaryShare:
          $ref: "#/components/schemas/CodeMappingString"
        priorFirmName:
          type: string
          description: ""
          nullable: true
        productFocus:
          $ref: "#/components/schemas/CodeMappingString"
        regionOfSale:
          $ref: "#/components/schemas/CodeMappingString"
        registrationDateTw:
          type: string
          description: ""
          nullable: true
        restructureDate:
          type: string
          description: ""
          nullable: true
        secidForImport:
          type: string
          description: ""
          nullable: true
        seriesName:
          type: string
          description: ""
          nullable: true
        shareClassType:
          $ref: "#/components/schemas/CodeMappingString"
        sharesPercDateCn:
          type: string
          description: ""
          nullable: true
        status:
          $ref: "#/components/schemas/CodeMappingString"
        swissValor:
          type: string
          description: ""
          nullable: true
        ticker:
          type: string
          description: ""
          nullable: true
        tickerOfFundSOldestShareClass:
          type: string
          description: ""
          nullable: true
        underlyingFundInceptionDate:
          type: string
          description: ""
          nullable: true
        underlyingFundName:
          type: string
          description: ""
          nullable: true
        underlyingFundSecid:
          type: string
          description: ""
          nullable: true
        usHeadquarters:
          type: string
          description: ""
          nullable: true
        valuationCountry:
          $ref: "#/components/schemas/CodeMappingString"
        virtualClass:
          $ref: "#/components/schemas/CodeMappingString"
        previousName:
          type: string
          description: ""
          nullable: true
        previousNameEndDate:
          type: string
          description: ""
          nullable: true
        baseCurrencyVa:
          $ref: "#/components/schemas/CodeMappingString"
        statusId:
          $ref: "#/components/schemas/CodeMappingInt"
      additionalProperties: false
      title: OutputBasicReference
      description: All fields are nullable. Empty or `null` value fields are not returned.
    OutputIdentifiers:
      type: object
      properties:
        performanceId:
          type: string
          nullable: true
        securityId:
          type: string
          nullable: true
        cusip:
          type: string
          nullable: true
        isin:
          type: string
          nullable: true
        sedol:
          type: string
          nullable: true
        tradingSymbol:
          type: string
          nullable: true
        fundCode:
          type: string
          nullable: true
        msid:
          type: string
          nullable: true
        ticker:
          type: string
          nullable: true
      additionalProperties: false
      title: OutputIdentifiers
      description: All fields are nullable. Empty or `null` value fields are not returned.
    OutputMetadata:
      type: object
      properties:
        requestId:
          type: string
          nullable: true
        time:
          type: string
          format: date-time
          readOnly: true
        portfolioDate:
          type: string
          nullable: true
        portfolioCurrency:
          type: string
          nullable: true
        messages:
          type: array
          items:
            $ref: "#/components/schemas/OutputMetadataMessages"
          nullable: true
      additionalProperties: false
      title: OutputMetadata
      description: All fields are nullable. Empty or `null` value fields are not returned.
    CodeMappingString:
      type: object
      properties:
        value:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
      additionalProperties: false
      title: CodeMappingString
    CodeMappingInt:
      type: object
      properties:
        value:
          type: string
          nullable: true
        code:
          type: integer
          format: int32
          nullable: true
      additionalProperties: false
      title: CodeMappingInt
    OutputMetadataMessages:
      type: object
      properties:
        type:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
        investments:
          type: array
          items:
            $ref: "#/components/schemas/OutputInvalidInvestments"
          nullable: true
        message:
          type: string
          nullable: true
      additionalProperties: false
      title: OutputMetadataMessages
      description: All fields are nullable. Empty or `null` value fields are not returned.
    OutputInvalidInvestments:
      type: object
      properties:
        id:
          type: string
          nullable: true
        idType:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        datapointId:
          type: array
          items:
            type: string
          nullable: true
        customDatapoints:
          type: array
          items:
            type: string
          nullable: true
        errorCode:
          type: string
          nullable: true
        performanceId:
          type: string
          description: Performance ID (if not passed in request).
          nullable: true
        companyId:
          type: string
          description: Company ID (if not passed in request).
          nullable: true
        baseCurrency:
          type: string
          description: Input base currency used to look up Investment identifier
          nullable: true
        domicile:
          type: string
          description: Input domicile used to look up Investment identifier.
          nullable: true
        exchangeCountry:
          type: string
          description: Input exchange country used to look up Investment identifier.
          nullable: true
        exchangeId:
          type: string
          description: Input exchange id used to look up Investment identifier.
          nullable: true
      additionalProperties: false
      title: OutputInvalidInvestments
      description: All fields are nullable. Empty or `null` value fields are not returned.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: "JWT obtained from `POST /token/oauth`. Send it on every request as
        `Authorization: Bearer <token>`. Reuse the token for up to 60 minutes,
        then request a new one."
```