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

# Get cash flow statement segments

> Registered for Financial Datasets route parity and wired onto get_segmented_financials (go/service/segmentedfinancials.go), but this server's extraction schema only ever asks a filing for income-statement revenue by product/segment - never capital expenditure by segment. Every call still identifies the filing and makes the paid Context.dev extraction call, but capital_expenditure is always omitted from the response rather than fabricated: only the segment record's identity fields (ticker, report_period, fiscal_period, period, accession_number, filing_url) come back. period only accepts "annual": passing "quarterly" answers 400 bad_request. When no matching filing exists for the ticker, this server answers HTTP 200 with a not_found ErrorResponse body (mirroring the rest of this API's honest-failure convention) rather than a 404 or an empty list.



## OpenAPI

````yaml /api-reference/openapi.json get /financials/cash-flow-statements/segments
openapi: 3.1.0
info:
  title: Monid Finance API
  version: 1.0.0
  summary: A Financial Datasets-compatible finance REST API backed by Monid providers.
  description: >-
    US equities fundamentals, prices, filings, news, insider trades, and a stock
    screener, generated faithfully from this repository's Go source
    (go/httpapi/rest.go, go/service, go/fd). This server is drop-in compatible
    with the Financial Datasets REST and MCP interface: the same route shapes,
    the same query parameters, and response objects whose field names and field
    order match the Financial Datasets contract, captured 2026-09-04. It is an
    independent, Monid-backed implementation; it is not affiliated with or
    endorsed by Financial Datasets, and no Financial Datasets data or outputs
    are used.


    **Bring your own Monid API key.** Every request carries the caller's own key
    in the `X-API-KEY` header. Usage bills that caller's own Monid wallet; this
    server never stores or logs the key. Get a key at https://monid.ai.


    **Coverage.** All 54 Financial Datasets REST paths are registered. all 54
    return data; most call live Monid providers, and a handful (the static
    catalogs and the accept-universe coverage lists; see each operation's
    description) never call Monid at all. Every registered path answers from a
    live source; there are no not_implemented stubs. /kpi/metrics/sectors
    returns the screener provider's own industry taxonomy and
    /index-funds/tickers the upstream fund universe, both scraped through Monid
    on demand. See docs/compatibility.md for every deliberate deviation and
    docs/openapi-notes.md for how this document was derived.


    **Errors and soft failures.** Every failure — real HTTP error and zero-cost
    soft failure alike — uses the two-key body `{"error": <code>, "message":
    <detail>}`. Some routes answer `not_found` with HTTP 200 rather than a 4xx
    status (see each operation's description).


    **Pagination.** List routes return a wrapped envelope (e.g.
    `{"income_statements": [...], "next_page_url": "..."}`) with opaque,
    server-minted base64url `cursor` tokens. Pages hold 10 records (100 for
    /prices). `next_page_url` is an absolute URL on this deployment's own host,
    present only when more records remain.


    **Ticker coverage lists are accept-universes, not data-coverage claims.**
    The eight `*/tickers` routes (e.g. /company/facts/tickers,
    /kpi/metrics/tickers) all answer from the same ~3,227-ticker US equity
    catalog: the tickers a route will ACCEPT as input, never a promise that
    every one of them has data for that particular dataset - this server has not
    measured per-dataset coverage. Their own `limit` (default 1000, max 5000)
    and `cursor` query parameters page through that shared universe
    independently of every other route's pagination convention above.
  contact:
    url: https://docs.financialdatasets.rip
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://financialdatasets.rip
    description: Production (Fly.io).
security:
  - ApiKeyAuth: []
tags:
  - name: Financial statements
    description: Income statements, balance sheets, cash flow statements.
  - name: Financial metrics
    description: Historical financial metrics and the live snapshot.
  - name: Earnings
    description: Earnings records composed from SEC filing events.
  - name: Filings
    description: SEC filing index and extracted filing sections.
  - name: Prices
    description: Historical OHLCV prices and the live price snapshot.
  - name: News
    description: Ticker-matched news.
  - name: Insider trades
    description: SEC Form 4 insider trading transactions.
  - name: Screener
    description: Stock screener and its executable filter catalog.
  - name: Company
    description: Company facts.
  - name: KPIs
    description: >-
      KPI-taxonomy metrics, forward guidance, and non-GAAP metrics extracted
      from SEC filings.
  - name: Macroeconomics
    description: Central bank policy interest rates.
  - name: Index funds
    description: ETF / index-fund holdings.
  - name: Institutional holdings
    description: SEC Form 13F institutional-holdings rows.
  - name: Ownership
    description: Insider, beneficial (13D/13G) and activist ownership state.
  - name: Not implemented
    description: >-
      Routes registered for Financial Datasets route parity; always a zero-cost
      not_implemented stub today.
paths:
  /financials/cash-flow-statements/segments:
    get:
      tags:
        - Financial statements
      summary: Get cash flow statement segments
      description: >-
        Registered for Financial Datasets route parity and wired onto
        get_segmented_financials (go/service/segmentedfinancials.go), but this
        server's extraction schema only ever asks a filing for income-statement
        revenue by product/segment - never capital expenditure by segment. Every
        call still identifies the filing and makes the paid Context.dev
        extraction call, but capital_expenditure is always omitted from the
        response rather than fabricated: only the segment record's identity
        fields (ticker, report_period, fiscal_period, period, accession_number,
        filing_url) come back. period only accepts "annual": passing "quarterly"
        answers 400 bad_request. When no matching filing exists for the ticker,
        this server answers HTTP 200 with a not_found ErrorResponse body
        (mirroring the rest of this API's honest-failure convention) rather than
        a 404 or an empty list.
      operationId: get_cash_flow_statement_segments
      parameters:
        - name: ticker
          in: query
          required: true
          schema:
            type: string
          description: >-
            Uppercase-normalized ticker symbol (1-20
            letters/digits/dots/hyphens).
        - name: period
          in: query
          required: false
          schema:
            type: string
            enum:
              - annual
              - quarterly
            default: annual
          description: >-
            Reporting cadence. Only "annual" (the default) is supported:
            "quarterly" answers 400 bad_request, since this server extracts
            segment data from the annual 10-K only.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 4
          description: 'Number of records to retrieve (default: 4, max: 100).'
        - name: report_period
          in: query
          required: false
          schema:
            type: string
            format: date
          description: Exact report_period date filter (YYYY-MM-DD).
        - name: report_period_gte
          in: query
          required: false
          schema:
            type: string
            format: date
          description: report_period >= this date (YYYY-MM-DD, inclusive).
        - name: report_period_lte
          in: query
          required: false
          schema:
            type: string
            format: date
          description: report_period <= this date (YYYY-MM-DD, inclusive).
        - name: report_period_gt
          in: query
          required: false
          schema:
            type: string
            format: date
          description: report_period > this date (YYYY-MM-DD, exclusive).
        - name: report_period_lt
          in: query
          required: false
          schema:
            type: string
            format: date
          description: report_period < this date (YYYY-MM-DD, exclusive).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Opaque base64url pagination cursor from a previous response's
            next_page_url. Omit for the first page.
      responses:
        '200':
          description: >-
            This route never has statement-specific data to return today (see
            description); the example shows the identity-only shape every call
            currently gets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashFlowStatementSegmentsResponse'
              examples:
                example:
                  value:
                    cash_flow_statement_segments:
                      - ticker: AAPL
                        report_period: '2025-09-27'
                        fiscal_period: FY2025
                        period: annual
                        accession_number: 0000320193-25-000012
                        filing_url: >-
                          https://www.sec.gov/Archives/edgar/data/320193/000032019325000012/aapl-20250927.htm
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '502':
          $ref: '#/components/responses/BadGateway'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
components:
  schemas:
    CashFlowStatementSegmentsResponse:
      type: object
      title: CashFlowStatementSegmentsResponse
      description: >-
        Wrapped list envelope: {"segmented_financials": [...], "next_page_url":
        "..."}. Page size is 10 records. May instead be a two-key ErrorResponse
        when no 10-K filing exists for the ticker.
      properties:
        cash_flow_statement_segments:
          type: array
          items:
            $ref: '#/components/schemas/CashFlowStatementSegmentsRecord'
        next_page_url:
          type: string
          format: uri
      required:
        - cash_flow_statement_segments
    CashFlowStatementSegmentsRecord:
      type: object
      title: CashFlowStatementSegmentsRecord
      description: >-
        One record for /financials/cash-flow-statements/segments: segment
        identity metadata only. capital_expenditure is declared for Financial
        Datasets schema parity but always omitted - this server's extraction
        schema only ever asks a filing for income-statement revenue by segment,
        never cash-flow figures.
      properties:
        ticker:
          type: string
          description: Uppercase ticker symbol.
        report_period:
          type: string
          description: Reporting period end date (YYYY-MM-DD).
          format: date
        fiscal_period:
          type: string
          description: >-
            Fiscal-period label (e.g. FY2025). Omitted when the filing's fiscal
            year could not be determined.
        period:
          type: string
          enum:
            - annual
          description: 'Always "annual": this route only extracts from annual 10-Ks.'
        accession_number:
          type: string
          description: >-
            SEC EDGAR accession number of the source 10-K, when it could be
            derived from the filing URL.
        filing_url:
          type: string
          format: uri
          description: SEC EDGAR filing index URL for the source 10-K.
        capital_expenditure:
          $ref: '#/components/schemas/SegmentCategory'
      required:
        - ticker
        - report_period
    ErrorResponse:
      type: object
      title: ErrorResponse
      description: >-
        Uniform error/soft-failure body: {"error": <code>, "message": <detail>}.
        Used both for real HTTP error statuses and for 200 OK
        "not_found"/"not_implemented" soft failures that this API never bills
        for.
      properties:
        error:
          type: string
          description: >-
            Machine-readable error code, e.g. bad_request, unauthorized,
            payment_required, rate_limited, upstream_error,
            upstream_schema_changed, upstream_timeout, unsupported,
            invalid_cursor, not_found, not_implemented.
        message:
          type: string
          description: Human-readable detail.
      required:
        - error
        - message
    SegmentCategory:
      type: object
      title: SegmentCategory
      description: >-
        Segment breakdowns grouped by category. Each key is present only when
        the extraction found at least one row of that kind.
      properties:
        product:
          type: array
          items:
            $ref: '#/components/schemas/SegmentBreakdown'
          description: Breakdowns by product line.
        segment:
          type: array
          items:
            $ref: '#/components/schemas/SegmentBreakdown'
          description: Breakdowns by business or geographic reportable segment.
    SegmentBreakdown:
      type: object
      title: SegmentBreakdown
      description: >-
        One labeled value from a segment breakdown, matching
        go/service/segmentedfinancials.go's segmentRow (label, value).
      properties:
        label:
          type: string
          description: >-
            The product line or business/geographic segment name, exactly as
            extracted from the filing.
        value:
          type: number
          description: The value stated in the filing for this label.
      required:
        - label
        - value
  responses:
    BadRequest:
      description: >-
        400 Bad Request. Validation failed before any paid Monid call was made
        (bad_request), or the request is well-formed but names a capability this
        server deliberately rejects (unsupported), e.g. as_reported=true or a
        non-USD currency.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            bad_request:
              summary: Validation failure
              value:
                error: bad_request
                message: ticker must be 1-20 letters, digits, dots, or hyphens
            unsupported:
              summary: Deliberately rejected capability
              value:
                error: unsupported
                message: >-
                  as_reported is not supported by the Monid-backed server;
                  as_reported=True cannot be answered honestly.
            invalid_cursor:
              summary: Malformed pagination cursor
              value:
                error: invalid_cursor
                message: cursor is not a valid opaque pagination token
    Unauthorized:
      description: >-
        401 Unauthorized. The X-API-KEY header was missing, empty, or contained
        control characters, or (if the operator configured an allowlist) the key
        is not on it. This check runs before any Monid call.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                error: unauthorized
                message: Missing or invalid API key.
    PaymentRequired:
      description: >-
        402 Payment Required. The caller's own Monid wallet could not cover the
        call (Monid returned a blocked/insufficient-funds result).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            payment_required:
              value:
                error: payment_required
                message: 'Monid run blocked: insufficient wallet balance.'
    TooManyRequests:
      description: >-
        429 Too Many Requests. Per-API-key token-bucket rate limit exceeded
        (default 60/min per key; 10/min for keyless demo traffic, where
        enabled).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rate_limited:
              value:
                error: rate_limited
                message: Rate limit exceeded. Retry shortly.
    BadGateway:
      description: >-
        502 Bad Gateway. The upstream Monid provider call failed for a reason
        other than auth/funds/timeout (upstream_error), or its payload no longer
        matches the shape this server parses (upstream_schema_changed).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            upstream_error:
              summary: Generic upstream failure
              value:
                error: upstream_error
                message: provider returned HTTP 500
            upstream_schema_changed:
              summary: Upstream payload shape drifted
              value:
                error: upstream_schema_changed
                message: provider payload is not valid JSON
    GatewayTimeout:
      description: 504 Gateway Timeout. The upstream Monid provider call timed out.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            upstream_timeout:
              value:
                error: upstream_timeout
                message: provider request timed out
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        The caller's own Monid API key (get one at
        https://monid.ai?fpr=dhruv-15136b). Passed straight through to Monid on
        every call, so usage bills the caller's own wallet — this is never a
        shared server-side credential, and the server never logs or stores it.
        Missing, empty, or malformed values answer 401 unauthorized before any
        paid call is attempted.

````