Xignite FactSet Fundamentals API

Company fundamentals and financial statement data sourced from FactSet, served from the factsetfundamentals.xignite.com service.

OpenAPI Specification

xignite-xignitefactsetfundamentals-api-openapi.yml Raw ↑
openapi: 3.0.4
info:
  title: XigniteBonds CloudAlerts XigniteFactSetFundamentals API
  version: 1.0.3
servers:
- url: https://factsetfundamentals.xignite.com
security:
- basic: []
tags:
- name: XigniteFactSetFundamentals
paths:
  /xFactSetFundamentals/ListCompanies:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: MarketIdentificationCode
        in: query
        schema:
          type: string
      - name: StartSymbol
        in: query
        schema:
          type: string
      - name: EndSymbol
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyList'
            text/json:
              schema:
                $ref: '#/components/schemas/CompanyList'
            application/xml:
              schema:
                $ref: '#/components/schemas/CompanyList'
            text/xml:
              schema:
                $ref: '#/components/schemas/CompanyList'
            text/csv:
              schema:
                $ref: '#/components/schemas/CompanyList'
  /xFactSetFundamentals/ListExchanges:
    get:
      tags:
      - XigniteFactSetFundamentals
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/json:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            application/xml:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/xml:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/csv:
              schema:
                $ref: '#/components/schemas/ExchangeList'
  /xFactSetFundamentals/ListExchangesByRegion:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Regions
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/json:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            application/xml:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/xml:
              schema:
                $ref: '#/components/schemas/ExchangeList'
            text/csv:
              schema:
                $ref: '#/components/schemas/ExchangeList'
  /xFactSetFundamentals/ListFundamentals:
    get:
      tags:
      - XigniteFactSetFundamentals
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/json:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            application/xml:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/xml:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/csv:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
  /xFactSetFundamentals/ListFundamentalsByDataGroup:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: DataGroups
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/json:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            application/xml:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/xml:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/csv:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
  /xFactSetFundamentals/ListSectorsAndIndustries:
    get:
      tags:
      - XigniteFactSetFundamentals
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorList'
            text/json:
              schema:
                $ref: '#/components/schemas/SectorList'
            application/xml:
              schema:
                $ref: '#/components/schemas/SectorList'
            text/xml:
              schema:
                $ref: '#/components/schemas/SectorList'
            text/csv:
              schema:
                $ref: '#/components/schemas/SectorList'
  /xFactSetFundamentals/SearchFundamentals:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Pattern
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/json:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            application/xml:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/xml:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
            text/csv:
              schema:
                $ref: '#/components/schemas/FundamentalDescriptionList'
  /xFactSetFundamentals/GetLatestFundamentals:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: FundamentalTypes
        in: query
        schema:
          type: string
      - name: UpdatedSince
        in: query
        schema:
          type: string
      - name: ReportType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
  /xFactSetFundamentals/GetFundamentals:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: FundamentalTypes
        in: query
        schema:
          type: string
      - name: ReportType
        in: query
        schema:
          type: string
      - name: ExcludeRestated
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: UpdatedSince
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
  /xFactSetFundamentals/GetFundamentalsFiscalRange:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: FundamentalTypes
        in: query
        schema:
          type: string
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      - name: ReportType
        in: query
        schema:
          type: string
      - name: ExcludeRestated
        in: query
        schema:
          type: string
      - name: UpdatedSince
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
  /xFactSetFundamentals/GetFundamentalsDailyRange:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: FundamentalTypes
        in: query
        schema:
          type: string
      - name: StartDate
        in: query
        schema:
          type: string
      - name: EndDate
        in: query
        schema:
          type: string
      - name: ReportType
        in: query
        schema:
          type: string
      - name: ExcludeRestated
        in: query
        schema:
          type: string
      - name: UpdatedSince
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFundamentals'
  /xFactSetFundamentals/GetFinancialStatements:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: StatementTypes
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: ReportType
        in: query
        schema:
          type: string
      - name: ExcludeRestated
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFinancialStatements'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFinancialStatements'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFinancialStatements'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFinancialStatements'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyFinancialStatements'
  /xFactSetFundamentals/GetBalanceSheets:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: ReportType
        in: query
        schema:
          type: string
      - name: ExcludeRestated
        in: query
        schema:
          type: string
      - name: UpdatedSince
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyBalanceSheet'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyBalanceSheet'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyBalanceSheet'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyBalanceSheet'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyBalanceSheet'
  /xFactSetFundamentals/GetCashFlowStatements:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: ReportType
        in: query
        schema:
          type: string
      - name: ExcludeRestated
        in: query
        schema:
          type: string
      - name: UpdatedSince
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyCashFlowStatement'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyCashFlowStatement'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyCashFlowStatement'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyCashFlowStatement'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyCashFlowStatement'
  /xFactSetFundamentals/GetIncomeStatements:
    get:
      tags:
      - XigniteFactSetFundamentals
      parameters:
      - name: Identifiers
        in: query
        schema:
          type: string
      - name: IdentifierType
        in: query
        schema:
          type: string
      - name: AsOfDate
        in: query
        schema:
          type: string
      - name: ReportType
        in: query
        schema:
          type: string
      - name: ExcludeRestated
        in: query
        schema:
          type: string
      - name: UpdatedSince
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyIncomeStatement'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyIncomeStatement'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyIncomeStatement'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyIncomeStatement'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyIncomeStatement'
components:
  schemas:
    Sector:
      type: object
      properties:
        Code:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
        Industries:
          type: array
          items:
            $ref: '#/components/schemas/Industry'
          nullable: true
      additionalProperties: false
    SectorList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Sectors:
            type: array
            items:
              $ref: '#/components/schemas/Sector'
            nullable: true
        additionalProperties: false
    FinancialStatement:
      type: object
      properties:
        StatementType:
          allOf:
          - $ref: '#/components/schemas/StatementTypes'
        ReportType:
          type: string
          nullable: true
        StatementTemplate:
          allOf:
          - $ref: '#/components/schemas/StatementTemplate'
        FiscalPeriodEndDate:
          type: string
          nullable: true
        IsRestated:
          type: boolean
        Currency:
          type: string
          nullable: true
        Items:
          type: array
          items:
            $ref: '#/components/schemas/Item'
          nullable: true
        FilingStatus:
          type: string
          nullable: true
      additionalProperties: false
    CompanyFinancialStatements:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Company:
            allOf:
            - $ref: '#/components/schemas/Company'
            nullable: true
          FinancialStatements:
            type: array
            items:
              $ref: '#/components/schemas/FinancialStatement'
            nullable: true
        additionalProperties: false
    Fundamental:
      type: object
      properties:
        Outcome:
          type: string
          nullable: true
        Message:
          type: string
          nullable: true
        Type:
          type: string
          nullable: true
        ReportType:
          type: string
          nullable: true
        IsRestated:
          type: boolean
        Value:
          type: string
          nullable: true
        Date:
          type: string
          nullable: true
        LastUpdated:
          type: string
          nullable: true
        Unit:
          type: string
          nullable: true
      additionalProperties: false
    Company:
      type: object
      properties:
        Name:
          type: string
          nullable: true
        Symbol:
          type: string
          nullable: true
        CIK:
          type: string
          nullable: true
        CUSIP:
          type: string
          nullable: true
        SEDOL:
          type: string
          nullable: true
        ISIN:
          type: string
          nullable: true
        FactSetSecurityID:
          type: string
          nullable: true
        FactSetIssuerID:
          type: string
          nullable: true
        Valoren:
          type: string
          nullable: true
        Market:
          type: string
          nullable: true
        MarketIdentificationCode:
          type: string
          nullable: true
        PrimaryMarket:
          type: string
          nullable: true
        PrimaryMarketIdentificationCode:
          type: string
          nullable: true
        Sector:
          type: string
          nullable: true
        Industry:
          type: string
          nullable: true
        StatementTemplate:
          type: string
          nullable: true
      additionalProperties: false
    Industry:
      type: object
      properties:
        Code:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
      additionalProperties: false
    FundamentalsSet:
      type: object
      properties:
        AsOfDate:
          type: string
          nullable: true
        Currency:
          type: string
          nullable: true
        Fundamentals:
          type: array
          items:
            $ref: '#/components/schemas/Fundamental'
          nullable: true
      additionalProperties: false
    ExchangeList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          ExchangeDescriptions:
            type: array
            items:
              $ref: '#/components/schemas/ExchangeDescription'
            nullable: true
        additionalProperties: false
    CompanyBalanceSheet:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Company:
            allOf:
            - $ref: '#/components/schemas/Company'
            nullable: true
          BalanceSheet:
            allOf:
            - $ref: '#/components/schemas/FinancialStatement'
            nullable: true
        additionalProperties: false
    CompanyList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Companies:
            type: array
            items:
              $ref: '#/components/schemas/Company'
            nullable: true
        additionalProperties: false
    CompanyIncomeStatement:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Company:
            allOf:
            - $ref: '#/components/schemas/Company'
            nullable: true
          IncomeStatement:
            allOf:
            - $ref: '#/components/schemas/FinancialStatement'
            nullable: true
        additionalProperties: false
    StatementTemplate:
      enum:
      - Industrial
      - Bank
      - Insurance
      - OtherFinancial
      type: string
    StatementTypes:
      enum:
      - BalanceSheet
      - CashFlowStatement
      - IncomeStatement
      type: string
    FundamentalDescription:
      type: object
      properties:
        Type:
          type: string
          nullable: true
        Name:
          type: string
          nullable: true
        ValueType:
          type: string
          nullable: true
        Unit:
          type: string
          nullable: true
        Description:
          type: string
          nullable: true
        Source:
          type: string
          nullable: true
        DataGroup:
          type: string
          nullable: true
      additionalProperties: false
    Item:
      type: object
      properties:
        Type:
          type: string
          nullable: true
        Level:
          type: string
          nullable: true
        Value:
          type: string
          nullable: true
        Order:
          type: string
          nullable: true
        Unit:
          type: string
          nullable: true
      additionalProperties: false
    OutcomeTypes:
      enum:
      - Success
      - SystemError
      - RequestError
      - RegistrationError
      type: string
    CompanyCashFlowStatement:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Company:
            allOf:
            - $ref: '#/components/schemas/Company'
            nullable: true
          CashFlowStatement:
            allOf:
            - $ref: '#/components/schemas/FinancialStatement'
            nullable: true
        additionalProperties: false
    Common:
      type: object
      properties:
        Delay:
          type: number
          format: double
        Identity:
          type: string
          nullable: true
        Message:
          type: string
          nullable: true
        Outcome:
          allOf:
          - $ref: '#/components/schemas/OutcomeTypes'
      additionalProperties: false
    FundamentalDescriptionList:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          FundamentalDescriptions:
            type: array
            items:
              $ref: '#/components/schemas/FundamentalDescription'
            nullable: true
        additionalProperties: false
    ExchangeDescription:
      type: object
      properties:
        MarketIdentificationCode:
          type: string
          nullable: true
        Market:
          type: string
          nullable: true
        Region:
          type: string
          nullable: true
      additionalProperties: false
    CompanyFundamentals:
      allOf:
      - $ref: '#/components/schemas/Common'
      - type: object
        properties:
          Company:
            allOf:
            - $ref: '#/components/schemas/Company'
            nullable: true
          FundamentalsSets:
            type: array
            items:
              $ref: '#/components/schemas/FundamentalsSet'
            nullable: true
        additionalProperties: false
  securitySchemes:
    basic:
      type: apiKey
      description: Token for your account.
      name: _token
      in: query