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

# Read Company Metric Estimates

> One metric across every period, with each contributor and the actual beside it.

Requires paid access.



## OpenAPI

````yaml /openapi.json get /v1/companies/{company_id}/estimates/{metric_key}
openapi: 3.1.0
info:
  title: Rangler API
  version: 1.0.0
  description: >-
    Customer-facing Rangler API for companies, standardized financials, filings,
    funds, market data, events, and webhooks.
servers:
  - url: https://api.rangler.co
    description: Live
  - url: https://sandbox-api.rangler.co
    description: Sandbox
security: []
tags:
  - name: Analyst estimates
    description: Consensus forecasts, revisions, contributor accuracy, and source evidence.
  - name: Analyst recommendations
    description: Analyst ratings, target-price views, and company recommendation history.
  - name: Calendar
    description: Company events and calendar exports.
  - name: Companies
    description: >-
      Company lookup, issuer details, dividends, daily trades, meeting media,
      and mentions.
  - name: Events
    description: >-
      Read earlier events and check for missed deliveries across the market, a
      company, or a fund.
  - name: Financials
    description: >-
      Standardized financial statements, reported tables, ratios, and links to
      filing sources.
  - name: Filings
    description: Filings, board changes, insider dealings, and extracted filing mentions.
  - name: Funds
    description: Fund directories, disclosures, snapshots, holdings, and performance data.
  - name: Markets
    description: Market directories and regular-session clock data.
  - name: News
    description: Company news developments and company-filtered news search.
paths:
  /v1/companies/{company_id}/estimates/{metric_key}:
    get:
      tags:
        - Analyst estimates
      summary: Read Company Metric Estimates
      description: >-
        One metric across every period, with each contributor and the actual
        beside it.


        Requires paid access.
      operationId: get_v1_companies_company_id_estimates_metric_key
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Company Id
        - name: metric_key
          in: path
          required: true
          schema:
            type: string
            title: Metric Key
        - name: display_currency
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Display Currency
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricEstimatesRead'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: unauthorized
                      code: unauthorized
                      message: Authentication required.
                      request_id: 28fa6152-7081-492e-8a7e-00beb237b689
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: forbidden
                      code: forbidden
                      message: Paid access is required.
                      request_id: 5c253b3e-778e-4a58-aaf8-07cb21e03563
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: not_found
                      code: not_found
                      message: Company not found
                      request_id: 9f5237bc-7d8c-4a9d-9c1f-fbd4ef236cf9
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: validation_error
                      code: validation_error
                      message: Request validation failed
                      request_id: c5964dca-d290-4465-a3dc-f92d42aa9b17
                      details:
                        - type: missing
                          loc:
                            - query
                            - ticker
                          msg: Field required
                          input: null
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: rate_limit_exceeded
                      code: rate_limit_exceeded
                      message: Rate limit exceeded
                      request_id: cc4d369a-2c69-4ee2-909e-985ea35d14a9
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              examples:
                default:
                  value:
                    error:
                      type: internal_server_error
                      code: internal_server_error
                      message: Internal Server Error
                      request_id: 70b63aba-b8a3-41c2-bb0c-fbe67d84d37d
      security:
        - RanglerApiKey: []
components:
  schemas:
    MetricEstimatesRead:
      properties:
        metric_key:
          type: string
          title: Metric Key
        display_name:
          type: string
          title: Display Name
        unit_class:
          anyOf:
            - type: string
            - type: 'null'
          title: Unit Class
        available_display_currencies:
          items:
            type: string
          type: array
          title: Available Display Currencies
          default: []
        display_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Currency
        reported_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Reported Currency
        favourable_direction:
          type: string
          title: Favourable Direction
          default: neutral
        periods:
          items:
            $ref: '#/components/schemas/PeriodEstimatesRead'
          type: array
          title: Periods
          default: []
      type: object
      required:
        - metric_key
        - display_name
      title: MetricEstimatesRead
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
    PeriodEstimatesRead:
      properties:
        fiscal_year:
          type: integer
          title: Fiscal Year
        period_end_date:
          type: string
          format: date
          title: Period End Date
        actual:
          anyOf:
            - type: number
            - type: 'null'
          title: Actual
        actual_source:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Actual Source
        actual_published_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Actual Published At
        surprise_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Surprise Pct
        variance_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Variance Pct
        outcome_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Outcome Status
        favourable_direction:
          type: string
          title: Favourable Direction
          default: neutral
        external_research:
          $ref: '#/components/schemas/EstimateAggregateRead'
        contributed:
          $ref: '#/components/schemas/EstimateAggregateRead'
        guidance:
          $ref: '#/components/schemas/EstimateAggregateRead'
      type: object
      required:
        - fiscal_year
        - period_end_date
        - external_research
        - contributed
        - guidance
      title: PeriodEstimatesRead
    ErrorObject:
      type: object
      required:
        - type
        - code
        - message
        - request_id
      properties:
        type:
          type: string
        code:
          type: string
        message:
          type: string
        request_id:
          type: string
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: array
              items:
                additionalProperties: true
                type: object
            - type: 'null'
    EstimateAggregateRead:
      properties:
        contributor_count:
          type: integer
          title: Contributor Count
        mean:
          anyOf:
            - type: number
            - type: 'null'
          title: Mean
        median:
          anyOf:
            - type: number
            - type: 'null'
          title: Median
        high:
          anyOf:
            - type: number
            - type: 'null'
          title: High
        low:
          anyOf:
            - type: number
            - type: 'null'
          title: Low
        standard_deviation:
          anyOf:
            - type: number
            - type: 'null'
          title: Standard Deviation
        estimates:
          items:
            $ref: '#/components/schemas/ContributorEstimateRead'
          type: array
          title: Estimates
          default: []
      type: object
      required:
        - contributor_count
      title: EstimateAggregateRead
    ContributorEstimateRead:
      properties:
        estimate_id:
          type: string
          format: uuid
          title: Estimate Id
        contributor_key:
          type: string
          title: Contributor Key
        contributor_display_name:
          type: string
          title: Contributor Display Name
        contributor_kind:
          type: string
          title: Contributor Kind
        value:
          type: number
          title: Value
        reported_value:
          type: number
          title: Reported Value
        reported_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Reported Currency
        as_of_date:
          type: string
          format: date
          title: As Of Date
        as_of_at:
          type: string
          format: date-time
          title: As Of At
        unit:
          type: string
          title: Unit
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        research_report_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Research Report Id
        source_page_number:
          anyOf:
            - type: integer
            - type: 'null'
          title: Source Page Number
        source_excerpt:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Excerpt
        contributor_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Contributor Note
        withdrawn_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Withdrawn At
        value_scale:
          anyOf:
            - type: string
            - type: 'null'
          title: Value Scale
        included_in_consensus:
          type: boolean
          title: Included In Consensus
          default: true
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
      type: object
      required:
        - estimate_id
        - contributor_key
        - contributor_display_name
        - contributor_kind
        - value
        - reported_value
        - as_of_date
        - as_of_at
        - unit
      title: ContributorEstimateRead
  securitySchemes:
    RanglerApiKey:
      type: apiKey
      in: header
      name: X-API-Key

````

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