Factset Company API

openapi: 3.2.0
info:
  title: Factset Company API
  version: '1.0'
  description: 'Operations tagged Company across 4 of this provider''s published API definitions: company-logo-api-for-digital-portals-openapi-original.yml, digital-cards-openapi-original.yml, event-calendar-openapi-original.yml, factset-stocks-api-for-digital-portals-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.factset.com/wealth/v1
- url: https://api.factset.com/digital-cards-api
  description: Production
- url: https://api.factset.com/event-calendar/v1
tags:
- name: Company
paths:
  /company/logo/get:
    get:
      tags:
      - Company
      operationId: get/company/logo/get
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: Factset List of URLs of company logos.
      description: "List of URLs for transparent company logos in different sizes and formats.   The different sizes for the rectangular and square formats are: \n\n **Small**:\n * rectangular:  maximum width of 88 pixels and maximum height of 31 pixels.\n * square:  31 x 31 pixels.\n\n\n **Medium**: small logo scaled up by 200%.\n\n **Large**: small logo scaled up by 300%.\n\n **Vector**: can be rendered at any size."
      parameters:
      - name: identifier
        in: query
        required: true
        description: 'Identifier that resolves to a company. '
        schema:
          type: string
          maxLength: 50
          minLength: 4
          pattern: ^(([0-9A-Z]{6}-[SLR])|([0-9A-Z.]{1,47}-[A-Z]{2,4})|([0-9]{1,20}))$
      - name: identifierType
        in: query
        required: true
        description: The type of the identifier.
        x-enum-description:
        - MDG identifier of an instrument.
        - 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "FDS" for FactSet Research Systems Inc.) and the three-character code of the exchange on which the listing is traded (example: FDS-NYS).'
        schema:
          type: string
          enum:
          - idInstrument
          - tickerExchange
      - name: format
        in: query
        description: Format of the logos.
        required: false
        x-enum-description:
        - Logos in rectangular format
        - Logos in square format
        schema:
          type: string
          enum:
          - rectangular
          - square
          default: rectangular
      - name: _attributes
        in: query
        description: Limit the attributes returned in the response to the specified set.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            maxLength: 100
          maxItems: 50
          uniqueItems: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    description: URLs of company logos. All URLs are publicly available via HTTPS and hosted by FactSet with a top-level domain `mdgms.com`. For possible values of the attribute `mimeType`, see endpoint `/basic/media/type/list` with parameter `filter.ids=1 (image)`.
                    type: object
                    x-property-sort:
                    - small
                    - medium
                    - large
                    - vector
                    properties:
                      small:
                        type: object
                        x-property-sort:
                        - url
                        - mimeType
                        description: Small logo.
                        properties:
                          url:
                            type: string
                            format: url
                            description: URL of the logo.
                          mimeType:
                            type: string
                            description: MIME type of the logo.
                      medium:
                        type: object
                        x-property-sort:
                        - url
                        - mimeType
                        description: Medium logo.
                        properties:
                          url:
                            type: string
                            format: url
                            description: URL of the logo.
                          mimeType:
                            type: string
                            description: MIME type of the logo.
                      large:
                        type: object
                        x-property-sort:
                        - url
                        - mimeType
                        description: Large logo.
                        properties:
                          url:
                            type: string
                            format: url
                            description: URL of the logo.
                          mimeType:
                            type: string
                            description: MIME type of the logo.
                      vector:
                        type: object
                        x-property-sort:
                        - url
                        - mimeType
                        description: Vector logo.
                        properties:
                          url:
                            type: string
                            format: url
                            description: URL of the logo.
                          mimeType:
                            type: string
                            description: MIME type of the logo.
                  meta:
                    type: object
                    description: The meta member contains the meta information of the response.
                    properties:
                      status:
                        $ref: '#/components/schemas/StatusObject'
                    x-property-sort:
                    - status
      security:
      - Basic: []
    servers:
    - url: https://api.factset.com/wealth/v1
  /v1/company/{component}/adaptive-card:
    parameters:
    - name: component
      in: path
      required: true
      description: Card name
      schema:
        type: string
        enum:
        - profile
        - event-calendar
    - name: ids
      in: query
      required: true
      description: Public company tickers (comma delimited)
      schema:
        type: string
        default: FDS-US
    - name: format
      in: query
      description: Return data in different format. By default adaptive cards will be returned in key (ticker) value (adaptive card) pairs in a object. Table option would return adaptive cards in an array
      schema:
        type: string
        enum:
        - table
    - name: thumbnail
      in: query
      description: Whether or not to include a thumbnail card in the return data
      schema:
        type: boolean
        enum:
        - true
        - false
    get:
      tags:
      - Company
      summary: Factset Retrieve Multiple Digital Cards in Microsoft Adaptive Card Format.
      responses:
        '200':
          description: Digital Card JSON received.
          headers:
            Content-Encoding:
              description: Standard HTTP header. Header value based on Accept-Encoding Request header.
              schema:
                type: string
            Content-Type:
              description: Standard HTTP header.
              schema:
                type: string
          content:
            application/json:
              examples:
                objectExample1:
                  $ref: '#/components/examples/MultiplePorfileCard'
                objectExample2:
                  $ref: '#/components/examples/MultipleEventCalendarCard'
        '400':
          description: Bad Request. For further assistance, file an issue under "Workflow & Throttling - 400 or 429 Response" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
            Api-Supported-Versions:
              schema:
                type: string
              description: Supported API major versions
            Api-Version:
              schema:
                type: string
              description: API version (semantic versioning)
        '401':
          description: Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under "Connectivty - 401 or 403 Responses" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
        '404':
          description: Not found. For further assistance, file an issue under "Performance - 404 and 500 Responses" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
        '429':
          description: Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under "Workflow & Throttling - 400 or 429 Response" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
        '500':
          description: Server error. For further assistance, file an issue under "Performance - 404 and 500 Responses" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
        '503':
          description: Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under "Performance - 404 and 500 Responses" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
      security:
      - basicAuth: []
    servers:
    - url: https://api.factset.com/digital-cards-api
      description: Production
  /v1/company/{component}/adaptive-card/{id}:
    parameters:
    - name: component
      in: path
      required: true
      description: Card name
      schema:
        type: string
        enum:
        - profile
        - event-calendar
    - name: id
      in: path
      required: true
      description: Public company ticker
      schema:
        type: string
        default: FDS-US
    get:
      tags:
      - Company
      summary: Factset Retrieve One Digital Card in Microsoft Adaptive Card Format.
      responses:
        '200':
          description: Digital Card JSON received.
          headers:
            Content-Encoding:
              description: Standard HTTP header. Header value based on Accept-Encoding Request header.
              schema:
                type: string
            Content-Type:
              description: Standard HTTP header.
              schema:
                type: string
          content:
            application/json:
              examples:
                objectExample1:
                  $ref: '#/components/examples/OneProfileCard'
                objectExample2:
                  $ref: '#/components/examples/OneEventCalendarCard'
        '400':
          description: Bad Request. For further assistance, file an issue under "Workflow & Throttling - 400 or 429 Response" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
            Api-Supported-Versions:
              schema:
                type: string
              description: Supported API major versions
            Api-Version:
              schema:
                type: string
              description: API version (semantic versioning)
        '401':
          description: Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under "Connectivty - 401 or 403 Responses" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
        '404':
          description: Not found. For further assistance, file an issue under "Performance - 404 and 500 Responses" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
        '429':
          description: Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under "Workflow & Throttling - 400 or 429 Response" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
        '500':
          description: Server error. For further assistance, file an issue under "Performance - 404 and 500 Responses" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
        '503':
          description: Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under "Performance - 404 and 500 Responses" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
          headers:
            X-DataDirect-Request-Key:
              schema:
                type: string
              description: FactSet request ID
      security:
      - basicAuth: []
    servers:
    - url: https://api.factset.com/digital-cards-api
      description: Production
  /company/event/list:
    post:
      summary: Factset Retrieve Company Event data
      description: This endpoint returns all company events with filters from the request.
      tags:
      - Company
      operationId: getCompanyEvent
      requestBody:
        $ref: '#/components/requestBodies/companyEventRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/companyEventResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      security:
      - FactSetApiKey: []
      - FactSetOAuth2: []
    servers:
    - url: https://api.factset.com/event-calendar/v1
  /company/keyItems/current/getByInstrument:
    post:
      tags:
      - Company
      operationId: post/company/keyItems/current/getByInstrument
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: Fundamentals for a stock with potentially daily updates.
      description: Fundamentals for a stock with potentially daily updates; any other instrument yields empty values for stock-specific attributes. The price used to calculate the various price-dependent figures is unspecified and the exchange for that price is not identified. Dates are interpreted in the timezone of the data provider. For reported company fundamentals of the previous fiscal years (only closed fiscal years) see endpoint `/company/keyItems/fiscalYear/listByInstrument.`
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCompanyKeyItemsCurrentGetByInstrumentRequest'
      responses:
        '200':
          $ref: '#/components/responses/PostCompanyKeyItemsCurrentGetByInstrument200Response'
      parameters: []
      security:
      - Basic: []
    servers:
    - url: https://api.factset.com/wealth/v1
  /company/keyItems/fiscalYear/listByInstrument:
    post:
      tags:
      - Company
      operationId: post/company/keyItems/fiscalYear/listByInstrument
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: Selected fundamentals for a stock with values as of the end of a fiscal year.
      description: Selected fundamentals for a stock with values as of the end of a fiscal year; any other instrument yields empty values for stock-specific attributes. The endpoint allows the retrieval of data only for specified fiscal years by using the start and end properties. Since a fiscal year and a calendar year do not necessarily match with regard to their start and end dates, the year is derived as the calendar year occupied to a larger extent by the fiscal year, using a June through May fiscal year assignment. That means, fiscal years ending from the 1st of June onwards are assigned to the same calendar year. Dates are interpreted in the timezone of the location of the head office of the company.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCompanyKeyItemsFiscalYearListByInstrumentRequest'
      responses:
        '200':
          $ref: '#/components/responses/PostCompanyKeyItemsFiscalYearListByInstrument200Response'
      parameters: []
      security:
      - Basic: []
    servers:
    - url: https://api.factset.com/wealth/v1
  /company/estimates/listByInstrument:
    post:
      tags:
      - Company
      operationId: post/company/estimates/listByInstrument
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      description: Fiscal year estimates for selected figures of a stock. Data is available only for common shares; instruments such as preferred shares or depository receipts yield an empty result. For the share type, see endpoint `/instrument/category/list` using dataset 23. Data can be retrieved only for the current, the past, and three future fiscal years. For past fiscal years, the estimates are not being replaced by the reported figures. Since a fiscal year and a calendar year do not necessarily match with regard to their start and end dates, the year is derived as the calendar year occupied to a larger extent by the fiscal year, using a June through May fiscal year assignment. That means, fiscal years ending from the 1st of June onwards are assigned to the same calendar year. Dates are interpreted in the timezone of the location of the head office of the company.
      summary: Estimates for selected figures for a stock.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCompanyEstimatesListByInstrumentRequest'
      responses:
        '200':
          $ref: '#/components/responses/PostCompanyEstimatesListByInstrument200Response'
      parameters: []
      security:
      - Basic: []
    servers:
    - url: https://api.factset.com/wealth/v1
  /company/board/listByInstrument:
    get:
      tags:
      - Company
      operationId: get/company/board/listByInstrument
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: List of boards for a company, with their officers.
      description: List of boards for a company, with their officers. A given person may be a member ofdifferent boards of the same company but also a member of boards of different companies.
      parameters:
      - name: id
        in: query
        schema:
          type: string
          format: id64
          x-positive: true
          description: Identifier of the instrument representing company shares.Any other instrument yields empty values.
        required: true
      - name: _attributes
        in: query
        schema:
          type: array
          items:
            type: string
            maxLength: 100
          uniqueItems: true
          maxItems: 50
        style: form
        explode: false
        description: Limit the attributes returned in the response to the specified set.
      - name: _language
        in: query
        schema:
          type: string
          format: isoLanguage
          description: ISO 639-1 code of the language.
          maxLength: 2
          minLength: 2
      responses:
        '200':
          $ref: '#/components/responses/GetCompanyBoardListByInstrument200Response'
      security:
      - Basic: []
    servers:
    - url: https://api.factset.com/wealth/v1
  /company/board/officer/function/delivery/list:
    get:
      tags:
      - Company
      operationId: get/company/board/officer/function/delivery/list
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: List of officer functions as provided by a delivery.
      description: List of officer functions as provided by a delivery.
      responses:
        '200':
          $ref: '#/components/responses/GetCompanyBoardOfficerFunctionDeliveryList200Response'
      parameters:
      - name: _attributes
        in: query
        schema:
          type: array
          items:
            type: string
            maxLength: 100
          uniqueItems: true
          maxItems: 50
        style: form
        explode: false
        description: Limit the attributes returned in the response to the specified set.
      - name: _language
        in: query
        schema:
          type: string
          format: isoLanguage
          description: ISO 639-1 code of the language.
          maxLength: 2
          minLength: 2
      security:
      - Basic: []
    servers:
    - url: https://api.factset.com/wealth/v1
  /company/board/type/list:
    get:
      tags:
      - Company
      operationId: get/company/board/type/list
      x-supportsOffsetBasedPaging: false
      x-supportsOffsetBasedPagingWithoutTotal: false
      x-supportsCursorBasedPaging: false
      x-supportsCursorBasedPagingWithoutTotal: false
      x-supportsPush: false
      x-requiresUser: false
      x-requiresInternalClient: false
      x-disallowUser: false
      x-no-merge: false
      x-maxSortParameterCount: 10
      x-supportsPermissionDeniedResponse: false
      summary: List of company board types.
      description: List of company board types.
      responses:
        '200':
          $ref: '#/components/responses/GetCompanyBoardTypeList200Response'
      parameters:
      - name: _attributes
        in: query
        schema:
          type: array
          items:
            type: string
            maxLength: 100
          uniqueItems: true
          maxItems: 50
        style: form
        explode: false
        description: Limit the attributes returned in the response to the specified set.
      - name: _language
        in: query
        schema:
          type: string
          format: isoLanguage
          description: ISO 639-1 code of the language.
          maxLength: 2
          minLength: 2
      security:
      - Basic: []
    servers:
    - url: https://api.factset.com/wealth/v1
