FactSet Estimates API — Ratings

naftiko: 1.0.0-alpha2
info:
  label: FactSet Estimates API — Ratings
  description: 'FactSet Estimates API — Ratings. 4 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
  - Ratings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: estimates-ratings
    baseUri: https://api.factset.com/content
    description: FactSet Estimates API — Ratings 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
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: estimates-ratings-rest
    port: 8080
    description: REST adapter for FactSet Estimates API — Ratings. 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-ratings.getconsensusratings
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getconsensusratingsforlist
        description: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        call: estimates-ratings.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-ratings.getdetailratings
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getdetailratingsforlist
        description: Factset Broker Detail Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.
        call: estimates-ratings.getdetailratingsforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: estimates-ratings-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet Estimates API — Ratings. 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-ratings.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-ratings.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-ratings.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-ratings.getdetailratingsforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.