FactSet Estimates API — Consensus

naftiko: 1.0.0-alpha2
info:
  label: FactSet Estimates API — Consensus
  description: 'FactSet Estimates API — Consensus. 6 operations. Lead operation: Factset Ratings Consensus Estimates to Fetch
    Buy, Overweight, Hold, Underweight, and Sell.. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Consensus
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: estimates-consensus
    baseUri: https://api.factset.com/content
    description: FactSet Estimates API — Consensus business capability. Self-contained, no shared references.
    resources:
    - name: factset-estimates-v2-consensus-ratings
      path: /factset-estimates/v2/consensus-ratings
      operations:
      - name: getconsensusratings
        method: GET
        description: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getconsensusratingsforlist
        method: POST
        description: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: factset-estimates-v2-fixed-consensus
      path: /factset-estimates/v2/fixed-consensus
      operations:
      - name: getfixedconsensus
        method: GET
        description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Fixed Fiscal Periods
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getfixedconsensusforlist
        method: POST
        description: Factset Consensus Estimates for Fixed Fiscal Periods
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: factset-estimates-v2-rolling-consensus
      path: /factset-estimates/v2/rolling-consensus
      operations:
      - name: getrollingconsensus
        method: GET
        description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getrollingconsensusforlist
        method: POST
        description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: estimates-consensus-rest
    port: 8080
    description: REST adapter for FactSet Estimates API — Consensus. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/factset-estimates/v2/consensus-ratings
      name: factset-estimates-v2-consensus-ratings
      description: REST surface for factset-estimates-v2-consensus-ratings.
      operations:
      - method: GET
        name: getconsensusratings
        description: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        call: estimates-consensus.getconsensusratings
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getconsensusratingsforlist
        description: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        call: estimates-consensus.getconsensusratingsforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-estimates/v2/fixed-consensus
      name: factset-estimates-v2-fixed-consensus
      description: REST surface for factset-estimates-v2-fixed-consensus.
      operations:
      - method: GET
        name: getfixedconsensus
        description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Fixed Fiscal Periods
        call: estimates-consensus.getfixedconsensus
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getfixedconsensusforlist
        description: Factset Consensus Estimates for Fixed Fiscal Periods
        call: estimates-consensus.getfixedconsensusforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-estimates/v2/rolling-consensus
      name: factset-estimates-v2-rolling-consensus
      description: REST surface for factset-estimates-v2-rolling-consensus.
      operations:
      - method: GET
        name: getrollingconsensus
        description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods.
        call: estimates-consensus.getrollingconsensus
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getrollingconsensusforlist
        description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods
        call: estimates-consensus.getrollingconsensusforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: estimates-consensus-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet Estimates API — Consensus. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-ratings-consensus-estimates-fetch
      description: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-consensus.getconsensusratings
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-ratings-consensus-estimates-fetch-2
      description: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: estimates-consensus.getconsensusratingsforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-retrieves-consensus-estimates-requested
      description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Fixed Fiscal Periods
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-consensus.getfixedconsensus
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-consensus-estimates-fixed-fiscal
      description: Factset Consensus Estimates for Fixed Fiscal Periods
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: estimates-consensus.getfixedconsensusforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-retrieves-consensus-estimates-requested-2
      description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-consensus.getrollingconsensus
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-retrieves-consensus-estimates-requested-3
      description: Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: estimates-consensus.getrollingconsensusforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.