PitchBook: Get Fund Cash Flows

Get a fund’s contributions, distributions and net asset value over time by its ID.

Tool ID: pitchbook_get_fund_cash_flows

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_get_fund_cash_flows',
  {
    "pbId": "pb_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pitchbook_get_fund_cash_flows --input '{
  "pbId": "pb_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "fundId": "fund_123",
    "fundName": "Example",
    "fundStructure": "example"
  }
}

Use deepline describe pitchbook_get_fund_cash_flows --json for the latest machine-readable contract.

Input reference

Retrieves fund cash flow data for the specified fund across all supported reporting periods. Quarterly data is returned by default.

Name	Type	Required	Default	Details
`payload.pbId`	`string`	Yes	—	Fund pbId
`payload.periodType`	`"MTH" \| "QTR" \| "ANN"`	No	`"QTR"`	Type of the period in which data will be presented. The list of types could be found here Allowed: `MTH`, `QTR`, `ANN`.
`payload.sinceDate`	`string`	No	—	Searches for data by fiscal period date using the > operator for dates after a specified date, the < operator for dates before a specified date, and the ^ operator for dates between two dates. Format: YYYY-MM-DD

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.fundId`	`string`	No	—	—
`result.data.fundName`	`string`	No	—	—
`result.data.fundStructure`	`string`	No	—	—
`result.data.items`	`array`	No	—	—
`result.data.items[].period`	`string`	No	—	—
`result.data.items[].endDate`	`string`	No	—	Format: `date`.
`result.data.items[].capitalActivity`	`object`	No	—	—
`result.data.items[].capitalActivity.remainingValue`	`number \| null`	No	—	Format: `double`.
`result.data.items[].capitalActivity.contributed`	`number`	No	—	Format: `double`.
`result.data.items[].capitalActivity.percentCalledDown`	`number`	No	—	Format: `double`.
`result.data.items[].capitalActivity.dryPowder`	`number`	No	—	Format: `double`.
`result.data.items[].capitalActivity.percentDryPowder`	`number`	No	—	Format: `double`.
`result.data.items[].capitalActivity.distributed`	`number`	No	—	Format: `double`.
`result.data.items[].capitalActivity.distributedRemaining`	`number \| null`	No	—	Format: `double`.
`result.data.items[].investorActivity`	`object`	No	—	—
`result.data.items[].investorActivity.sales`	`number`	No	—	Format: `double`.
`result.data.items[].investorActivity.redemptions`	`number`	No	—	Format: `double`.
`result.data.items[].investorActivity.reinvestedDividends`	`number`	No	—	Format: `double`.
`result.data.items[].investorActivity.netCashFlow`	`number`	No	—	Format: `double`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation