> ## 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 Share Classes Performance

> Fund Share Classes Performance. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Fund Share Classes Performance.

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

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_get_fund_share_classes_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",
    "items": [
      {
        "shareClassId": "share_class_123",
        "shareClassName": "Example",
        "shareClassTicker": "example"
      }
    ]
  }
}
```

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

## Input reference

Retrieves latest share-class-level performance snapshots for the specified fund, including total return and yield metrics calculated at the share-class level.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.pbId` | `string` | Yes | — | Fund pbId |
| `payload.shareClassId` | `string` | No | — | Share class identifier |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves latest share-class-level performance snapshots for the specified fund, including total return and yield metrics calculated at the share-class level.",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Fund pbId"
      },
      "shareClassId": {
        "type": "string",
        "description": "Share class identifier"
      }
    },
    "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.items` | `array` | No | — | — |
| `result.data.items[].shareClassId` | `string` | No | — | — |
| `result.data.items[].shareClassName` | `string` | No | — | — |
| `result.data.items[].shareClassTicker` | `string` | No | — | — |
| `result.data.items[].snapshots` | `array` | No | — | — |
| `result.data.items[].snapshots[].asOfDate` | `string` | No | — | Format: `date`. |
| `result.data.items[].snapshots[].twelveMonthYield` | `number` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn` | `object` | No | — | — |
| `result.data.items[].snapshots[].totalReturn.oneMonth` | `number` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn.threeMonth` | `number` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn.yearToDate` | `number` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn.oneYear` | `number` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn.threeYear` | `number` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn.fiveYear` | `number \| null` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn.sevenYear` | `number \| null` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn.tenYear` | `number \| null` | No | — | Format: `double`. |
| `result.data.items[].snapshots[].totalReturn.sinceInception` | `number` | 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"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "shareClassId": {
                  "type": "string"
                },
                "shareClassName": {
                  "type": "string"
                },
                "shareClassTicker": {
                  "type": "string"
                },
                "snapshots": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "asOfDate": {
                        "type": "string",
                        "format": "date"
                      },
                      "twelveMonthYield": {
                        "type": "number",
                        "format": "double"
                      },
                      "totalReturn": {
                        "type": "object",
                        "properties": {
                          "oneMonth": {
                            "type": "number",
                            "format": "double"
                          },
                          "threeMonth": {
                            "type": "number",
                            "format": "double"
                          },
                          "yearToDate": {
                            "type": "number",
                            "format": "double"
                          },
                          "oneYear": {
                            "type": "number",
                            "format": "double"
                          },
                          "threeYear": {
                            "type": "number",
                            "format": "double"
                          },
                          "fiveYear": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "format": "double"
                          },
                          "sevenYear": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "format": "double"
                          },
                          "tenYear": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "format": "double"
                          },
                          "sinceInception": {
                            "type": "number",
                            "format": "double"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "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.