> ## 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.

# Get company revenue segments

> Return reported revenue segments without unrelated financial fields.

Requires paid access.



## OpenAPI

````yaml /openapi.json get /v1/company/financials/revenue-segments
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/company/financials/revenue-segments:
    get:
      tags:
        - Financials
      summary: Get company revenue segments
      description: |-
        Return reported revenue segments without unrelated financial fields.

        Requires paid access.
      operationId: get_v1_company_financials_revenue-segments
      parameters:
        - name: periodType
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: >-
              Period filter. Repeat or use a comma-separated list: annual,
              quarterly, semi-annual, ytd, latest. Defaults to annual.
            title: Periodtype
          description: >-
            Period filter. Repeat or use a comma-separated list: annual,
            quarterly, semi-annual, ytd, latest. Defaults to annual.
        - name: periodLimit
          in: query
          required: false
          schema:
            type: integer
            maximum: 40
            minimum: 1
            description: Maximum revenue-segment periods returned.
            default: 12
            title: Periodlimit
          description: Maximum revenue-segment periods returned.
        - name: company
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 64
            description: >-
              Rangler company UUID or exchange ticker, matched
              case-insensitively.
            title: Company
          description: Rangler company UUID or exchange ticker, matched case-insensitively.
        - name: countryCode
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                minLength: 2
                maxLength: 2
              - type: 'null'
            description: >-
              ISO 3166-1 alpha-2 market code. Use it when a ticker is shared
              across markets.
            title: Countrycode
          description: >-
            ISO 3166-1 alpha-2 market code. Use it when a ticker is shared
            across markets.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevenueSegmentsResponse'
        '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
        '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:
    RevenueSegmentsResponse:
      properties:
        company_id:
          type: string
          format: uuid
          title: Company Id
        periods:
          items:
            $ref: '#/components/schemas/RevenueSegmentPeriodRead'
          type: array
          title: Periods
      type: object
      required:
        - company_id
      title: RevenueSegmentsResponse
      description: Reported revenue segments for one company.
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
    RevenueSegmentPeriodRead:
      properties:
        period_end_date:
          type: string
          format: date
          title: Period End Date
        period_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Period Type
        reporting_period:
          anyOf:
            - type: string
            - type: 'null'
          title: Reporting Period
        period_family:
          anyOf:
            - type: string
              enum:
                - annual
                - interim
                - trailing
            - type: 'null'
          title: Period Family
        period_granularity:
          anyOf:
            - type: string
              enum:
                - full_year
                - quarter
                - half_year
                - year_to_date
                - trailing_twelve_months
            - type: 'null'
          title: Period Granularity
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        segments:
          items:
            $ref: >-
              #/components/schemas/app__schemas__statement_financials__RevenueSegmentRead
          type: array
          title: Segments
      type: object
      required:
        - period_end_date
      title: RevenueSegmentPeriodRead
      description: Revenue segments associated with one reported company period.
    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'
    app__schemas__statement_financials__RevenueSegmentRead:
      properties:
        segment:
          type: string
          title: Segment
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
        products:
          anyOf:
            - type: string
            - type: 'null'
          title: Products
        revenue_value:
          anyOf:
            - type: number
            - type: 'null'
          title: Revenue Value
        revenue_usd_value:
          anyOf:
            - type: number
            - type: 'null'
          title: Revenue Usd Value
        revenue_contribution_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Revenue Contribution Pct
      type: object
      required:
        - segment
      title: RevenueSegmentRead
      description: One reported revenue segment without provider or ingestion details.
  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.