---
title: "OutputScreenerMetadata"
url: "https://developer-beta.morningstar.com/apis/equities-screener-api/versions/6a741807-eba1-4fa3-bcc8-1d4904910e0a/schemas/OutputScreenerMetadata"
---

> Full API specification: https://developer-beta.morningstar.com/apis/equities-screener-api/versions/6a741807-eba1-4fa3-bcc8-1d4904910e0a.md

# OutputScreenerMetadata

Metadata returned with screener results, including pagination tokens and information about data points not returned.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Equities Screener 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
components:
  schemas:
    OutputMessage:
      title: OutputMessage
      description: Indicates why specific data points were not returned for one or
        more results.
      type: object
      properties:
        investments:
          type:
            - array
            - "null"
          items:
            $ref: "#/components/schemas/OutputInvalidInvestment"
        type:
          description: Message type.
          type: string
          example: Warning
        message:
          description: Message text.
          type:
            - string
            - "null"
          example: Data points are not entitled for 0P0002OW20 security
        code:
          description: Message code.
          type:
            - string
            - "null"
          example: "403"
      additionalProperties: false
    OutputInvestmentReference:
      title: OutputInvestmentReference
      description: Resolved identifiers for a valid investment.
      type: object
      properties:
        performanceId:
          description: Morningstar Performance ID.
          type:
            - string
            - "null"
        securityId:
          description: Morningstar Security ID.
          type:
            - string
            - "null"
        isin:
          description: ISIN.
          type:
            - string
            - "null"
        tradingSymbol:
          description: Trading symbol.
          type:
            - string
            - "null"
        fundCode:
          description: Fund code.
          type:
            - string
            - "null"
        sedol:
          description: SEDOL.
          type:
            - string
            - "null"
        cusip:
          description: CUSIP.
          type:
            - string
            - "null"
        name:
          description: Investment name.
          type:
            - string
            - "null"
        baseCurrency:
          description: Base currency.
          type:
            - string
            - "null"
        type:
          description: Investment type.
          type:
            - string
            - "null"
        inceptionDate:
          description: Inception date.
          type:
            - string
            - "null"
      additionalProperties: false
    OutputInvalidInvestment:
      title: OutputInvalidInvestment
      description: An investment for which one or more data points could not be returned.
      type: object
      properties:
        status:
          description: Reason data points were not returned.
          type:
            - string
            - "null"
          example: Data points are not entitled for 0P0001VK70 security.
        dataPoints:
          description: Data points that could not be returned for the investment.
          type:
            - array
            - "null"
          items:
            type: string
        errorCode:
          description: Error code.
          type:
            - string
            - "null"
          example: "403"
        id:
          description: Identifier of the investment.
          type:
            - string
            - "null"
          example: 0P0001VK70
        idType:
          description: Type of identifier in `id`.
          type:
            - string
            - "null"
          example: PerformanceId
          x-knownValues:
            - ISIN
            - CUSIP
            - PerformanceId
            - SecurityId
            - TradingSymbol
            - FundCode
            - MSID
        performanceId:
          description: Morningstar Performance ID, if not the identifier in `id`.
          type:
            - string
            - "null"
        companyId:
          description: Morningstar Company ID, if not the identifier in `id`.
          type:
            - string
            - "null"
        baseCurrency:
          description: Base currency used to look up the investment.
          type:
            - string
            - "null"
        domicile:
          description: Domicile used to look up the investment.
          type:
            - string
            - "null"
        exchangeCountry:
          description: Exchange country used to look up the investment.
          type:
            - string
            - "null"
        exchangeId:
          description: Exchange ID used to look up the investment.
          type:
            - string
            - "null"
      additionalProperties: false
    OutputScreenerMetadata:
      title: OutputScreenerMetadata
      description: Metadata returned with screener results, including pagination
        tokens and information about data points not returned.
      type: object
      properties:
        paginationTokenNext:
          description: Token to fetch the next page of results.
          type:
            - string
            - "null"
          example: CNOAQhoJKQBIuTktAQAAGhU6E3RlYW0gcGFydG5lcnMgZ3JvdXAaDDoKMHAwMDAwYTZ6dCIMOgowUDAwMDBBNlpU
        paginationTokenPrevious:
          description: Token to fetch the previous page of results.
          type:
            - string
            - "null"
          example: CKDjNhoJKQBIuTktAQAAGg06C2dkZiBzdWV6IHNhGgw6CjBwMDAwMDl3cW8iDDoKMFAwMDAwOVdRTw==
        totalCount:
          description: Total number of results found.
          type:
            - integer
            - "null"
          format: int32
          example: 2162
        messages:
          type:
            - array
            - "null"
          items:
            $ref: "#/components/schemas/OutputMessage"
        securityReference:
          description: Resolved identifiers for valid investments in the response.
          type:
            - array
            - "null"
          items:
            $ref: "#/components/schemas/OutputInvestmentReference"
        requestId:
          description: Unique request identifier.
          type:
            - string
            - "null"
          example: c63e7f6c-b52d-42c3-9d1b-4a4b4ac05f3c
        time:
          description: Time the response was generated.
          type: string
          format: date-time
          readOnly: true
          example: 2025-10-02T10:54:36.9161062Z
      additionalProperties: false
```