FactSet Estimates API — Estimates

naftiko: 1.0.0-alpha2
info:
  label: FactSet Estimates API — Estimates
  description: 'FactSet Estimates API — Estimates. 18 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
  - Estimates
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: estimates-estimates
    baseUri: https://api.factset.com/content
    description: FactSet Estimates API — Estimates 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-detail-ratings
      path: /factset-estimates/v2/detail-ratings
      operations:
      - name: getdetailratings
        method: GET
        description: Factset Broker Detail Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getdetailratingsforlist
        method: POST
        description: Factset Broker Detail 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-fixed-detail
      path: /factset-estimates/v2/fixed-detail
      operations:
      - name: getfixeddetail
        method: GET
        description: Factset Estimates Detail Data for Fixed Fiscal Periods
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getfixeddetailforlist
        method: POST
        description: Factset Estimates Detail Data 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-metrics
      path: /factset-estimates/v2/metrics
      operations:
      - name: getestimatemetrics
        method: GET
        description: Factset Available Estimate Metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getestimatemetricsforlist
        method: POST
        description: Factset Available Estimate Metrics or Ratios.
        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
    - name: factset-estimates-v2-rolling-detail
      path: /factset-estimates/v2/rolling-detail
      operations:
      - name: getrollingdetail
        method: GET
        description: Factset Estimates Detail Data for Rolling Fiscal Periods
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getrollingdetailforlist
        method: POST
        description: Factset Estimates Detail Data for Rolling 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-segments
      path: /factset-estimates/v2/segments
      operations:
      - name: getsegments
        method: GET
        description: Factset Retrieves Product & Geographic Segment Estimates for a Requested List of Ids and Fiscal Periods
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getsegmentsforlist
        method: POST
        description: Factset Retrieves Product Segment Estimates for a Requested List of Ids and 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-surprise
      path: /factset-estimates/v2/surprise
      operations:
      - name: getsurprise
        method: GET
        description: Factset Surprise Estimates for Rolling Fiscal Periods
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getsurpriseforlist
        method: POST
        description: Factset Surprise Estimates for 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-estimates-rest
    port: 8080
    description: REST adapter for FactSet Estimates API — Estimates. 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-estimates.getconsensusratings
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getconsensusratingsforlist
        description: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        call: estimates-estimates.getconsensusratingsforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-estimates/v2/detail-ratings
      name: factset-estimates-v2-detail-ratings
      description: REST surface for factset-estimates-v2-detail-ratings.
      operations:
      - method: GET
        name: getdetailratings
        description: Factset Broker Detail Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        call: estimates-estimates.getdetailratings
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getdetailratingsforlist
        description: Factset Broker Detail Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        call: estimates-estimates.getdetailratingsforlist
        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-estimates.getfixedconsensus
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getfixedconsensusforlist
        description: Factset Consensus Estimates for Fixed Fiscal Periods
        call: estimates-estimates.getfixedconsensusforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-estimates/v2/fixed-detail
      name: factset-estimates-v2-fixed-detail
      description: REST surface for factset-estimates-v2-fixed-detail.
      operations:
      - method: GET
        name: getfixeddetail
        description: Factset Estimates Detail Data for Fixed Fiscal Periods
        call: estimates-estimates.getfixeddetail
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getfixeddetailforlist
        description: Factset Estimates Detail Data for Fixed Fiscal Periods
        call: estimates-estimates.getfixeddetailforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-estimates/v2/metrics
      name: factset-estimates-v2-metrics
      description: REST surface for factset-estimates-v2-metrics.
      operations:
      - method: GET
        name: getestimatemetrics
        description: Factset Available Estimate Metrics
        call: estimates-estimates.getestimatemetrics
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getestimatemetricsforlist
        description: Factset Available Estimate Metrics or Ratios.
        call: estimates-estimates.getestimatemetricsforlist
        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-estimates.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-estimates.getrollingconsensusforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-estimates/v2/rolling-detail
      name: factset-estimates-v2-rolling-detail
      description: REST surface for factset-estimates-v2-rolling-detail.
      operations:
      - method: GET
        name: getrollingdetail
        description: Factset Estimates Detail Data for Rolling Fiscal Periods
        call: estimates-estimates.getrollingdetail
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getrollingdetailforlist
        description: Factset Estimates Detail Data for Rolling Fiscal Periods
        call: estimates-estimates.getrollingdetailforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-estimates/v2/segments
      name: factset-estimates-v2-segments
      description: REST surface for factset-estimates-v2-segments.
      operations:
      - method: GET
        name: getsegments
        description: Factset Retrieves Product & Geographic Segment Estimates for a Requested List of Ids and Fiscal Periods
        call: estimates-estimates.getsegments
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getsegmentsforlist
        description: Factset Retrieves Product Segment Estimates for a Requested List of Ids and Fiscal Periods
        call: estimates-estimates.getsegmentsforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-estimates/v2/surprise
      name: factset-estimates-v2-surprise
      description: REST surface for factset-estimates-v2-surprise.
      operations:
      - method: GET
        name: getsurprise
        description: Factset Surprise Estimates for Rolling Fiscal Periods
        call: estimates-estimates.getsurprise
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getsurpriseforlist
        description: Factset Surprise Estimates for Rolling Fiscal Periods
        call: estimates-estimates.getsurpriseforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: estimates-estimates-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet Estimates API — Estimates. 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-estimates.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-estimates.getconsensusratingsforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-broker-detail-estimates-fetch
      description: Factset Broker Detail Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-estimates.getdetailratings
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-broker-detail-estimates-fetch-2
      description: Factset Broker Detail Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: estimates-estimates.getdetailratingsforlist
      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-estimates.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-estimates.getfixedconsensusforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-estimates-detail-data-fixed
      description: Factset Estimates Detail Data for Fixed Fiscal Periods
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-estimates.getfixeddetail
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-estimates-detail-data-fixed-2
      description: Factset Estimates Detail Data for Fixed Fiscal Periods
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: estimates-estimates.getfixeddetailforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-available-estimate-metrics
      description: Factset Available Estimate Metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-estimates.getestimatemetrics
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-available-estimate-metrics-ratios
      description: Factset Available Estimate Metrics or Ratios.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: estimates-estimates.getestimatemetricsforlist
      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-estimates.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-estimates.getrollingconsensusforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-estimates-detail-data-rolling
      description: Factset Estimates Detail Data for Rolling Fiscal Periods
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-estimates.getrollingdetail
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-estimates-detail-data-rolling-2
      description: Factset Estimates Detail Data for Rolling Fiscal Periods
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: estimates-estimates.getrollingdetailforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-retrieves-product-geographic-segment
      description: Factset Retrieves Product & Geographic Segment Estimates for a Requested List of Ids and Fiscal Periods
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-estimates.getsegments
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-retrieves-product-segment-estimates
      description: Factset Retrieves Product Segment Estimates for a Requested List of Ids and Fiscal Periods
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: estimates-estimates.getsegmentsforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-surprise-estimates-rolling-fiscal
      description: Factset Surprise Estimates for Rolling Fiscal Periods
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: estimates-estimates.getsurprise
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-surprise-estimates-rolling-fiscal-2
      description: Factset Surprise Estimates for Rolling Fiscal Periods
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: estimates-estimates.getsurpriseforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.