> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentkey.app/llms.txt
> Use this file to discover all available pages before exploring further.

# finance.estimates

> Analyst consensus for a company — EPS / revenue estimates per horizon and the buy / hold / sell split. Returns a normalized Estimates object.



## OpenAPI

````yaml api-reference/openapi/v2.yaml POST /v2/ops/finance.estimates
openapi: 3.1.0
info:
  description: >-
    Fixed, versioned, provider-independent methods over AgentKey's upstream
    catalog. Each method has a stable name, input schema and output schema; the
    server picks the upstream provider, fails over, normalizes fields and
    refunds failed attempts. Every response names the provider that served it,
    the credits charged and every attempt made.
  title: AgentKey Scenario Methods
  version: '2'
servers:
  - url: https://api.agentkey.app
security: []
paths:
  /v2/ops/finance.estimates:
    post:
      tags:
        - finance
      summary: >-
        Analyst consensus for a company — EPS / revenue estimates per horizon
        and the buy / hold / sell split. Returns a normalized Estimates object.
      description: >-
        Symbol forms as in finance.quote. yfinance fills both the recommendation
        counts and the per-horizon estimates; Finnhub (US fallback) fills only
        the recommendation counts, so periods is null there.


        Fixed price: 0.1 credits per successful call, whichever provider serves
        it.
      operationId: finance_estimates
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                fields:
                  $ref: '#/components/schemas/FieldsProjection'
                include_raw:
                  $ref: '#/components/schemas/IncludeRaw'
                provider:
                  $ref: '#/components/schemas/ProviderShorthand'
                routing:
                  $ref: '#/components/schemas/Routing'
                symbol:
                  description: 'Ticker: AAPL, 0700.HK.'
                  type: string
              required:
                - symbol
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimatesEnvelope'
          description: Success envelope
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/InsufficientCredits'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '502':
          $ref: '#/components/responses/UpstreamFailed'
        '504':
          $ref: '#/components/responses/Timeout'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    FieldsProjection:
      description: >-
        Projection: keep only these dotted paths of data, e.g. ["items.id",
        "items.text"].
      items:
        type: string
      type: array
    IncludeRaw:
      default: false
      description: >-
        Attach the raw upstream payload as `raw` (not a stable contract;
        truncated above 256 KB).
      type: boolean
    ProviderShorthand:
      description: Shorthand for routing.only = [provider].
      type: string
    Routing:
      additionalProperties: false
      description: >-
        Provider routing override. order: try these providers first; only:
        restrict to these (equivalent to pinning); allow_fallbacks: false tries
        only the first eligible provider.
      properties:
        allow_fallbacks:
          default: true
          description: false = try only the first eligible provider.
          type: boolean
        only:
          description: Restrict to these providers.
          items:
            type: string
          type: array
        order:
          description: Providers to try first, in order.
          items:
            type: string
          type: array
        strategy:
          default: auto
          description: >-
            How eligible providers are ordered. auto = the method's curated
            order. fastest / stable / popular are specified but not implemented
            yet (400 until then). The price is fixed whatever the strategy;
            mutually exclusive with order.
          enum:
            - auto
          type: string
      type: object
    EstimatesEnvelope:
      allOf:
        - $ref: '#/components/schemas/Envelope'
        - properties:
            data:
              $ref: '#/components/schemas/Estimates'
          type: object
      description: Success envelope whose data is a Estimates.
    Envelope:
      description: Success envelope. `data` is the method's output object.
      properties:
        attempts:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
        credits_charged:
          description: Credits charged for this call (the method's fixed price).
          type: number
        data:
          description: Method output (typed per method).
        op:
          description: Method name.
          type: string
        op_version:
          description: Method version that served the call.
          type: integer
        provider:
          description: Provider that actually served the call.
          type: string
        raw:
          description: Upstream payload, only with include_raw=true. Not a stable contract.
        raw_truncated:
          type: boolean
        request_id:
          description: Correlation id; quote it in support requests.
          type: string
        took_ms:
          type: integer
        unsupported_fields:
          description: >-
            Output paths this provider structurally does not supply; such fields
            are null for a different reason than 'missing on this record'.
          items:
            type: string
          type: array
      required:
        - op
        - op_version
        - provider
        - request_id
        - credits_charged
        - took_ms
        - attempts
        - unsupported_fields
        - data
      type: object
    Estimates:
      additionalProperties: false
      description: >-
        Analyst consensus for one company — the latest recommendation split and
        the per-period EPS / revenue estimates.
      properties:
        periods:
          description: >-
            Consensus per forecast horizon; null when the provider only gives
            recommendations.
          items:
            properties:
              eps_analysts:
                description: Analysts in the EPS consensus.
                type:
                  - integer
                  - 'null'
              eps_avg:
                description: Consensus EPS.
                type:
                  - number
                  - 'null'
              eps_high:
                description: Highest EPS estimate.
                type:
                  - number
                  - 'null'
              eps_low:
                description: Lowest EPS estimate.
                type:
                  - number
                  - 'null'
              horizon:
                description: >-
                  Horizon label as the vendor names it (current quarter, next
                  fiscal year, 0q, +1y …).
                type:
                  - string
                  - 'null'
              period_end:
                description: Fiscal period end the estimate is for, YYYY-MM-DD.
                format: date
                type:
                  - string
                  - 'null'
              revenue_analysts:
                description: Analysts in the revenue consensus.
                type:
                  - integer
                  - 'null'
              revenue_avg:
                description: Consensus revenue in the reporting currency.
                type:
                  - number
                  - 'null'
              revenue_high:
                description: Highest revenue estimate.
                type:
                  - number
                  - 'null'
              revenue_low:
                description: Lowest revenue estimate.
                type:
                  - number
                  - 'null'
            required:
              - horizon
              - period_end
              - eps_avg
              - eps_low
              - eps_high
              - eps_analysts
              - revenue_avg
              - revenue_low
              - revenue_high
              - revenue_analysts
            type: object
          type:
            - array
            - 'null'
        recommendation:
          description: Latest analyst recommendation counts.
          properties:
            buy:
              description: Analysts rating buy.
              type:
                - integer
                - 'null'
            hold:
              description: Analysts rating hold.
              type:
                - integer
                - 'null'
            period:
              description: Month the counts refer to, YYYY-MM-DD.
              format: date
              type:
                - string
                - 'null'
            sell:
              description: Analysts rating sell.
              type:
                - integer
                - 'null'
            strong_buy:
              description: Analysts rating strong buy.
              type:
                - integer
                - 'null'
            strong_sell:
              description: Analysts rating strong sell.
              type:
                - integer
                - 'null'
          required:
            - strong_buy
            - buy
            - hold
            - sell
            - strong_sell
            - period
          type: object
        symbol:
          description: Ticker as requested.
          type: string
      required:
        - symbol
        - recommendation
        - periods
      type: object
    ErrorEnvelope:
      properties:
        attempts:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
        code:
          type: integer
        error:
          description: Human-readable message.
          type: string
        error_type:
          description: >-
            validation | not_found | rate_limit | timeout | insufficient_credits
            | upstream_unauthorized | upstream_unavailable | provider_error
          type: string
        op:
          description: Method name.
          type: string
        request_id:
          description: Correlation id.
          type: string
      required:
        - error
        - code
        - error_type
      type: object
    Attempt:
      description: >-
        One upstream try. Present on success and failure so a failover is never
        invisible.
      properties:
        error_type:
          description: >-
            validation | not_found | rate_limit | timeout |
            upstream_unauthorized | upstream_unavailable | provider_error
          type: string
        provider:
          description: Provider slug.
          type: string
        refunded:
          description: true when the reservation for this attempt was refunded.
          type: boolean
        status:
          description: HTTP status AgentKey mapped this attempt to (200 on success).
          type: integer
        took_ms:
          type: integer
        tool:
          description: Registry tool name (Provider/operation) that was called.
          type: string
        upstream_status:
          description: The provider's real HTTP status; absent when nothing was received.
          type: integer
      required:
        - provider
        - tool
        - status
        - took_ms
      type: object
  responses:
    ValidationError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Validation error (unknown field, bad cursor, bad routing)
    InsufficientCredits:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Insufficient credits
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Not found (method, or upstream object)
    RateLimited:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Rate limited upstream
    UpstreamFailed:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: All providers failed
    Timeout:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Timed out
  securitySchemes:
    ApiKeyAuth:
      description: AgentKey API key (ak_…).
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.