Skip to content
Get started

Get Instrument Cash Flow Statements

client.V1.InstrumentData.GetInstrumentCashFlowStatements(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentCashFlowStatementsResponse, error)
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

OEMS instrument UUID

formatuuid
query V1InstrumentDataGetInstrumentCashFlowStatementsParams
FromDate param.Field[string]Optional

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

PageSize param.Field[int64]Optional

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

formatint64
maximum1000
minimum1
PageToken param.Field[string]Optional

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

formatbyte
ToDate param.Field[string]Optional

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

ReturnsExpand Collapse
type V1InstrumentDataGetInstrumentCashFlowStatementsResponse struct{…}
AcceptedDate Time

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

formatdate-time
FilingDate Time

The date the financial statement was filed

formatdate
Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:
const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"
const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"
const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"
const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"
ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32
AccountsPayables stringOptional

Change in accounts payables

AccountsReceivables stringOptional

Change in accounts receivables

AcquisitionsNet stringOptional

Net acquisitions

CapitalExpenditure stringOptional

Capital expenditure

CashAtBeginningOfPeriod stringOptional

Cash and cash equivalents at beginning of period

CashAtEndOfPeriod stringOptional

Cash and cash equivalents at end of period

ChangeInWorkingCapital stringOptional

Change in working capital

CommonDividendsPaid stringOptional

Common dividends paid

CommonStockIssuance stringOptional

Common stock issuance

CommonStockRepurchased stringOptional

Common stock repurchased (buybacks)

DeferredIncomeTax stringOptional

Deferred income tax expense

DepreciationAndAmortization stringOptional

Depreciation and amortization expense

EffectOfForexChangesOnCash stringOptional

Effect of foreign exchange changes on cash

FreeCashFlow stringOptional

Free cash flow (operating cash flow minus capital expenditure)

IncomeTaxesPaid stringOptional

Income taxes paid

InterestPaid stringOptional

Interest paid

Inventory stringOptional

Change in inventory

InvestmentsInPropertyPlantAndEquipment stringOptional

Investments in property, plant, and equipment

LongTermNetDebtIssuance stringOptional

Long-term net debt issuance

NetCashProvidedByFinancingActivities stringOptional

Net cash provided by financing activities

NetCashProvidedByInvestingActivities stringOptional

Net cash provided by investing activities

NetCashProvidedByOperatingActivities stringOptional

Net cash provided by operating activities

NetChangeInCash stringOptional

Net change in cash during the period

NetCommonStockIssuance stringOptional

Net common stock issuance

NetDebtIssuance stringOptional

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

NetDividendsPaid stringOptional

Net dividends paid (common + preferred)

NetIncome stringOptional

Net income for the period

NetPreferredStockIssuance stringOptional

Net preferred stock issuance

NetStockIssuance stringOptional

Net stock issuance (common + preferred)

OperatingCashFlow stringOptional

Operating cash flow (alternative calculation)

OtherFinancingActivities stringOptional

Other financing activities

OtherInvestingActivities stringOptional

Other investing activities

OtherNonCashItems stringOptional

Other non-cash items

OtherWorkingCapital stringOptional

Change in other working capital

PreferredDividendsPaid stringOptional

Preferred dividends paid

PurchasesOfInvestments stringOptional

Purchases of investments

SalesMaturitiesOfInvestments stringOptional

Sales and maturities of investments

ShortTermNetDebtIssuance stringOptional

Short-term net debt issuance

StockBasedCompensation stringOptional

Stock-based compensation expense

Get Instrument Cash Flow Statements

package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.InstrumentData.GetInstrumentCashFlowStatements(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    clearstreet.V1InstrumentDataGetInstrumentCashFlowStatementsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}
{
  "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"
  }
}