Factset Symbology API

openapi: 3.2.0
info:
  version: 3.3.0
  title: FactSet Symbology API
  contact:
    name: FactSet Research Systems
    email: api@factset.com
  description: 'The FactSet Symbology API provides symbol resolution services, allowing clients to translate market identifiers into various symbology types such as, FactSet Permanent Identifiers, CUSIP, ISIN, SEDOL, Tickers, and LEIs. <p>Factset''s Symbology API sits at the center of its hub-and-spoke data model, enabling you to quickly harmonize the expanding catalog of Content APIs.</p>

    '
servers:
- url: https://api.factset.com/content
  description: Production
security:
- BasicAuth: []
tags:
- name: Symbology
paths:
  /symbology/v3/identifier-resolution:
    get:
      tags:
      - Symbology
      summary: Factset Returns the specified output identifiers for the specified input identifier.
      operationId: identifierResolution
      description: "The Identifier Resolution endpoint provides flexibility for requesting and receiving both third-party and FactSet Permanent identifiers. Users can both input and output most of the listed identifiers, with exceptions noted below.  All input and output symbols must be declared, and users have the ability to resolve one input symbol to many different output symbols in one request. \n* **BIC*** - Bank Identification Code (e.g. ABXXHKH1)\n* **CIK** - Edgar Central Index Keys (e.g. 0000100331)\n* **CRD** - Central Registration Depository (e.g. 149722)\n* **DUNS** - Dun & Bradstreet Data Universal Numbering System (e.g. 687741991) (Input only)\n* **EIN** - Employer Identification Number (e.g. 953540776)\n* **FITCH*** - Fitch Ratings Identifier (e.g. 47504)\n* **LEI** - Legal Entity Identifier (e.g. 549300A6K7JX8EX2QZ33)\n* **MD*** - Moody's Ratings Identifier (e.g. 0823736553)\n* **SPR*** - S&P Ratings Identifier (e.g. 301939)\n* **VALOREN** - Valoren (\"Valor\") Identification (e.g. 685558) (Input only)\n* **WKN*** - German Securities Identification (\"Wertpapierkennnummer\") (e.g. A0MU9T)\n* **UKCH** - UK Company House Identifier (e.g.CE012494)\n* **RSSD** - Federal Reserve RSSD Identifier (1139297)\n* **SEDOL***\n* **CUSIP***\n* **fsymEntityId** - FactSet entity Id\n* **fsymSecurityId** - FactSet security level permanent identifier\n* **fsymRegionalId** - FactSet regional level permanent identifier\n* **fsymListingId** - FactSet listing level permanent identifier\n* **ISIN***\n* **tickerExchange** - Ticker Exchange is a marketplace where stocks, bonds, commodities, and derivatives are bought and sold. (e.g. GOOGL-NAS)\n* **tickerRegion** - Ticker Region is the geographical region or market segment where a particular stock or security is listed and traded. (e.g. GOOGL-US)\n* **bloombergFigi** - Bloomberg Listing/Regional/Security Identifier (output symbols: bloombergFigiListing, bloombergFigiRegional & bloombergFigiSecurity) (e.g. BBG009S39JY5)\n* **bloombergTicker** - Bloomberg Listing and Regional Ticker Identifier (output symbols: bloombergRegionalTicker & bloombergListingTicker) (e.g. GOOGL UW)\n* **GVKEY** - CompuStat Entity Identifier (e.g. 063172)(Input only)\n* **GVKEY & IID** - CompuStat Security Identifier (e.g.063172001) (Input only)\n* **JCN** - Japan Corporate Number (e.g. 9011101021173)\n* **LoanX** - Markit Bank Loan Security Identifier (e.g. LX130668) (Input only)\n* **MarkitRed** - Markit Entity Identifier (e.g. 3D337C) (Input only)\n\n**These symbol types require additional subscriptions. If you would like to gain access to these symbol types, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.*\n"
      parameters:
      - $ref: '#/components/parameters/getIdsResolution'
      - $ref: '#/components/parameters/getInputSymbolType'
      - $ref: '#/components/parameters/getOutputSymbolTypes'
      responses:
        '200':
          description: Symbol translation objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identifierResolutionResponse'
              examples:
                Translate Single Security or Entity Identifier:
                  $ref: '#/components/examples/singleIdentifierResolution'
                Translate Multiple Security or Entity Identifiers:
                  $ref: '#/components/examples/multipleIdentifierResolution'
        '400':
          description: Bad Request. This can occur for several reasons. Please review the "message" for more details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
              examples:
                Bad Request - Missing Required Parameter:
                  $ref: '#/components/examples/badRequestRequiredParameter'
                Bad Request - Invalid Parameter:
                  $ref: '#/components/examples/badRequestInvalidParameters'
                Bad Request - Malformed JSON:
                  $ref: '#/components/examples/badRequestMalformedJSON'
                Bad Request - Read Timeout:
                  $ref: '#/components/examples/badRequestReadTimeout'
        '401':
          $ref: '#/components/responses/401Legacy'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
              examples:
                Forbidden:
                  $ref: '#/components/examples/forbidden'
                Forbidden Identifier:
                  $ref: '#/components/examples/forbiddenIdentifier'
        '415':
          $ref: '#/components/responses/415Legacy'
        '500':
          $ref: '#/components/responses/500Legacy'
    post:
      tags:
      - Symbology
      summary: Factset Returns the specified output identifiers for the given input identifier.
      description: "The Identifier Resolution endpoint provides flexibility for requesting and receiving both third-party and FactSet Permanent identifiers. Users can both input and output most of the listed identifiers, with exceptions noted below.  All input and output symbols must be declared, and users have the ability to resolve one input symbol to many different output symbols in one request. \n* **BIC*** - Bank Identification Code (e.g. ABXXHKH1)\n* **CIK** - Edgar Central Index Keys (e.g. 0000100331)\n* **CRD** - Central Registration Depository (e.g. 149722)\n* **DUNS** - Dun & Bradstreet Data Universal Numbering System (e.g. 687741991) (Input only)\n* **EIN** - Employer Identification Number (e.g. 953540776)\n* **FITCH*** - Fitch Ratings Identifier (e.g. 47504)\n* **LEI** - Legal Entity Identifier (e.g. 549300A6K7JX8EX2QZ33)\n* **MD*** - Moody's Ratings Identifier (e.g. 0823736553)\n* **SPR*** - S&P Ratings Identifier (e.g. 301939)\n* **VALOREN** - Valoren (\"Valor\") Identification (e.g. 685558) (Input only)\n* **WKN*** - German Securities Identification (\"Wertpapierkennnummer\") (e.g. A0MU9T)\n* **UKCH** - UK Company House Identifier (e.g.CE012494)\n* **RSSD** - Federal Reserve RSSD Identifier (1139297)\n* **SEDOL***\n* **CUSIP***\n* **fsymEntityId** - FactSet entity Id\n* **fsymSecurityId** - FactSet security level permanent identifier\n* **fsymRegionalId** - FactSet regional level permanent identifier\n* **fsymListingId** - FactSet listing level permanent identifier\n* **ISIN***\n* **tickerExchange** - Ticker Exchange, a marketplace where stocks, bonds, commodities, and derivatives are bought and sold. (e.g. GOOGL-NAS)\n* **tickerRegion** - Ticker Region, geographical region or market segment where a particular stock or security is listed and traded. (e.g. GOOGL-US)\n* **bloombergFigi** - Bloomberg Listing/Regional/Security Identifier (output symbols: bloombergFigiListing, bloombergFigiRegional & bloombergFigiSecurity ) (e.g. BBG009S39JY5)\n* **bloombergTicker** - Bloomberg Listing and Regional Ticker Identifier (output symbols: bloombergRegionalTicker & bloombergListingTicker) (e.g. GOOGL UW)\n* **GVKEY** - CompuStat Entity Identifier (e.g. 063172)(Input only)\n* **GVKEY & IID** - CompuStat Security Identifier (e.g.063172001) (Input only)\n* **JCN** - Japan Corporate Number (e.g. 9011101021173)\n* **LoanX** - Markit Bank Loan Security Identifier (e.g. LX130668) (Input only)\n* **MarkitRed** - Markit Entity Identifier (e.g. 3D337C) (Input only)\n\n**These symbol types require additional subscriptions. If you would like to gain access to these symbol types, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.*\n"
      operationId: batchIdentifierResolution
      requestBody:
        required: true
        description: Request Body for Identifier Resolution.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identifierResolutionRequest'
            examples:
              Translate Single Security or Entity Identifier:
                $ref: '#/components/examples/singleIdentifierResolutionPost'
              Translate Multiple Security or Entity Identifiers:
                $ref: '#/components/examples/multipleIdentifierResolutionPost'
      responses:
        '200':
          description: Symbol translation objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identifierResolutionResponse'
              examples:
                Translate Single Security or Entity Identifier:
                  $ref: '#/components/examples/singleIdentifierResolution'
                Translate Multiple Security or Entity Identifiers:
                  $ref: '#/components/examples/multipleIdentifierResolution'
        '400':
          description: Bad Request. This can occur for several reasons. Please review the "message" for more details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
              examples:
                Bad Request - Missing Required Parameter:
                  $ref: '#/components/examples/badRequestRequiredParameter'
                Bad Request - Invalid Parameter:
                  $ref: '#/components/examples/badRequestInvalidParameters'
                Bad Request - Malformed JSON:
                  $ref: '#/components/examples/badRequestMalformedJSON'
                Bad Request - Read Timeout:
                  $ref: '#/components/examples/badRequestReadTimeout'
        '401':
          $ref: '#/components/responses/401Legacy'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
              examples:
                Forbidden:
                  $ref: '#/components/examples/forbidden'
                Forbidden Identifier:
                  $ref: '#/components/examples/forbiddenIdentifier'
        '415':
          $ref: '#/components/responses/415Legacy'
        '500':
          $ref: '#/components/responses/500Legacy'
  /symbology/v3/historical-identifier-resolution:
    get:
      tags:
      - Symbology
      summary: Factset Returns the specified historical output identifiers for the given input identifier.
      operationId: historicalIdentifierResolution
      description: "This endpoint enables the retrieval of historical CUSIP, SEDOL, ISIN, and tickerRegion identifiers. Users can input any of the listed identifiers and resolve one input symbol to multiple different output symbols in a single request. Both input and output symbols must be declared. The `asOfDate` field allows users to retrieve the full history of an identifier or the specific identifiers as of the requested date. \n* **BIC*** - Bank Identification Code (e.g. ABXXHKH1) (Input only)\n* **CIK** - Edgar Central Index Keys (e.g. 0000100331) (Input only)\n* **CRD** - Central Registration Depository (e.g. 149722) (Input only)\n* **DUNS** - Dun & Bradstreet Data Universal Numbering System (e.g. 687741991) (Input only)\n* **EIN** - Employer Identification Number (e.g. 953540776) (Input only)\n* **FITCH*** - Fitch Ratings Identifier (e.g. 47504) (Input only)\n* **LEI** - Legal Entity Identifier (e.g. 549300A6K7JX8EX2QZ33) (Input only)\n* **MD*** - Moody's Ratings Identifier (e.g. 0823736553) (Input only)\n* **SPR*** - S&P Ratings Identifier (e.g. 301939) (Input only)\n* **VALOREN** - Valoren (\"Valor\") Identification (e.g. 685558) (Input only)\n* **WKN*** - German Securities Identification (\"Wertpapierkennnummer\") (e.g. A0MU9T) (Input only)\n* **UKCH** - UK Company House Identifier (e.g.CE012494) (Input only)\n* **RSSD** - Federal Reserve RSSD Identifier (1139297) (Input only)\n* **SEDOL***\n* **CUSIP***\n* **fsymEntityId** - FactSet entity Id (Input only)\n* **fsymSecurityId** - FactSet security level permanent identifier (Input only)\n* **fsymRegionalId** - FactSet regional level permanent identifier (Input only)\n* **fsymListingId** - FactSet listing level permanent identifier (Input only)\n* **ISIN***\n* **tickerExchange** - Ticker Exchange is a marketplace where stocks, bonds, commodities, and derivatives are bought and sold. (e.g. GOOGL-NAS) (Input only)\n* **tickerRegion** - Ticker Region is the geographical region or market segment where a particular stock or security is listed and traded. (e.g. GOOGL-US)\n* **bloombergFigi** - Bloomberg Listing/Regional/Security Identifier (output symbols: bloombergFigiListing, bloombergFigiRegional & bloombergFigiSecurity ) (e.g. BBG009S39JY5) (Input only)\n* **bloombergTicker** - Bloomberg Listing and Regional Ticker Identifier (output symbols: bloombergRegionalTicker & bloombergListingTicker) (e.g. GOOGL UW) (Input only)\n* **GVKEY** - CompuStat Entity Identifier (e.g. 063172) (Input only)\n* **GVKEY & IID** - CompuStat Security Identifier (e.g.063172001) (Input only)\n* **JCN** - Japan Corporate Number (e.g. 9011101021173) (Input only)\n* **LoanX** - Markit Bank Loan Security Identifier (e.g. LX130668) (Input only)\n* **MarkitRed** - Markit Entity Identifier (e.g. 3D337C) (Input only) \n\n**These symbol types require additional subscriptions. If you would like to gain access to these symbol types, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.*\n"
      parameters:
      - $ref: '#/components/parameters/getIdsResolution'
      - $ref: '#/components/parameters/getHistoricalInputSymbolType'
      - $ref: '#/components/parameters/getHistoricalOutputSymbolTypes'
      - $ref: '#/components/parameters/getAsOfDate'
      responses:
        '200':
          description: Symbol translation objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identifierResolutionHistoricalResponse'
              examples:
                Translate Single Security or Entity Identifier:
                  $ref: '#/components/examples/singleHistoricalIdentifierResolution'
                Translate Multiple Security or Entity Identifiers:
                  $ref: '#/components/examples/multipleHistoricalIdentifierResolution'
        '400':
          description: Bad Request. This can occur for several reasons. Please review the "message" for more details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponseHistorical'
              examples:
                Bad Request - Missing Required Parameter:
                  $ref: '#/components/examples/badRequestRequiredParameterHistorical'
                Bad Request - Invalid Parameter:
                  $ref: '#/components/examples/badRequestInvalidParametersHistorical'
                Bad Request - Malformed JSON:
                  $ref: '#/components/examples/badRequestMalformedJSONHistorical'
                Bad Request - Read Timeout:
                  $ref: '#/components/examples/badRequestReadTimeoutHistorical'
        '401':
          $ref: '#/components/responses/401'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponseHistorical'
              examples:
                Forbidden:
                  $ref: '#/components/examples/forbiddenHistorical'
                Forbidden Identifier:
                  $ref: '#/components/examples/forbiddenIdentifierHistorical'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
    post:
      tags:
      - Symbology
      summary: Factset Returns the specified historical output identifiers for the given input identifier.
      description: "This endpoint enables the retrieval of historical CUSIP, SEDOL, ISIN, and tickerRegion identifiers. Users can input any of the listed identifiers and resolve one input symbol to multiple different output symbols in a single request. Both input and output symbols must be declared. The `asOfDate` field allows users to retrieve the full history of an identifier or the specific identifiers as of the requested date. \n* **BIC*** - Bank Identification Code (e.g. ABXXHKH1) (Input only)\n* **CIK** - Edgar Central Index Keys (e.g. 0000100331) (Input only)\n* **CRD** - Central Registration Depository (e.g. 149722) (Input only)\n* **DUNS** - Dun & Bradstreet Data Universal Numbering System (e.g. 687741991) (Input only)\n* **EIN** - Employer Identification Number (e.g. 953540776) (Input only)\n* **FITCH*** - Fitch Ratings Identifier (e.g. 47504) (Input only)\n* **LEI** - Legal Entity Identifier (e.g. 549300A6K7JX8EX2QZ33) (Input only)\n* **MD*** - Moody's Ratings Identifier (e.g. 0823736553) (Input only)\n* **SPR*** - S&P Ratings Identifier (e.g. 301939) (Input only)\n* **VALOREN** - Valoren (\"Valor\") Identification (e.g. 685558) (Input only)\n* **WKN*** - German Securities Identification (\"Wertpapierkennnummer\") (e.g. A0MU9T) (Input only)\n* **UKCH** - UK Company House Identifier (e.g.CE012494) (Input only)\n* **RSSD** - Federal Reserve RSSD Identifier (1139297) (Input only)\n* **SEDOL***\n* **CUSIP***\n* **fsymEntityId** - FactSet entity Id (Input only)\n* **fsymSecurityId** - FactSet security level permanent identifier (Input only)\n* **fsymRegionalId** - FactSet regional level permanent identifier (Input only)\n* **fsymListingId** - FactSet listing level permanent identifier (Input only)\n* **ISIN***\n* **tickerExchange** - Ticker Exchange, a marketplace where stocks, bonds, commodities, and derivatives are bought and sold. (e.g. GOOGL-NAS) (Input only)\n* **tickerRegion** - Ticker Region, geographical region or market segment where a particular stock or security is listed and traded. (e.g. GOOGL-US)\n* **bloombergFigi** - Bloomberg Listing/Regional/Security Identifier (output symbols: bloombergFigiListing, bloombergFigiRegional & bloombergFigiSecurity ) (e.g. BBG009S39JY5) (Input only)\n* **bloombergTicker** - Bloomberg Listing and Regional Ticker Identifier (output symbols: bloombergRegionalTicker & bloombergListingTicker) (e.g. GOOGL UW) (Input only)\n* **GVKEY** - CompuStat Entity Identifier (e.g. 063172) (Input only)\n* **GVKEY & IID** - CompuStat Security Identifier (e.g.063172001) (Input only)\n* **JCN** - Japan Corporate Number (e.g. 9011101021173) (Input only)\n* **LoanX** - Markit Bank Loan Security Identifier (e.g. LX130668) (Input only)\n* **MarkitRed** - Markit Entity Identifier (e.g. 3D337C) (Input only)\n\n**These symbol types require additional subscriptions. If you would like to gain access to these symbol types, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.*\n"
      operationId: batchHistoricalIdentifierResolution
      requestBody:
        required: true
        description: Request Body for Historical Identifier Resolution.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identifierResolutionHistoricalRequest'
            examples:
              Translate Single Security or Entity Identifier:
                $ref: '#/components/examples/singleHistoricalIdentifierResolutionPost'
              Translate Multiple Security or Entity Identifiers:
                $ref: '#/components/examples/multipleHistoricalIdentifierResolutionPost'
      responses:
        '200':
          description: Symbol translation objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identifierResolutionHistoricalResponse'
              examples:
                Translate Single Security or Entity Identifier:
                  $ref: '#/components/examples/singleHistoricalIdentifierResolution'
                Translate Multiple Security or Entity Identifiers:
                  $ref: '#/components/examples/multipleHistoricalIdentifierResolution'
        '400':
          description: Bad Request. This can occur for several reasons. Please review the "message" for more details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponseHistorical'
              examples:
                Bad Request - Missing Required Parameter:
                  $ref: '#/components/examples/badRequestRequiredParameterHistorical'
                Bad Request - Invalid Parameter:
                  $ref: '#/components/examples/badRequestInvalidParametersHistorical'
                Bad Request - Malformed JSON:
                  $ref: '#/components/examples/badRequestMalformedJSONHistorical'
                Bad Request - Read Timeout:
                  $ref: '#/components/examples/badRequestReadTimeoutHistorical'
        '401':
          $ref: '#/components/responses/401'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponseHistorical'
              examples:
                Forbidden:
                  $ref: '#/components/examples/forbiddenHistorical'
                Forbidden Identifier:
                  $ref: '#/components/examples/forbiddenIdentifierHistorical'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
