> ## 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 Fund Performance

> Fund Performance. PitchBook Get Fund Performance reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Fund Performance.

<Info>
  Tool ID: `pitchbook_get_fund_performance`
</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_fund_performance',
  {
    "pbId": "pb_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute pitchbook_get_fund_performance --input '{
  "pbId": "pb_123"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "fundId": "fund_123",
    "fundName": "Example",
    "asOfQuarter": 123
  }
}
```

Use `deepline tools get pitchbook_get_fund_performance --json` for the latest machine-readable contract.

## Input reference

Retrieves the most recent fund performance metrics for a specific fund and, when requested, historical performance snapshots from prior periods.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.pbId` | `string` | Yes | — | Fund pbId |
| `payload.historicalPerformance` | `boolean` | No | `false` | Include historical fund performance data. To use this parameter, set it to True. False by default. |
| `payload.sinceDate` | `string` | No | — | Search for fund returns data relating to the period after a specific date using the > operator, before a certain date using the \< operator, and between 2 dates using the ^ operator. Use this parameter only when the historicalPerformance parameter is applied Format: YYYY-MM-DD |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves the most recent fund performance metrics for a specific fund and, when requested, historical performance snapshots from prior periods.",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Fund pbId"
      },
      "historicalPerformance": {
        "type": "boolean",
        "description": "Include historical fund performance data. To use this parameter, set it to True. False by default.",
        "default": false
      },
      "sinceDate": {
        "type": "string",
        "description": "Search for fund returns data relating to the period after a specific date using the > operator, before a certain date using the < operator, and between 2 dates using the ^ operator. Use this parameter only when the historicalPerformance parameter is applied Format: YYYY-MM-DD"
      }
    },
    "required": [
      "pbId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.asOfQuarter` | `integer` | No | — | Format: `int32`. |
| `result.data.asOfYear` | `integer` | No | — | Format: `int32`. |
| `result.data.irr` | `number` | No | — | Format: `double`. |
| `result.data.dpi` | `number` | No | — | Format: `double`. |
| `result.data.rvpi` | `number \| null` | No | — | Format: `double`. |
| `result.data.tvpi` | `number \| null` | No | — | Format: `double`. |
| `result.data.nav` | `number \| null` | No | — | Format: `double`. |
| `result.data.quartile` | `integer` | No | — | Format: `int32`. |
| `result.data.numberOfFundsInBenchmark` | `integer` | No | — | Format: `int32`. |
| `result.data.historicalPerformance` | `array` | No | — | — |
| `result.data.historicalPerformance[].asOfQuarter` | `integer` | No | — | Format: `int32`. |
| `result.data.historicalPerformance[].asOfYear` | `integer` | No | — | Format: `int32`. |
| `result.data.historicalPerformance[].irr` | `number` | No | — | Format: `double`. |
| `result.data.historicalPerformance[].dpi` | `number \| null` | No | — | Format: `double`. |
| `result.data.historicalPerformance[].rvpi` | `number \| null` | No | — | Format: `double`. |
| `result.data.historicalPerformance[].tvpi` | `number \| null` | No | — | Format: `double`. |
| `result.data.historicalPerformance[].nav` | `number \| null` | No | — | Format: `double`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<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": {
          "fundId": {
            "type": "string"
          },
          "fundName": {
            "type": "string"
          },
          "asOfQuarter": {
            "type": "integer",
            "format": "int32"
          },
          "asOfYear": {
            "type": "integer",
            "format": "int32"
          },
          "irr": {
            "type": "number",
            "format": "double"
          },
          "dpi": {
            "type": "number",
            "format": "double"
          },
          "rvpi": {
            "type": [
              "number",
              "null"
            ],
            "format": "double"
          },
          "tvpi": {
            "type": [
              "number",
              "null"
            ],
            "format": "double"
          },
          "nav": {
            "type": [
              "number",
              "null"
            ],
            "format": "double"
          },
          "quartile": {
            "type": "integer",
            "format": "int32"
          },
          "numberOfFundsInBenchmark": {
            "type": "integer",
            "format": "int32"
          },
          "historicalPerformance": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "asOfQuarter": {
                  "type": "integer",
                  "format": "int32"
                },
                "asOfYear": {
                  "type": "integer",
                  "format": "int32"
                },
                "irr": {
                  "type": "number",
                  "format": "double"
                },
                "dpi": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "rvpi": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "tvpi": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                },
                "nav": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "format": "double"
                }
              },
              "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.