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

# PitchBook: Get Portfolio Holdings

> Fund Portfolio Holdings. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Fund Portfolio Holdings.

<Info>
  Tool ID: `pitchbook_get_portfolio_holdings`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
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

```bash theme={null}
deepline tools execute pitchbook_get_portfolio_holdings --input '{
  "pbId": "pb_123",
  "period": "example"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

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

Use `deepline tools get 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 |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves key portfolio holding information for the specified fund",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Fund pbId"
      },
      "period": {
        "type": "string",
        "description": "Time period of reported fund holdings data"
      },
      "industryCode": {
        "type": "string",
        "description": "Find holdings based on industry via industry code . Use a comma to separate multiple values."
      },
      "instrumentType": {
        "type": "string",
        "description": "Find holdings by their instrument type (aka investment type). Use a comma to separate multiple values."
      },
      "syndicated": {
        "type": "string",
        "description": "Find holdings who have had a deal with syndicated loans within them. To use this parameter set it as True or False"
      }
    },
    "required": [
      "pbId",
      "period"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "fund": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "period": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "syndicated": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "accrualStatus": {
                  "type": "string"
                },
                "instrumentType": {
                  "type": "string"
                },
                "clo": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "industry": {
                  "type": "object",
                  "properties": {
                    "reportedIndustry": {
                      "type": "string"
                    },
                    "industrySector": {
                      "type": "string"
                    },
                    "industryGroup": {
                      "type": "string"
                    },
                    "industryCode": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "issuer": {
                  "type": "object",
                  "properties": {
                    "issuerId": {
                      "type": "string"
                    },
                    "issuerName": {
                      "type": "string"
                    },
                    "issuerType": {
                      "type": "string",
                      "enum": [
                        "COMPANY",
                        "FUND"
                      ]
                    }
                  },
                  "additionalProperties": false
                },
                "cost": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number"
                    },
                    "currency": {
                      "type": "string"
                    },
                    "nativeAmount": {
                      "type": "number"
                    },
                    "nativeCurrency": {
                      "type": "string"
                    },
                    "estimated": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                },
                "principal": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number"
                    },
                    "currency": {
                      "type": "string"
                    },
                    "nativeAmount": {
                      "type": "number"
                    },
                    "nativeCurrency": {
                      "type": "string"
                    },
                    "estimated": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                },
                "fairValue": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number"
                    },
                    "currency": {
                      "type": "string"
                    },
                    "nativeAmount": {
                      "type": "number"
                    },
                    "nativeCurrency": {
                      "type": "string"
                    },
                    "estimated": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                },
                "floor": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "maturityDate": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date"
                },
                "spreadInterestRate": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "pikInterest": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "numberOfShares": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "baseRefRate": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "allInRate": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "cashPercent": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "fairValueOverCost": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "fairValueOverPrincipal": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "acquisitionDate": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date"
                },
                "firstPeriodReported": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "finalPeriodReported": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "deal": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "dealId": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [PitchBook provider guide](/docs/providers/pitchbook/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.