Factset Composite API

openapi: 3.0.3
info:
  title: Factset Analytics Datastore About Composite API
  description: Allow clients to fetch precalculated Analytics through predeterministic URLs.
  contact:
    name: FactSet Research Systems
    url: https://developer.factset.com/contact
    email: api@factset.com
  license:
    name: Apache License, Version 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.0.0
servers:
- url: https://api.factset.com
  description: Production
- url: https://api-sandbox.factset.com
  description: Sandbox
security:
- basicAuth: []
tags:
- name: Composite
paths:
  /account-composite:
    post:
      operationId: createAccountComposite
      description: Create a new account composite
      tags:
      - Composite
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createAccountCompositeRequest'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createAccountCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '409':
          $ref: '#/components/responses/ConflictErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listAccountComposite
      description: List account composite
      tags:
      - Composite
      parameters:
      - name: path
        in: query
        required: false
        schema:
          type: string
          default: 'Client:'
          example: string
        description: Directory to list
      - name: name
        in: query
        required: false
        schema:
          type: string
          example: string
        description: Return only files whose name includes this query
      - name: description
        in: query
        required: false
        schema:
          type: string
          example: string
        description: Return only files whose name includes this query
      - name: _paginationLimit
        in: query
        required: false
        schema:
          type: number
          default: 100
          example: 0
        description: Number of directory items to return
      - name: _paginationCursor
        in: query
        required: false
        schema:
          type: string
          example: string
        description: Cursor used for paging.  Fetch items after the specified cursor
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/listAccountCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /account-composite/{id}:
    delete:
      operationId: deleteAccountComposite
      description: Remove a account composite
      tags:
      - Composite
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 270c2fa8-9110-444b-9101-17e10132fe0a
        description: Unique identifier for the account composite to be deleted
        example: 270c2fa8-9110-444b-9101-17e10132fe0a
      - name: reason
        in: query
        required: false
        schema:
          type: string
          example: string
        description: User auditable reason that the account composite is being removed
      responses:
        '204':
          description: Success
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '409':
          $ref: '#/components/responses/ConflictErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: readAccountComposite
      description: Read a account composite
      tags:
      - Composite
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 270c2fa8-9110-444b-9101-17e10132fe0a
        description: Unique identifier of the account composite to be read
        example: 270c2fa8-9110-444b-9101-17e10132fe0a
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/readAccountCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateAccountComposite
      description: Modify a account composite
      tags:
      - Composite
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 270c2fa8-9110-444b-9101-17e10132fe0a
        description: Unique identifier for the account composite to be updated
        example: 270c2fa8-9110-444b-9101-17e10132fe0a
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAccountCompositeRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateAccountCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /holdings-composite/{id}:
    get:
      operationId: readHoldingsComposite
      description: Read a holdings composite
      tags:
      - Composite
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 270c2fa8-9110-444b-9101-17e10132fe0a
        description: Unique identifier of the holdings composite to be read
        example: 270c2fa8-9110-444b-9101-17e10132fe0a
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/readHoldingsCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /returns-composite/{id}:
    get:
      operationId: readReturnsComposite
      description: Read a returns composite
      tags:
      - Composite
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 270c2fa8-9110-444b-9101-17e10132fe0a
        description: Unique identifier of the returns composite to be read
        example: 270c2fa8-9110-444b-9101-17e10132fe0a
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/readReturnsCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /instrument/composite/get:
    get:
      tags:
      - Composite
      operationId: get/instrument/composite/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 Composite Instrument and Its Components.
      description: Composite instrument and its components.
      parameters:
      - name: identifier
        in: query
        schema:
          type: string
          pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[SLR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$|^[B-DF-HJ-NP-TV-Z0-9]{6}[0-9]$|^[A-Z]{2}[A-Z0-9]{9}[0-9]$|^[A-Z1-9][A-Z0-9]{5}$|^[0-9]{1,9}$|^[A-Z0-9]{8}[0-9]$
          maxLength: 50
          exclusiveMaximum: false
          minLength: 3
          exclusiveMinimum: false
          description: Identifier to resolve.
        required: true
      - name: identifierType
        in: query
        schema:
          type: string
          description: Type of the identifier.
          x-enum-description:
          - MDG identifier of an instrument.
          - MDG identifier of a listing.
          - FactSet Permanent Identifier on security level.
          - FactSet Permanent Identifier on listing level.
          - Regional FactSet Permanent Identifier.
          - FactSet market symbol of a listing.
          - Regional FactSet ticker symbol.
          - SEDOL or IDII of a listing.
          - ISIN of an instrument.
          - WKN of an instrument.
          - Valor number of an instrument.
          - CUSIP or CINS identifier of an instrument
          enum:
          - idInstrument
          - idNotation
          - fdsPermanentIdentifierSecurity
          - fdsPermanentIdentifierListing
          - fdsPermanentIdentifierRegional
          - tickerExchange
          - tickerRegion
          - sedol
          - isin
          - wkn
          - valor
          - cusip
        required: true
      - name: _attributes
        in: query
        schema:
          type: array
          items:
            type: string
            maxLength: 100
            exclusiveMaximum: false
          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
          exclusiveMinimum: false
          exclusiveMaximum: false
      responses:
        '200':
          $ref: '#/components/responses/GetInstrumentCompositeGet200Response'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /stock/composite/profile/getByNotation:
    get:
      tags:
      - Composite
      operationId: get/stock/composite/profile/getByNotation
      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: Provides key elements of a stock profile together with the profile of the issuing company.
      description: Provides key elements of a stock profile together with the profile of the issuing company.
      parameters:
      - name: identifier
        in: query
        schema:
          type: string
          pattern: ^([B-DF-HJ-NP-TV-Z0-9]{6}-[LR])|([A-Z0-9.]{1,47}-[A-Z0-9]{2,4})|([0-9]{3,20})$
          maxLength: 50
          exclusiveMaximum: false
          minLength: 3
          exclusiveMinimum: false
          description: Identifier to resolve.
        required: true
      - name: identifierType
        in: query
        schema:
          type: string
          description: Type of the identifier.
          x-enum-description:
          - MDG identifier of a listing.
          - FactSet market symbol of a listing.
          - Regional FactSet ticker symbol, identifying the primary listing in the region.
          - FactSet Permanent Identifier on listing level.
          - Regional FactSet Permanent Identifier, identifying the primary listing in the region.
          enum:
          - idNotation
          - tickerExchange
          - tickerRegion
          - fdsPermanentIdentifierListing
          - fdsPermanentIdentifierRegional
        required: true
      - name: _attributes
        in: query
        schema:
          type: array
          items:
            type: string
            maxLength: 100
            exclusiveMaximum: false
          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
          exclusiveMinimum: false
          exclusiveMaximum: false
      responses:
        '200':
          $ref: '#/components/responses/GetStockCompositeProfileGetByNotation200Response'
components:
  schemas:
    readHoldingsCompositeResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - Account
              - AccountComposite
              - ExchangeRate
              - GlobalAccountProperties
              - Holdings
              - HoldingsComposite
              - PortfolioGroup
              - Returns
              - ReturnsComposite
              - SecurityMaster
              - TradeData
              - VendorReturnSeries
              nullable: false
              description: Metadata file type formatted for consistency with the REST api
            id:
              type: string
              nullable: false
              description: Unique identifier for this metadata file.
              example: f132625b-1506-4cc3-b2e8-2c75de39c79c
            display:
              type: string
              nullable: false
              description: The GUI path of this file, including the name and extension.
              example: SP50
            path:
              type: string
              nullable: false
              description: The GUI path to this object.
              example: 'Client:'
            name:
              type: string
              nullable: false
              description: Name of this file object including the extension.
              example: SP50
            description:
              type: string
              nullable: true
              description: User provided description of this file.
              example: Meaningful description of vendor returns
          nullable: true
          description: Read a metadata file by its id.
          example: example_value
      nullable: true
    readAccountCompositeResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - AccountComposite
              nullable: false
              description: Metadata file type formatted for consistency with the REST api
            id:
              type: string
              nullable: false
              description: Unique identifier for this metadata file.
              example: 9a030822-d1ee-4fc0-a598-75e65d1512fd
            display:
              type: string
              nullable: false
              description: The GUI path of this file, including the name and extension.
              example: Client:EXAMPLE.ACTM
            path:
              type: string
              nullable: false
              description: The GUI path to this object.
              example: 'Client:'
            name:
              type: string
              nullable: false
              description: Name of this file object including the extension.
              example: EXAMPLE.ACTM
            description:
              type: string
              nullable: true
              description: User provided description of this file.
              example: Domestic equity composite
            dataCatalog:
              type: object
              properties:
                holdings:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - BLENDED
                      - FIXED_DOLLAR
                      - FLOATING
                      - GIPS
                      - SIMPLE
                      nullable: false
                      description: The type of composite.  Determines how component weights are interpreted
                    methodology:
                      type: string
                      enum:
                      - BUY_AND_HOLD
                      - ORDER_MANAGMENT_SYSTEM
                      - TRANSACTIONS
                      nullable: false
                      description: The holdings methodology to apply when reading this account's holdings data.
                    rebalance:
                      type: object
                      properties:
                        frequency:
                          type: string
                          enum:
                          - ANNUALLY
                          - BUY_AND_HOLD
                          - WEEKLY
                          - MONTHLY
                          - QUARTERLY
                          - SEMI_ANNUALLY
                          - CONSTANTLY
                          - DAILY
                          nullable: false
                        start:
                          type: string
                          enum:
                          - SPECIFIC_POINT
                          - LATEST_FREQUENCY_END
                          - REPORT_START_DATE
                          nullable: false
                        month:
                          type: string
                          enum:
                          - APRIL
                          - AUGUST
                          - DECEMBER
                          - FEBRUARY
                          - JANUARY
                          - JULY
                          - JUNE
                          - MARCH
                          - MAY
                          - NOVEMBER
                          - OCTOBER
                          - SEPTEMBER
                          nullable: false
                        dayOfMonth:
                          type: string
                          nullable: false
                        date:
                          type: string
                          nullable: false
                        quarters:
                          type: string
                          enum:
                          - FEBRUARY_MAY_AUGUST_NOVEMBER
                          - JANUARY_APRIL_JULY_OCTOBER
                          - MARCH_JUNE_SEPTEMBER_DECEMBER
                          nullable: false
                        useActualFrequencies:
                          type: boolean
                          nullable: false
                        periods:
                          type: string
                          enum:
                          - APRIL_OCTOBER
                          - FEBRUARY_AUGUST
                          - JANUARY_JULY
                          - JUNE_DECEMBER
                          - MARCH_SEPTEMBER
                          - MAY_NOVEMBER
                          nullable: false
                        dayOfWeek:
                          type: string
                          enum:
                          - FRIDAY
                          - MONDAY
                          - SATURDAY
                          - SUNDAY
                          - THURSDAY
                          - TUESDAY
                          - WEDNESDAY
                          nullable: false
                      nullable: false
                      description: Settings used to determine how a composite's components are rebalanced.
                      example:
                        frequency: DAILY
                    components:
                      type: object
                      properties:
                        all:
                          type: array
                          items:
                            type: object
                            properties:
                              startDate:
                                type: string
                                nullable: false
                                description: 'First date the data is valid.  If using the EARLIEST date in the report, this

                                  will be set to 0000-01-01'
                                example: '2022-01-01'
                              endDate:
                                type: string
                                nullable: false
                                description: 'Last date the data is valid.  If using the LATEST date in the report, this

                                  will be set to 9999-12-31'
                                example: '2022-01-31'
                              weight:
                                type: number
                                nullable: false
                                example: 10
                              isSpar:
                                type: boolean
                                nullable: false
                              portfolio:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                    - Account
                                    - AccountComposite
                                    - Forbidden
                                    - HoldingsComposite
                                    - Returns
                                    - ReturnsComposite
                                    - Vendor
                                    nullable: false
                                    description: Metadata file type formatted for consistency with the REST api
                                  id:
                                    type: string
                                    nullable: false
                                    description: Unique identifier for this metadata file.
                                    example: BENCH:SP50
                                  display:
                                    type: string
                                    nullable: false
                                    description: String suitable for display in a UI.
                                    example: Client:EXAMPLE.CSTM
                                nullable: false
                            nullable: false
                          description: Raw component, time range list
                      nullable: false
                      description: 'A holdings portfolio or vendor benchmark to use as this accounts''s holdings

                        data.'
                  nullable: true
                  description: Describes the location of the account's holdings data containers.
                returns:
                  type: object
                  properties:
                    primaryType:
                      type: string
                      enum:
                      - CAPITAL
                      - GROSS
                      - NET
                      - NET_AFTER_TAX
                      - NET_INCOME
                      - OTHER_1
                      - OTHER_2
                      - OTHER_3
                      - OTHER_4
                      - PRIVATE_EQUITY_GROSS
                      - PRIVATE_EQUITY_NET
                      - REAL_ESTATE_TOTAL
                      nullable: false
                      description: The type of the default return series portfolio used for this account.
                      example: NET
                    net:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Forbidden
                              - Returns
                              - ReturnsComposite
                              - Vendor
                              nullable: false
                              description: Metadata file type formatted for consistency with the REST api
                            id:
                              type: string
                              nullable: false
                              description: Unique identifier for this metadata file.
                              example: BENCH:SP50
                            display:
                              type: string
                              nullable: false
                              description: String suitable for display in a UI.
                              example: Client:EXAMPLE.CSTM
                          nullable: false
                      nullable: true
                      description: 'Reference to the NET returns portfolio directly.  NOTE: this portfolio is

                        included in the portfolios field above as well.'
                    gross:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Forbidden
                              - Returns
                              - ReturnsComposite
                              - Vendor
                              nullable: false
                              description: Metadata file type formatted for consistency with the REST api
                            id:
                              type: string
                              nullable: false
                              description: Unique identifier for this metadata file.
                              example: BENCH:SP50
                            display:
                              type: string
                              nullable: false
                              description: String suitable for display in a UI.
                              example: Client:EXAMPLE.CSTM
                          nullable: false
                      nullable: true
                      description: 'Reference to the GROSS returns portfolio directly.  NOTE: this portfolio is

                        included in the portfolios field above as well.'
                    other1:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Forbidden
                              - Returns
                              - ReturnsComposite
                              - Vendor
                              nullable: false
                              description: Metadata file type formatted for consistency with the REST api
                            id:
                              type: string
                              nullable: false
                              description: Unique identifier for this metadata file.
                              example: BENCH:SP50
                            display:
                              type: string
                              nullable: false
                              description: String suitable for display in a UI.
                              example: Client:EXAMPLE.CSTM
                          nullable: false
                      nullable: true
                      description: 'Reference to the OTHER1 returns portfolio directly.  NOTE: this portfolio is

                        included in the portfolios field above as well.'
                    other2:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:


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