> ## 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 Deal Tranche Info

> Deal Tranche Information. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Deal Tranche Information.

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

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

### CLI

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

## Example response

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

```json theme={null}
{
  "data": {
    "dealId": "deal_123",
    "dealNumber": 123,
    "company": {
      "id": "id_123",
      "name": "Example"
    }
  }
}
```

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

## Input reference

Retrieves tranche data within the specific deal

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.pbId` | `string` | Yes | — | Deal pbId |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves tranche data within the specific deal",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Deal pbId"
      }
    },
    "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.dealId` | `string` | No | — | — |
| `result.data.dealNumber` | `integer` | No | — | Format: `int32`. |
| `result.data.company` | `object \| null` | No | — | — |
| `result.data.company.id` | `string` | No | — | — |
| `result.data.company.name` | `string` | No | — | — |
| `result.data.tranches` | `array` | No | — | — |
| `result.data.tranches[].trancheSize` | `object \| null` | No | — | — |
| `result.data.tranches[].trancheSize.amount` | `number` | No | — | — |
| `result.data.tranches[].trancheSize.currency` | `string` | No | — | — |
| `result.data.tranches[].trancheSize.nativeAmount` | `number` | No | — | — |
| `result.data.tranches[].trancheSize.nativeCurrency` | `string` | No | — | — |
| `result.data.tranches[].trancheSize.estimated` | `boolean` | No | — | — |
| `result.data.tranches[].trancheSizeStatus` | `string \| null` | No | — | — |
| `result.data.tranches[].trancheDate` | `string` | No | — | Format: `date`. |
| `result.data.tranches[].financingType` | `object \| null` | No | — | — |
| `result.data.tranches[].financingType.code` | `string` | No | — | — |
| `result.data.tranches[].financingType.description` | `string` | No | — | — |
| `result.data.tranches[].stockType` | `object \| null` | No | — | — |
| `result.data.tranches[].stockType.code` | `string` | No | — | — |
| `result.data.tranches[].stockType.description` | `string` | No | — | — |
| `result.data.tranches[].stockSeriesType` | `string` | No | — | — |
| `result.data.tranches[].conversionStatus` | `string \| null` | No | — | — |
| `result.data.tranches[].conversionDate` | `string \| null` | No | — | Format: `date`. |
| `result.data.tranches[].investor` | `object \| null` | No | — | — |
| `result.data.tranches[].investor.id` | `string` | No | — | — |
| `result.data.tranches[].investor.name` | `string` | No | — | — |
| `result.data.tranches[].investor2` | `object \| null` | No | — | — |
| `result.data.tranches[].investor2.id` | `string` | No | — | — |
| `result.data.tranches[].investor2.name` | `string` | No | — | — |
| `result.data.tranches[].investor3` | `object \| null` | No | — | — |
| `result.data.tranches[].investor3.id` | `string` | No | — | — |
| `result.data.tranches[].investor3.name` | `string` | No | — | — |
| `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": {
          "dealId": {
            "type": "string"
          },
          "dealNumber": {
            "type": "integer",
            "format": "int32"
          },
          "company": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "tranches": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "trancheSize": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number"
                    },
                    "currency": {
                      "type": "string"
                    },
                    "nativeAmount": {
                      "type": "number"
                    },
                    "nativeCurrency": {
                      "type": "string"
                    },
                    "estimated": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                },
                "trancheSizeStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "trancheDate": {
                  "type": "string",
                  "format": "date"
                },
                "financingType": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "stockType": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "stockSeriesType": {
                  "type": "string"
                },
                "conversionStatus": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "conversionDate": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date"
                },
                "investor": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "investor2": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "investor3": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "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.