Skip to content
Get started

Get Instrument Cash Flow Statements

InstrumentDataGetInstrumentCashFlowStatementsResponse v1().instrumentData().getInstrumentCashFlowStatements(InstrumentDataGetInstrumentCashFlowStatementsParamsparams = InstrumentDataGetInstrumentCashFlowStatementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/instruments/{instrument_id}/cash-flow-statements

Get cash flow statements for an instrument.

Retrieves historical cash flow statements for the specified instrument. Cash flow statements show cash inflows and outflows from operating, investing, and financing activities.

ParametersExpand Collapse
InstrumentDataGetInstrumentCashFlowStatementsParams params
Optional<String> instrumentId

OEMS instrument UUID

formatuuid
Optional<String> fromDate

The start date for the query range, inclusive (YYYY-MM-DD).

Optional<Long> pageSize

The number of items to return per page. Only used when page_token is not provided.

formatint64
maximum1000
minimum1
Optional<String> pageToken

Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.

formatbyte
Optional<String> toDate

The end date for the query range, inclusive (YYYY-MM-DD).

ReturnsExpand Collapse
class InstrumentDataGetInstrumentCashFlowStatementsResponse:
LocalDateTime acceptedDate

The date and time when the filing was accepted by the SEC

formatdate-time
LocalDate filingDate

The date the financial statement was filed

formatdate
String period

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

FiscalPeriodType periodType

The type of fiscal period

One of the following:
QUARTERLY("QUARTERLY")
ANNUAL("ANNUAL")
TTM("TTM")
BIANNUAL("BIANNUAL")
String reportedCurrency

The currency in which the statement is reported (ISO 4217)

long year

The fiscal year of the statement

formatint32
Optional<String> accountsPayables

Change in accounts payables

Optional<String> accountsReceivables

Change in accounts receivables

Optional<String> acquisitionsNet

Net acquisitions

Optional<String> capitalExpenditure

Capital expenditure

Optional<String> cashAtBeginningOfPeriod

Cash and cash equivalents at beginning of period

Optional<String> cashAtEndOfPeriod

Cash and cash equivalents at end of period

Optional<String> changeInWorkingCapital

Change in working capital

Optional<String> commonDividendsPaid

Common dividends paid

Optional<String> commonStockIssuance

Common stock issuance

Optional<String> commonStockRepurchased

Common stock repurchased (buybacks)

Optional<String> deferredIncomeTax

Deferred income tax expense

Optional<String> depreciationAndAmortization

Depreciation and amortization expense

Optional<String> effectOfForexChangesOnCash

Effect of foreign exchange changes on cash

Optional<String> freeCashFlow

Free cash flow (operating cash flow minus capital expenditure)

Optional<String> incomeTaxesPaid

Income taxes paid

Optional<String> interestPaid

Interest paid

Optional<String> inventory

Change in inventory

Optional<String> investmentsInPropertyPlantAndEquipment

Investments in property, plant, and equipment

Optional<String> longTermNetDebtIssuance

Long-term net debt issuance

Optional<String> netCashProvidedByFinancingActivities

Net cash provided by financing activities

Optional<String> netCashProvidedByInvestingActivities

Net cash provided by investing activities

Optional<String> netCashProvidedByOperatingActivities

Net cash provided by operating activities

Optional<String> netChangeInCash

Net change in cash during the period

Optional<String> netCommonStockIssuance

Net common stock issuance

Optional<String> netDebtIssuance

Net debt issuance (long-term + short-term)

Optional<String> netDividendsPaid

Net dividends paid (common + preferred)

Optional<String> netIncome

Net income for the period

Optional<String> netPreferredStockIssuance

Net preferred stock issuance

Optional<String> netStockIssuance

Net stock issuance (common + preferred)

Optional<String> operatingCashFlow

Operating cash flow (alternative calculation)

Optional<String> otherFinancingActivities

Other financing activities

Optional<String> otherInvestingActivities

Other investing activities

Optional<String> otherNonCashItems

Other non-cash items

Optional<String> otherWorkingCapital

Change in other working capital

Optional<String> preferredDividendsPaid

Preferred dividends paid

Optional<String> purchasesOfInvestments

Purchases of investments

Optional<String> salesMaturitiesOfInvestments

Sales and maturities of investments

Optional<String> shortTermNetDebtIssuance

Short-term net debt issuance

Optional<String> stockBasedCompensation

Stock-based compensation expense

Get Instrument Cash Flow Statements

package com.clear_street.api.example;

import com.clear_street.api.client.ClearStreetClient;
import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient;
import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentCashFlowStatementsParams;
import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentCashFlowStatementsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        InstrumentDataGetInstrumentCashFlowStatementsResponse response = client.v1().instrumentData().getInstrumentCashFlowStatements("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}
{
  "data": [
    {
      "accepted_date": "2025-05-02T14:30:00Z",
      "capital_expenditure": "-2600000000",
      "cash_at_beginning_of_period": "33743000000",
      "cash_at_end_of_period": "29943000000",
      "change_in_working_capital": "-3200000000",
      "common_stock_repurchased": "-23000000000",
      "depreciation_and_amortization": "2900000000",
      "filing_date": "2025-05-01",
      "free_cash_flow": "25800000000",
      "investments_in_property_plant_and_equipment": "-2600000000",
      "net_cash_provided_by_financing_activities": "-28300000000",
      "net_cash_provided_by_investing_activities": "-3900000000",
      "net_cash_provided_by_operating_activities": "28400000000",
      "net_change_in_cash": "-3800000000",
      "net_debt_issuance": "-1500000000",
      "net_dividends_paid": "-3800000000",
      "net_income": "22200000000",
      "operating_cash_flow": "28400000000",
      "period": "Q1",
      "period_type": "QUARTERLY",
      "purchases_of_investments": "-9500000000",
      "reported_currency": "USD",
      "sales_maturities_of_investments": "8200000000",
      "stock_based_compensation": "2500000000",
      "year": 2025
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": "AAAAAAAAAGQAAAAAAAAAZQ==",
    "page_number": 1,
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "total_items": 20,
    "total_pages": 2
  }
}
{
  "error": {
    "code": 404,
    "message": "Instrument not found: AAP"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}
Returns Examples
{
  "data": [
    {
      "accepted_date": "2025-05-02T14:30:00Z",
      "capital_expenditure": "-2600000000",
      "cash_at_beginning_of_period": "33743000000",
      "cash_at_end_of_period": "29943000000",
      "change_in_working_capital": "-3200000000",
      "common_stock_repurchased": "-23000000000",
      "depreciation_and_amortization": "2900000000",
      "filing_date": "2025-05-01",
      "free_cash_flow": "25800000000",
      "investments_in_property_plant_and_equipment": "-2600000000",
      "net_cash_provided_by_financing_activities": "-28300000000",
      "net_cash_provided_by_investing_activities": "-3900000000",
      "net_cash_provided_by_operating_activities": "28400000000",
      "net_change_in_cash": "-3800000000",
      "net_debt_issuance": "-1500000000",
      "net_dividends_paid": "-3800000000",
      "net_income": "22200000000",
      "operating_cash_flow": "28400000000",
      "period": "Q1",
      "period_type": "QUARTERLY",
      "purchases_of_investments": "-9500000000",
      "reported_currency": "USD",
      "sales_maturities_of_investments": "8200000000",
      "stock_based_compensation": "2500000000",
      "year": 2025
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": "AAAAAAAAAGQAAAAAAAAAZQ==",
    "page_number": 1,
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "total_items": 20,
    "total_pages": 2
  }
}
{
  "error": {
    "code": 404,
    "message": "Instrument not found: AAP"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}