FactSet SPAR Engine API — Analytics

naftiko: 1.0.0-alpha2
info:
  label: FactSet SPAR Engine API — Analytics
  description: 'FactSet SPAR Engine API — Analytics. 15 operations. Lead operation: Factset Get Spar Account Returns Type
    Details. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Analytics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: spar-engine-analytics
    baseUri: https://api.factset.com
    description: FactSet SPAR Engine API — Analytics business capability. Self-contained, no shared references.
    resources:
    - name: analytics-engines-spar-v3-accounts-accountPath-returns-type
      path: /analytics/engines/spar/v3/accounts/{accountPath}/returns-type
      operations:
      - name: getsparreturnstype
        method: GET
        description: Factset Get Spar Account Returns Type Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountPath
          in: path
          type: string
          description: URL encoded account path
          required: true
    - name: analytics-engines-spar-v3-benchmarks
      path: /analytics/engines/spar/v3/benchmarks
      operations:
      - name: getsparbenchmarkbyid
        method: GET
        description: Factset Get Spar Benchmark Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          description: Benchmark Identifier
          required: true
    - name: analytics-engines-spar-v3-calculations
      path: /analytics/engines/spar/v3/calculations
      operations:
      - name: postandcalculate
        method: POST
        description: Factset Create and Run Spar Calculation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-FactSet-Api-Long-Running-Deadline
          in: header
          type: integer
          description: Long running deadline in seconds when only one unit is passed in the POST body.
        - name: Cache-Control
          in: header
          type: string
          description: Standard HTTP header.  Accepts max-stale.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getallcalculations
        method: GET
        description: Factset Get All Calculations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: pageNumber
          in: query
          type: integer
    - name: analytics-engines-spar-v3-calculations-id
      path: /analytics/engines/spar/v3/calculations/{id}
      operations:
      - name: putandcalculate
        method: PUT
        description: Factset Create or Update Spar Calculation and Run It.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Create and Run SPAR calculation endpoint
          required: true
        - name: X-FactSet-Api-Long-Running-Deadline
          in: header
          type: integer
          description: Long running deadline in seconds when only one unit is passed in the PUT body.
        - name: Cache-Control
          in: header
          type: string
          description: Standard HTTP header.  Accepts max-stale.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcalculationparameters
        method: GET
        description: Factset Get Spar Calculation Parameters by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Create and Run SPAR calculation endpoint
          required: true
      - name: cancelcalculationbyid
        method: DELETE
        description: Factset Cancel Spar Calculation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Create and Run SPAR calculation endpoint
          required: true
    - name: analytics-engines-spar-v3-calculations-id-status
      path: /analytics/engines/spar/v3/calculations/{id}/status
      operations:
      - name: getcalculationstatusbyid
        method: GET
        description: Factset Get Spar Calculation Status by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Create and Run SPAR calculation endpoint
          required: true
    - name: analytics-engines-spar-v3-calculations-id-units-unitId-result
      path: /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result
      operations:
      - name: getcalculationunitresultbyid
        method: GET
        description: Factset Get Spar Calculation Result by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Get SPAR calculation status by id endpoint
          required: true
        - name: unitId
          in: path
          type: string
          description: from url, provided from the location header in the Get SPAR calculation status by id endpoint
          required: true
    - name: analytics-engines-spar-v3-components
      path: /analytics/engines/spar/v3/components
      operations:
      - name: getsparcomponents
        method: GET
        description: Factset Get Spar Components
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: document
          in: query
          type: string
          description: Document Name
          required: true
    - name: analytics-engines-spar-v3-components-id
      path: /analytics/engines/spar/v3/components/{id}
      operations:
      - name: getsparcomponentbyid
        method: GET
        description: Factset Get Spar Component by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier for a SPAR component
          required: true
    - name: analytics-engines-spar-v3-documents-path
      path: /analytics/engines/spar/v3/documents/{path}
      operations:
      - name: getspar3documents
        method: GET
        description: Factset Gets Spar3 Documents and Sub-directories in a Directory
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          description: The directory to get the documents in
          required: true
    - name: analytics-engines-spar-v3-frequencies
      path: /analytics/engines/spar/v3/frequencies
      operations:
      - name: getsparfrequencies
        method: GET
        description: Factset Get Spar Frequencies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: analytics-lookups-v3-accounts-path
      path: /analytics/lookups/v3/accounts/{path}
      operations:
      - name: getaccounts
        method: GET
        description: Factset Get Accounts and Sub-directories in a Directory
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          description: The directory to get the accounts and sub-directories.
          required: true
    - name: analytics-lookups-v3-currencies
      path: /analytics/lookups/v3/currencies
      operations:
      - name: getcurrencies
        method: GET
        description: Factset Get Currencies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.FACTSET_API_KEY}}'
  exposes:
  - type: rest
    namespace: spar-engine-analytics-rest
    port: 8080
    description: REST adapter for FactSet SPAR Engine API — Analytics. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/analytics/engines/spar/v3/accounts/{accountpath}/returns-type
      name: analytics-engines-spar-v3-accounts-accountpath-returns-type
      description: REST surface for analytics-engines-spar-v3-accounts-accountPath-returns-type.
      operations:
      - method: GET
        name: getsparreturnstype
        description: Factset Get Spar Account Returns Type Details
        call: spar-engine-analytics.getsparreturnstype
        with:
          accountPath: rest.accountPath
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/benchmarks
      name: analytics-engines-spar-v3-benchmarks
      description: REST surface for analytics-engines-spar-v3-benchmarks.
      operations:
      - method: GET
        name: getsparbenchmarkbyid
        description: Factset Get Spar Benchmark Details
        call: spar-engine-analytics.getsparbenchmarkbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/calculations
      name: analytics-engines-spar-v3-calculations
      description: REST surface for analytics-engines-spar-v3-calculations.
      operations:
      - method: POST
        name: postandcalculate
        description: Factset Create and Run Spar Calculation
        call: spar-engine-analytics.postandcalculate
        with:
          X-FactSet-Api-Long-Running-Deadline: rest.X-FactSet-Api-Long-Running-Deadline
          Cache-Control: rest.Cache-Control
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getallcalculations
        description: Factset Get All Calculations
        call: spar-engine-analytics.getallcalculations
        with:
          pageNumber: rest.pageNumber
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/calculations/{id}
      name: analytics-engines-spar-v3-calculations-id
      description: REST surface for analytics-engines-spar-v3-calculations-id.
      operations:
      - method: PUT
        name: putandcalculate
        description: Factset Create or Update Spar Calculation and Run It.
        call: spar-engine-analytics.putandcalculate
        with:
          id: rest.id
          X-FactSet-Api-Long-Running-Deadline: rest.X-FactSet-Api-Long-Running-Deadline
          Cache-Control: rest.Cache-Control
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getcalculationparameters
        description: Factset Get Spar Calculation Parameters by Id
        call: spar-engine-analytics.getcalculationparameters
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: cancelcalculationbyid
        description: Factset Cancel Spar Calculation
        call: spar-engine-analytics.cancelcalculationbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/calculations/{id}/status
      name: analytics-engines-spar-v3-calculations-id-status
      description: REST surface for analytics-engines-spar-v3-calculations-id-status.
      operations:
      - method: GET
        name: getcalculationstatusbyid
        description: Factset Get Spar Calculation Status by Id
        call: spar-engine-analytics.getcalculationstatusbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/calculations/{id}/units/{unitid}/result
      name: analytics-engines-spar-v3-calculations-id-units-unitid-result
      description: REST surface for analytics-engines-spar-v3-calculations-id-units-unitId-result.
      operations:
      - method: GET
        name: getcalculationunitresultbyid
        description: Factset Get Spar Calculation Result by Id
        call: spar-engine-analytics.getcalculationunitresultbyid
        with:
          id: rest.id
          unitId: rest.unitId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/components
      name: analytics-engines-spar-v3-components
      description: REST surface for analytics-engines-spar-v3-components.
      operations:
      - method: GET
        name: getsparcomponents
        description: Factset Get Spar Components
        call: spar-engine-analytics.getsparcomponents
        with:
          document: rest.document
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/components/{id}
      name: analytics-engines-spar-v3-components-id
      description: REST surface for analytics-engines-spar-v3-components-id.
      operations:
      - method: GET
        name: getsparcomponentbyid
        description: Factset Get Spar Component by Id
        call: spar-engine-analytics.getsparcomponentbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/documents/{path}
      name: analytics-engines-spar-v3-documents-path
      description: REST surface for analytics-engines-spar-v3-documents-path.
      operations:
      - method: GET
        name: getspar3documents
        description: Factset Gets Spar3 Documents and Sub-directories in a Directory
        call: spar-engine-analytics.getspar3documents
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/spar/v3/frequencies
      name: analytics-engines-spar-v3-frequencies
      description: REST surface for analytics-engines-spar-v3-frequencies.
      operations:
      - method: GET
        name: getsparfrequencies
        description: Factset Get Spar Frequencies
        call: spar-engine-analytics.getsparfrequencies
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/lookups/v3/accounts/{path}
      name: analytics-lookups-v3-accounts-path
      description: REST surface for analytics-lookups-v3-accounts-path.
      operations:
      - method: GET
        name: getaccounts
        description: Factset Get Accounts and Sub-directories in a Directory
        call: spar-engine-analytics.getaccounts
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/lookups/v3/currencies
      name: analytics-lookups-v3-currencies
      description: REST surface for analytics-lookups-v3-currencies.
      operations:
      - method: GET
        name: getcurrencies
        description: Factset Get Currencies
        call: spar-engine-analytics.getcurrencies
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: spar-engine-analytics-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet SPAR Engine API — Analytics. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-get-spar-account-returns
      description: Factset Get Spar Account Returns Type Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getsparreturnstype
      with:
        accountPath: tools.accountPath
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-spar-benchmark-details
      description: Factset Get Spar Benchmark Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getsparbenchmarkbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-and-run-spar
      description: Factset Create and Run Spar Calculation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: spar-engine-analytics.postandcalculate
      with:
        X-FactSet-Api-Long-Running-Deadline: tools.X-FactSet-Api-Long-Running-Deadline
        Cache-Control: tools.Cache-Control
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-all-calculations
      description: Factset Get All Calculations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getallcalculations
      with:
        pageNumber: tools.pageNumber
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-update-spar-calculation
      description: Factset Create or Update Spar Calculation and Run It.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: spar-engine-analytics.putandcalculate
      with:
        id: tools.id
        X-FactSet-Api-Long-Running-Deadline: tools.X-FactSet-Api-Long-Running-Deadline
        Cache-Control: tools.Cache-Control
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-spar-calculation-parameters
      description: Factset Get Spar Calculation Parameters by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getcalculationparameters
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-cancel-spar-calculation
      description: Factset Cancel Spar Calculation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: spar-engine-analytics.cancelcalculationbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-spar-calculation-status
      description: Factset Get Spar Calculation Status by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getcalculationstatusbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-spar-calculation-result
      description: Factset Get Spar Calculation Result by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getcalculationunitresultbyid
      with:
        id: tools.id
        unitId: tools.unitId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-spar-components
      description: Factset Get Spar Components
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getsparcomponents
      with:
        document: tools.document
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-spar-component-id
      description: Factset Get Spar Component by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getsparcomponentbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-gets-spar3-documents-and
      description: Factset Gets Spar3 Documents and Sub-directories in a Directory
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getspar3documents
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-spar-frequencies
      description: Factset Get Spar Frequencies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getsparfrequencies
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-accounts-and-sub
      description: Factset Get Accounts and Sub-directories in a Directory
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getaccounts
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-currencies
      description: Factset Get Currencies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: spar-engine-analytics.getcurrencies
      outputParameters:
      - type: object
        mapping: $.