> ## 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: Fund Search

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

Fund Search.

<Info>
  Tool ID: `pitchbook_fund_search`
</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_fund_search',
  {
    "fundNames": "example",
    "investorNames": "example",
    "fundStrategy": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_fund_search --input '{
  "fundNames": "example",
  "investorNames": "example",
  "fundStrategy": "example"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "stats": {
      "total": 123,
      "perPage": 123,
      "page": 123
    },
    "items": [
      {
        "fundId": "fund_123",
        "fundName": "Example",
        "investors": [
          {}
        ]
      }
    ]
  }
}
```

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

## Input reference

Retrieves funds along with the investors associated with the fund

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.fundNames` | `string` | No | — | Accepts fund names, and pbIds. Returns a list of funds that are an exact match. Use a comma to separate multiple values |
| `payload.investorNames` | `string` | No | — | Accepts investor names, pbIds, websites, and tickers. Returns a list of funds with the exact matching investor names. Use a comma to separate multiple values |
| `payload.fundStrategy` | `string` | No | — | Funds can be found by their fund strategy code |
| `payload.dryPowder` | `string` | No | — | Find funds that have a certain amount of dry powder. Search for funds with dry powder more than an amount using the > operator, funds with dry powder less than an amount using the \< operator or funds with dry powder in a range using the ^ operator. Amounts in millions |
| `payload.fundSize` | `string` | No | — | Find funds that have a certain fund size. Search for funds with a larger fund size than an amount using the > operator, funds with a smaller fund size than an amount using the \< operator or funds within a range using the ^ operator. Amounts in millions |
| `payload.city` | `string` | No | — | Search for funds by city of their investors |
| `payload.stateProvince` | `string` | No | — | Search for funds by state code or province code of their investors |
| `payload.country` | `string` | No | — | Search for funds by country code of their investors |
| `payload.postCode` | `string` | No | — | Search for funds by postcodes of their investors |
| `payload.locationType` | `string` | No | — | Search for funds by additional parameter concerning the investors specifying HQ Only (HQ\_ONLY), Non-HQ Only (NON\_HQ\_ONLY) or any office location (ANY) values. Set this parameter in pair with city, stateProvince, country, postCode options |
| `payload.fundDomicileStateProvince` | `string` | No | — | Find funds by location of incorporation state code or province code |
| `payload.fundDomicileCountry` | `string` | No | — | Find funds by location of incorporation country code |
| `payload.vintage` | `string` | No | — | Search for funds by vintage year. Search for funds with a vintage after a certain date using the > operator, funds with a vintage before a certain date using the \< operator and funds with a vintage between 2 dates using the ^ operator |
| `payload.fundStatus` | `string` | No | — | Search for funds by the fund status. Pass a fund status code |
| `payload.fundDate` | `string` | No | — | Find funds within a certain time frame. Search for a fund after a certain date using the > operator, a fund before a certain date using the \< operator and a fund between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.commitmentSize` | `string` | No | — | Find funds by the size of individual commitments made to the fund. Search for funds with a commitment larger than an amount using the > operator, funds with a commitment smaller than an amount using the \< operator and funds with a commitment between 2 amounts using the ^ operator. Amounts in millions |
| `payload.commitmentDate` | `string` | No | — | Find funds by the date of individual commitments made to the fund. Search for funds with a commitment after a certain date using the > operator, funds with a commitment before a certain date using the \< operator and funds with a commitment between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.limitedPartnerNames` | `string` | No | — | Search for funds by the exact match of limited partners committed to them. Accepts limited partner names, pbIds, websites, and tickers to return all funds they are invested in. Use a comma to separate multiple values |
| `payload.irr` | `string` | No | — | Search for funds by their IRR. Find funds with an IRR greater than a certain percentage using the > operator, funds with an IRR smaller than a certain percentage using the \< operator and funds between certain percentages using the ^ operator |
| `payload.dpi` | `string` | No | — | Search for funds by their DPI multiple. Find funds with a multiple greater than a value using the > operator, funds with a multiple smaller than a value using the \< operator and funds with a multiple between values using the ^ operator |
| `payload.rvpi` | `string` | No | — | Search for funds by their RVPI multiple. Find funds with a multiple greater than a value using the > operator, funds with a multiple smaller than a value using the \< operator and funds with a multiple between values using the ^ operator |
| `payload.tvpi` | `string` | No | — | Search for funds by their TVPI multiple. Find funds with a multiple greater than a value using the > operator, funds with a multiple smaller than a value using the \< operator and funds with a multiple between values using the ^ operator |
| `payload.industryPreferences` | `string` | No | — | Find funds by their industry preferences. Pass an industry code |
| `payload.verticalsPreferences` | `string` | No | — | Find funds by their verticals preferences. Pass a vertical code |
| `payload.geographicalPreferences` | `string` | No | — | Find funds by their geographical preferences. Pass a state code , area code , province code , territory code , country code or regions code |
| `payload.additionalPreferences` | `string` | No | — | Find funds by additional investment preferences code |
| `payload.preferredInvestmentAmount` | `string` | No | — | Find funds by their preferred investment amount. Search for funds with preferred investment more than an amount using the > operator, funds with preferred investment less than an amount using the \< operator or funds with preferred investment within a range using the ^ operator. Amounts in millions |
| `payload.preferredDealTypes` | `string` | No | — | Find funds by their preferred deal type code |
| `payload.currency` | `string` | No | — | Specify the currency that your other parameters, such as dealSize, are entered as. It depends on the currency in user preferences |
| `payload.page` | `string` | No | — | Results are returned so that they can be paged through. Set this parameter to increment the page |
| `payload.perPage` | `string` | No | — | How many returned results show on page |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves funds along with the investors associated with the fund",
    "properties": {
      "fundNames": {
        "type": "string",
        "description": "Accepts fund names, and pbIds. Returns a list of funds that are an exact match. Use a comma to separate multiple values"
      },
      "investorNames": {
        "type": "string",
        "description": "Accepts investor names, pbIds, websites, and tickers. Returns a list of funds with the exact matching investor names. Use a comma to separate multiple values"
      },
      "fundStrategy": {
        "type": "string",
        "description": "Funds can be found by their fund strategy code"
      },
      "dryPowder": {
        "type": "string",
        "description": "Find funds that have a certain amount of dry powder. Search for funds with dry powder more than an amount using the > operator, funds with dry powder less than an amount using the < operator or funds with dry powder in a range using the ^ operator. Amounts in millions"
      },
      "fundSize": {
        "type": "string",
        "description": "Find funds that have a certain fund size. Search for funds with a larger fund size than an amount using the > operator, funds with a smaller fund size than an amount using the < operator or funds within a range using the ^ operator. Amounts in millions"
      },
      "city": {
        "type": "string",
        "description": "Search for funds by city of their investors"
      },
      "stateProvince": {
        "type": "string",
        "description": "Search for funds by state code or province code of their investors"
      },
      "country": {
        "type": "string",
        "description": "Search for funds by country code of their investors"
      },
      "postCode": {
        "type": "string",
        "description": "Search for funds by postcodes of their investors"
      },
      "locationType": {
        "type": "string",
        "description": "Search for funds by additional parameter concerning the investors specifying HQ Only (HQ_ONLY), Non-HQ Only (NON_HQ_ONLY) or any office location (ANY) values. Set this parameter in pair with city, stateProvince, country, postCode options"
      },
      "fundDomicileStateProvince": {
        "type": "string",
        "description": "Find funds by location of incorporation state code or province code"
      },
      "fundDomicileCountry": {
        "type": "string",
        "description": "Find funds by location of incorporation country code"
      },
      "vintage": {
        "type": "string",
        "description": "Search for funds by vintage year. Search for funds with a vintage after a certain date using the > operator, funds with a vintage before a certain date using the < operator and funds with a vintage between 2 dates using the ^ operator"
      },
      "fundStatus": {
        "type": "string",
        "description": "Search for funds by the fund status. Pass a fund status code"
      },
      "fundDate": {
        "type": "string",
        "description": "Find funds within a certain time frame. Search for a fund after a certain date using the > operator, a fund before a certain date using the < operator and a fund between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "commitmentSize": {
        "type": "string",
        "description": "Find funds by the size of individual commitments made to the fund. Search for funds with a commitment larger than an amount using the > operator, funds with a commitment smaller than an amount using the < operator and funds with a commitment between 2 amounts using the ^ operator. Amounts in millions"
      },
      "commitmentDate": {
        "type": "string",
        "description": "Find funds by the date of individual commitments made to the fund. Search for funds with a commitment after a certain date using the > operator, funds with a commitment before a certain date using the < operator and funds with a commitment between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "limitedPartnerNames": {
        "type": "string",
        "description": "Search for funds by the exact match of limited partners committed to them. Accepts limited partner names, pbIds, websites, and tickers to return all funds they are invested in. Use a comma to separate multiple values"
      },
      "irr": {
        "type": "string",
        "description": "Search for funds by their IRR. Find funds with an IRR greater than a certain percentage using the > operator, funds with an IRR smaller than a certain percentage using the < operator and funds between certain percentages using the ^ operator"
      },
      "dpi": {
        "type": "string",
        "description": "Search for funds by their DPI multiple. Find funds with a multiple greater than a value using the > operator, funds with a multiple smaller than a value using the < operator and funds with a multiple between values using the ^ operator"
      },
      "rvpi": {
        "type": "string",
        "description": "Search for funds by their RVPI multiple. Find funds with a multiple greater than a value using the > operator, funds with a multiple smaller than a value using the < operator and funds with a multiple between values using the ^ operator"
      },
      "tvpi": {
        "type": "string",
        "description": "Search for funds by their TVPI multiple. Find funds with a multiple greater than a value using the > operator, funds with a multiple smaller than a value using the < operator and funds with a multiple between values using the ^ operator"
      },
      "industryPreferences": {
        "type": "string",
        "description": "Find funds by their industry preferences. Pass an industry code"
      },
      "verticalsPreferences": {
        "type": "string",
        "description": "Find funds by their verticals preferences. Pass a vertical code"
      },
      "geographicalPreferences": {
        "type": "string",
        "description": "Find funds by their geographical preferences. Pass a state code , area code , province code , territory code , country code or regions code"
      },
      "additionalPreferences": {
        "type": "string",
        "description": "Find funds by additional investment preferences code"
      },
      "preferredInvestmentAmount": {
        "type": "string",
        "description": "Find funds by their preferred investment amount. Search for funds with preferred investment more than an amount using the > operator, funds with preferred investment less than an amount using the < operator or funds with preferred investment within a range using the ^ operator. Amounts in millions"
      },
      "preferredDealTypes": {
        "type": "string",
        "description": "Find funds by their preferred deal type code"
      },
      "currency": {
        "type": "string",
        "description": "Specify the currency that your other parameters, such as dealSize, are entered as. It depends on the currency in user preferences"
      },
      "page": {
        "type": "string",
        "description": "Results are returned so that they can be paged through. Set this parameter to increment the page"
      },
      "perPage": {
        "type": "string",
        "description": "How many returned results show on page"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.stats` | `object` | No | — | — |
| `result.data.stats.total` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.perPage` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.page` | `integer` | No | — | Format: `int32`. |
| `result.data.stats.lastPage` | `integer` | No | — | Format: `int32`. |
| `result.data.items` | `array` | No | — | — |
| `result.data.items[].fundId` | `string` | No | — | — |
| `result.data.items[].fundName` | `string` | No | — | — |
| `result.data.items[].investors` | `array` | No | — | — |
| `result.data.items[].investors[].investorId` | `string` | No | — | — |
| `result.data.items[].investors[].investorName` | `string` | No | — | — |
| `result.data.items[].sandbox` | `boolean` | 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": {
          "stats": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "perPage": {
                "type": "integer",
                "format": "int32"
              },
              "page": {
                "type": "integer",
                "format": "int32"
              },
              "lastPage": {
                "type": "integer",
                "format": "int32"
              }
            },
            "additionalProperties": false
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fundId": {
                  "type": "string"
                },
                "fundName": {
                  "type": "string"
                },
                "investors": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "investorId": {
                        "type": "string"
                      },
                      "investorName": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "sandbox": {
                  "type": "boolean"
                }
              },
              "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.