PitchBook: Get Portfolio Holdings

List a fund’s portfolio holdings by its ID, filterable by period, industry and instrument type.

Tool ID: pitchbook_get_portfolio_holdings

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_portfolio_holdings',
  {
    "pbId": "pb_123",
    "period": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pitchbook_get_portfolio_holdings --input '{
  "pbId": "pb_123",
  "period": "example"
}' --json

Example response

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

{
  "data": {
    "fund": {
      "id": "id_123",
      "name": "Example"
    },
    "period": "example",
    "items": [
      {
        "syndicated": false,
        "accrualStatus": "example",
        "instrumentType": "example"
      }
    ]
  }
}

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

Input reference

Retrieves key portfolio holding information for the specified fund

Name	Type	Required	Default	Details
`payload.pbId`	`string`	Yes	—	Fund pbId
`payload.period`	`string`	Yes	—	Time period of reported fund holdings data
`payload.industryCode`	`string`	No	—	Find holdings based on industry via industry code . Use a comma to separate multiple values.
`payload.instrumentType`	`string`	No	—	Find holdings by their instrument type (aka investment type). Use a comma to separate multiple values.
`payload.syndicated`	`string`	No	—	Find holdings who have had a deal with syndicated loans within them. To use this parameter set it as True or False

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.fund`	`object \| null`	No	—	—
`result.data.fund.id`	`string`	No	—	—
`result.data.fund.name`	`string`	No	—	—
`result.data.period`	`string`	No	—	—
`result.data.items`	`array`	No	—	—
`result.data.items[].syndicated`	`boolean \| null`	No	—	—
`result.data.items[].accrualStatus`	`string`	No	—	—
`result.data.items[].instrumentType`	`string`	No	—	—
`result.data.items[].clo`	`boolean \| null`	No	—	—
`result.data.items[].industry`	`object`	No	—	—
`result.data.items[].industry.reportedIndustry`	`string`	No	—	—
`result.data.items[].industry.industrySector`	`string`	No	—	—
`result.data.items[].industry.industryGroup`	`string`	No	—	—
`result.data.items[].industry.industryCode`	`string`	No	—	—
`result.data.items[].issuer`	`object`	No	—	—
`result.data.items[].issuer.issuerId`	`string`	No	—	—
`result.data.items[].issuer.issuerName`	`string`	No	—	—
`result.data.items[].issuer.issuerType`	`"COMPANY" \| "FUND"`	No	—	Allowed: `COMPANY`, `FUND`.
`result.data.items[].cost`	`object \| null`	No	—	—
`result.data.items[].cost.amount`	`number`	No	—	—
`result.data.items[].cost.currency`	`string`	No	—	—
`result.data.items[].cost.nativeAmount`	`number`	No	—	—
`result.data.items[].cost.nativeCurrency`	`string`	No	—	—
`result.data.items[].cost.estimated`	`boolean`	No	—	—
`result.data.items[].principal`	`object \| null`	No	—	—
`result.data.items[].principal.amount`	`number`	No	—	—
`result.data.items[].principal.currency`	`string`	No	—	—
`result.data.items[].principal.nativeAmount`	`number`	No	—	—
`result.data.items[].principal.nativeCurrency`	`string`	No	—	—
`result.data.items[].principal.estimated`	`boolean`	No	—	—
`result.data.items[].fairValue`	`object \| null`	No	—	—
`result.data.items[].fairValue.amount`	`number`	No	—	—
`result.data.items[].fairValue.currency`	`string`	No	—	—
`result.data.items[].fairValue.nativeAmount`	`number`	No	—	—
`result.data.items[].fairValue.nativeCurrency`	`string`	No	—	—
`result.data.items[].fairValue.estimated`	`boolean`	No	—	—
`result.data.items[].floor`	`number \| null`	No	—	Format: `double`.
`result.data.items[].maturityDate`	`string \| null`	No	—	Format: `date`.
`result.data.items[].spreadInterestRate`	`number \| null`	No	—	Format: `double`.
`result.data.items[].pikInterest`	`number \| null`	No	—	Format: `double`.
`result.data.items[].numberOfShares`	`number \| null`	No	—	Format: `double`.
`result.data.items[].baseRefRate`	`string \| null`	No	—	—
`result.data.items[].allInRate`	`number \| null`	No	—	Format: `double`.
`result.data.items[].cashPercent`	`number \| null`	No	—	Format: `double`.
`result.data.items[].fairValueOverCost`	`number \| null`	No	—	Format: `double`.
`result.data.items[].fairValueOverPrincipal`	`number \| null`	No	—	Format: `double`.
`result.data.items[].acquisitionDate`	`string \| null`	No	—	Format: `date`.
`result.data.items[].firstPeriodReported`	`string \| null`	No	—	—
`result.data.items[].finalPeriodReported`	`string \| null`	No	—	—

The table shows the first 50 fields. Expand the raw schema below for every field.

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