components:
  schemas:
    errorObject:
      type: object
      properties:
        id:
          description: A UUID for this particular occurrence of the problem.
          type: string
          example: adb01824-252f-4420-b0c6-35a1e3507ef5
        code:
          description: status
          type: string
          example: Bad Request
        links:
          description: The Endpoint path {package}/version/{endpoint}
          type: object
          properties:
            about:
              description: Details.
              type: string
              example: /symbology/v3/{endpoint}
        title:
          description: The plain text error message
          type: string
          example: Validation Error
    identifierResolutionHistoricalRequestBody:
      title: Historical Identifier Resolution Request
      description: Request object for Historical Identifier Resolution endpoint.
      type: object
      properties:
        ids:
          $ref: '#/components/schemas/getIdsResolution'
        inputSymbolType:
          $ref: '#/components/schemas/getHistoricalInputSymbolType'
        outputSymbolTypes:
          $ref: '#/components/schemas/getHistoricalOutputSymbolTypes'
        asOfDate:
          $ref: '#/components/schemas/getAsOfDate'
      required:
      - ids
      - inputSymbolType
      - outputSymbolTypes
    identifierResolutionResponse:
      title: Identifier Resolution Response
      description: Response object for Identifier Resolution endpoint.
      type: object
      properties:
        data:
          description: Array of symbol translation objects.
          type: array
          items:
            $ref: '#/components/schemas/identifierResolution'
    errorResponse:
      type: object
      title: Error Response Identifier Resolution
      properties:
        status:
          description: status
          type: string
          example: Bad Request
        timestamp:
          description: timestamp in YYYY-MM-DD HH:MM:SS.SSS
          type: string
          example: '2019-11-01 11:09:41.918'
          format: date-time
        path:
          description: The Endpoint path {package}/version/{endpoint}
          type: string
          example: /symbology/v3/{endpoint}
        message:
          description: The plain text error message
          type: string
          example: Validation Error
        subErrors:
          description: subErrors related to the error message. Null if not applicable.
          type: object
          properties:
            object:
              description: the operation ID
              type: string
            field:
              description: Parameter Field Name
              type: string
            message:
              description: Error message
              type: string
            rejectedValue:
              description: Rejected Values in an Array
              type: array
              items:
                type: string
    identifierResolution:
      title: Identifier Resolution
      description: Identifier Resolution data object.
      type: object
      properties:
        requestId:
          type: string
          description: Identifier inputted in the request.
          example: GOOGL-US
        inputSymbolType:
          type: string
          description: The type of identifier inputted in the request
          example: tickerRegion
        name:
          type:
          - string
          - 'null'
          description: Name of the requested identifier
          example: Alphabet Inc. Class A
        frefListingExchange:
          type:
          - string
          - 'null'
          description: The 3 digit fref exchange code for the primary exchange of the security
          example: USA
        currency:
          type:
          - string
          - 'null'
          description: The 3 digit ISO code for the currency
          example: USD
      additionalProperties:
        title: Requested output symbol type
        description: "The Key in the Key-Value pair is the name of the requested outputSymbolType. The Value in the Key-Value is the requestId translated to the outputSymbolType. \n"
        example: '"cusip": "02079K305"'
        type:
        - string
        - 'null'
    getIdsResolution:
      title: Identifier List for Resolution
      type: array
      items:
        type: string
      minItems: 1
      maxItems: 3000
      description: Requested market securities or entities. All requested identifiers must be of the same type. Accepted identifiers include all FactSet Permanent Identifiers types, CUSIP, SEDOL, ISIN, and Tickers. This request value is sent back in the response as, `requestId'.
      example:
      - GOOGL-US
    identifierResolutionRequest:
      title: Identifier Resolution Request
      description: Request object for Identifier Resolution endpoint.
      type: object
      properties:
        ids:
          $ref: '#/components/schemas/getIdsResolution'
        inputSymbolType:
          $ref: '#/components/schemas/getInputSymbolType'
        outputSymbolTypes:
          $ref: '#/components/schemas/getOutputSymbolTypes'
      required:
      - ids
      - inputSymbolType
      - outputSymbolTypes
    identifierResolutionHistorical:
      title: Historical Identifier Resolution
      description: Historical Identifier Resolution data object.
      type: object
      properties:
        requestId:
          type: string
          description: Identifier inputted in the request.
          example: GOOGL-US
        inputSymbolType:
          type: string
          description: The type of identifier inputted in the request
          example: tickerRegion
        name:
          type:
          - string
          - 'null'
          description: Name of the requested identifier
          example: Alphabet Inc. Class A
        frefListingExchange:
          type:
          - string
          - 'null'
          description: The 3 digit fref exchange code for the primary exchange of the security
          example: USA
        currency:
          type:
          - string
          - 'null'
          description: The 3 digit ISO code for the currency
          example: USD
        outputType:
          type:
          - string
          - 'null'
          description: Type of identifier outputted.
          example: tickerRegion
        value:
          type:
          - string
          - 'null'
          description: Requested identifier.
          example: GOOGL-US
        startDate:
          type:
          - string
          - 'null'
          format: date
          description: Start Date in YYYY-MM-DD format.
          example: '2010-01-01'
        endDate:
          type:
          - string
          - 'null'
          format: date
          description: End Date in YYYY-MM-DD format.
          example: '2010-01-01'
    errorResponseHistorical:
      type: object
      title: Error Response Historical Identifier Resolution
      description: Error Default Response
      properties:
        errors:
          type: array
          description: An array containing errors
          items:
            $ref: '#/components/schemas/errorObject'
    identifierResolutionHistoricalResponse:
      title: Historical Identifier Resolution Response
      description: Response object for Historical Identifier Resolution endpoint.
      type: object
      properties:
        data:
          description: Array of symbol translation objects.
          type: array
          items:
            $ref: '#/components/schemas/identifierResolutionHistorical'
    getOutputSymbolTypes:
      title: Output Symbol Types
      type: array
      items:
        type: string
        enum:
        - BIC
        - CIK
        - CRD
        - EIN
        - FITCH
        - LEI
        - MD
        - SPR
        - WKN
        - UKCH
        - RSSD
        - SEDOL
        - CUSIP
        - fsymEntityId
        - fsymSecurityId
        - fsymRegionalId
        - fsymListingId
        - ISIN
        - tickerExchange
        - tickerRegion
        - JCN
        - bloombergListingTicker
        - bloombergRegionalTicker
        - bloombergFigiListing
        - bloombergFigiRegional
        - bloombergFigiSecurity
      minItems: 1
      maxItems: 20
      description: Requested identifiers to be returned. Multiple identifier types can be requested with each request.
      example:
      - CUSIP
      - SEDOL
    getAsOfDate:
      title: As of Date
      type: string
      format: date
      description: 'As of date for historical symbol request in YYYY-MM-DD format.

        If no `asOfDate` is requested, the response will include the full history of the identifier.

        '
      example: '2010-01-01'
    getInputSymbolType:
      title: Input Symbol Type
      type: string
      description: The type of symbol submitted for resolution to other identifiers. Only one type of symbol is accepted with each request.
      enum:
      - BIC
      - CIK
      - CRD
      - DUNS
      - EIN
      - FITCH
      - LEI
      - MD
      - SPR
      - VALOREN
      - WKN
      - UKCH
      - RSSD
      - SEDOL
      - CUSIP
      - fsymEntityId
      - fsymSecurityId
      - fsymRegionalId
      - fsymListingId
      - ISIN
      - tickerExchange
      - tickerRegion
      - bloombergFigi
      - bloombergTicker
      - GVKEY
      - GVKEY & IID
      - JCN
      - LoanX
      - MarkitRed
      default: tickerRegion
    getHistoricalInputSymbolType:
      title: Input Symbol Type
      type: string
      description: The type of symbol submitted for resolution to other identifiers. Only one type of symbol is accepted with each request.
      enum:
      - BIC
      - CIK
      - CRD
      - DUNS
      - EIN
      - FITCH
      - LEI
      - MD
      - SPR
      - VALOREN
      - WKN
      - UKCH
      - RSSD
      - SEDOL
      - CUSIP
      - fsymEntityId
      - fsymSecurityId
      - fsymRegionalId
      - fsymListingId
      - ISIN
      - tickerExchange
      - tickerRegion
      - bloombergFigi
      - bloombergTicker
      - GVKEY
      - GVKEY & IID
      - JCN
      - LoanX
      - MarkitRed
    getHistoricalOutputSymbolTypes:
      title: Output Symbol Types
      type: array
      items:
        type: string
        enum:
        - SEDOL
        - CUSIP
        - ISIN
        - tickerRegion
      minItems: 1
      maxItems: 20
      de

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/factset-symbology-api-openapi.yml