components:
  schemas:
    StatusObject:
      type: object
      properties:
        code:
          type: number
          format: int32
          description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1).
      description: The status member contains the status code of the response.
      required:
      - code
    companyEventResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              ticker:
                type: string
                example: AAPL-US
              companyName:
                type: string
                example: Apple, Inc.
              description:
                type: string
                example: Q2 2023 Earnings Release (Projected)
              eventDateTime:
                type: string
                format: date-time
                example: '2023-01-01T00:00:00Z'
              marketTimeCode:
                type: string
                example: Unspecified
              eventType:
                type: string
                enum:
                - E
                - SA
                - G
                - AM
                - SM
                - SS
                - CP
                - confirmedER
                - SR
                - projectedER
                - S
                - D
                example: E
              eventId:
                type: string
                example: '1200867930'
              webcastLink:
                type: string
                example: ''
              irLink:
                type: string
                example: investor.apple.com/investor-relations/default.aspx
              fiscalYear:
                type: string
                example: '2023'
              fiscalPeriod:
                type: string
                example: '1'
              contactEmail:
                type: string
                example: jdoe@apple.com
              contactPhone:
                type: string
                example: 1(888)227.0303
              contactName:
                type: string
                example: John Doe
    errorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error'
    companyEventRequest:
      type: object
      properties:
        data:
          type: object
          properties:
            date:
              type: object
              properties:
                start:
                  description: Event start time as date/time string according to ISO 8601.
                  type: string
                  format: date-time
                  example: '2022-12-01T00:00:00Z'
                end:
                  description: Event end time as date/time string according to ISO 8601.
                  type: string
                  format: date-time
                  example: '2022-12-31T22:59:02Z'
            universe:
              type: object
              properties:
                symbols:
                  description: Companies to return in the response
                  type: array
                  items:
                    type: string
                  example:
                  - AAPL-US
                  - MSFT-US
                  - FDS-US
                type:
                  type: string
                  enum:
                  - tickers
                  - index
                  - etf
                  - mutual
                  - allCompanies
                  example: tickers
            types:
              description: The type of events returned in the response
              type: array
              items:
                type: string
                enum:
                - E
                - SA
                - G
                - AM
                - SM
                - SS
                - CP
                - confirmedER
                - SR
                - projectedER
                - S
                - D
                example: E
    error:
      type: object
      properties:
        title:
          type: string
        code:
          type: string
        id:
          type: string
    PostCompanyEstimatesListByInstrumentRequest:
      type: object
      properties:
        data:
          type: object
          x-property-sort:
          - id
          - fiscalYears
          - currency
          description: The data member contains the request's primary data.
          properties:
            id:
              type: string
              format: id64
              x-positive: true
              description: Identifier of the instrument
            fiscalYears:
              type: object
              x-property-sort:
              - start
              - end
              description: The response includes data items from the fiscal year specified as start (inclusive) up to the fiscal year specified as end (inclusive). The attribute `start` must be less than or equal to the attribute `end`.
              properties:
                start:
                  type: number
                  format: int32
                  description: Only include data items for a fiscal year greater than or equal to the one specified. Must be greater than or equal to one year in the past. If omitted, the response includes data from one year in the past up to the year specified as `end`.
    

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