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

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

Investor Search.

<Info>
  Tool ID: `pitchbook_investor_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_investor_search',
  {
    "investorNames": "example",
    "investorType": "example",
    "aum": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_investor_search --input '{
  "investorNames": "example",
  "investorType": "example",
  "aum": "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": [
      {
        "investorId": "investor_123",
        "investorName": "Example",
        "sandbox": true
      }
    ]
  }
}
```

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

## Input reference

Retrieves investors matching the specified criteria

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.investorNames` | `string` | No | — | Accepts investor names, pbIds, websites, and tickers. Returns a list of investors that are an exact match. Use a comma to separate multiple values |
| `payload.investorType` | `string` | No | — | Investors can be found by their investor type code |
| `payload.aum` | `string` | No | — | Search for investors by their amount of assets under management. Search for investors with AUM over a certain amount using the > operator, investors with AUM under a certain amount with the \< operator or investors within a range using the ^ operator. Amounts in millions |
| `payload.dryPowder` | `string` | No | — | Find investors that have a certain amount of dry powder. Search for investors with dry powder more than an amount using the > operator, investors with dry powder less than an amount using the \< operator or investors with dry powder within a range using the ^ operator. Amounts in millions |
| `payload.city` | `string` | No | — | Search for investors by their city location |
| `payload.stateProvince` | `string` | No | — | Search for investors by state code or province code |
| `payload.country` | `string` | No | — | Search for investors by country code |
| `payload.postCode` | `string` | No | — | Search for investors by their postcode, included to support searching for both US postal code and foreign |
| `payload.locationType` | `string` | No | — | Search for investors by additional parameter 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.fundNames` | `string` | No | — | Search for investors by their underlying funds with exact match. Accepts fund names, and pbIds. Returns a list of investors associated with that funds. Use a comma to separate multiple values |
| `payload.fundStrategy` | `string` | No | — | Search for investors by the fund strategy of their underlying funds. Pass a fund strategy code |
| `payload.fundSize` | `string` | No | — | Search for investors by the fund size of their underlying funds. 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.fundStatus` | `string` | No | — | Search for investors by the fund status of their underlying funds. Pass a fund status code |
| `payload.fundDate` | `string` | No | — | Search for investors by the date of the fund status of their underlying funds. Search for funds with a status date after a certain date using the > operator, funds with a status date after a certain date using the \< operator and funds with a status date in a range using the ^ operator. Format: YYYY-MM-DD |
| `payload.verticalsPreferences` | `string` | No | — | Find investors by their verticals preferences. Pass a vertical code |
| `payload.industryPreferences` | `string` | No | — | Find investors by their industry preferences. Pass an industry code |
| `payload.additionalPreferences` | `string` | No | — | Find investors by additional investment preferences code |
| `payload.geographicalPreferences` | `string` | No | — | Find investors by their geographical preferences. Pass a state code , area code , province code , territory code , country code or regions code |
| `payload.preferredInvestmentAmount` | `string` | No | — | Find investors by their preferred investment amount. Search for investors with preferred investment more than an amount using the > operator, investors with preferred investment less than an amount using the \< operator or investors with preferred investment within a range using the ^ operator. Amounts in millions |
| `payload.preferredDealTypes` | `string` | No | — | Find investors by their preferred deal type code |
| `payload.companyNames` | `string` | No | — | Find investors by the exact matched companies they have invested in. Accepts company names, pbIds, websites, and tickers. Use a comma to separate multiple values |
| `payload.onlyMostRecentTransaction` | `string` | No | — | Find investors by their most recent company transactions. To use this parameter set it as True |
| `payload.dealType` | `string` | No | — | Find investors by the types of deals and investments they have done. Pass a deal type code |
| `payload.dealStatus` | `string` | No | — | Find investors by status of their past deals and investments. Distinguish between failed, upcoming, completed deals and more. Pass a deal status code |
| `payload.dealSize` | `string` | No | — | Find investors who have done a deal of a certain size. Search for investors with a deal larger than an amount using the > operator, investors with a deal smaller than a certain amount using the \< operator and investors with a deal size in a range using the ^ operator. Amounts in millions |
| `payload.includeDealsWithoutDealSize` | `string` | No | — | Include investors made investments without a known deal size. Set this parameter as True only when Deal Size parameter is applied. False by default |
| `payload.excludeDealsWithoutDealSize` | `string` | No | — | Exclude investors made investments without a known deal size. Set this parameter as True only when Deal Size parameter is not applied. False by default |
| `payload.dealDate` | `string` | No | — | Find investors who have had a deal within a certain time frame. Search for investors with a deal after a certain date using the > operator, investors with a deal before a certain date using the \< operator and investors with a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.dealIndustry` | `string` | No | — | Find investors by the industry code of companies they have invested in |
| `payload.dealVerticals` | `string` | No | — | Find investors by the vertical code of companies they have invested in |
| `payload.dealIndustryAndVertical` | `string` | No | — | When using both deal industry and deal vertical parameters, "OR" logic is used by default. To use "AND" logic, set this parameter to True |
| `payload.dealKeywords` | `string` | No | — | Find investors by the keywords of companies they have invested in |
| `payload.dealCity` | `string` | No | — | Find investors by the city of the companies they have invested in |
| `payload.dealStateProvince` | `string` | No | — | Find investors by the state code or province code of the companies they have invested in |
| `payload.dealCountry` | `string` | No | — | Find investors by the country code of the companies they have invested in |
| `payload.dealPostCode` | `string` | No | — | Find investors by the post code of the companies they have invested in, included to support searching for both US postal code and foreign |
| `payload.dealLocationType` | `string` | No | — | Search for investors by additional parameter (related to the companies they have invested in) specifying HQ Only (HQ\_ONLY), Non-HQ Only (NON\_HQ\_ONLY) or any office location (ANY) values. Set this parameter in pair with dealCity, dealStateProvince, dealCountry, dealPostCode options |
| `payload.limitedPartnerNames` | `string` | No | — | Find investors by the exact match of limited partners invested in their funds. Accepts limited partner names, pbIds, websites, and tickers. Use a comma to separate multiple values |
| `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 investors matching the specified criteria",
    "properties": {
      "investorNames": {
        "type": "string",
        "description": "Accepts investor names, pbIds, websites, and tickers. Returns a list of investors that are an exact match. Use a comma to separate multiple values"
      },
      "investorType": {
        "type": "string",
        "description": "Investors can be found by their investor type code"
      },
      "aum": {
        "type": "string",
        "description": "Search for investors by their amount of assets under management. Search for investors with AUM over a certain amount using the > operator, investors with AUM under a certain amount with the < operator or investors within a range using the ^ operator. Amounts in millions"
      },
      "dryPowder": {
        "type": "string",
        "description": "Find investors that have a certain amount of dry powder. Search for investors with dry powder more than an amount using the > operator, investors with dry powder less than an amount using the < operator or investors with dry powder within a range using the ^ operator. Amounts in millions"
      },
      "city": {
        "type": "string",
        "description": "Search for investors by their city location"
      },
      "stateProvince": {
        "type": "string",
        "description": "Search for investors by state code or province code"
      },
      "country": {
        "type": "string",
        "description": "Search for investors by country code"
      },
      "postCode": {
        "type": "string",
        "description": "Search for investors by their postcode, included to support searching for both US postal code and foreign"
      },
      "locationType": {
        "type": "string",
        "description": "Search for investors by additional parameter 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"
      },
      "fundNames": {
        "type": "string",
        "description": "Search for investors by their underlying funds with exact match. Accepts fund names, and pbIds. Returns a list of investors associated with that funds. Use a comma to separate multiple values"
      },
      "fundStrategy": {
        "type": "string",
        "description": "Search for investors by the fund strategy of their underlying funds. Pass a fund strategy code"
      },
      "fundSize": {
        "type": "string",
        "description": "Search for investors by the fund size of their underlying funds. 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"
      },
      "fundStatus": {
        "type": "string",
        "description": "Search for investors by the fund status of their underlying funds. Pass a fund status code"
      },
      "fundDate": {
        "type": "string",
        "description": "Search for investors by the date of the fund status of their underlying funds. Search for funds with a status date after a certain date using the > operator, funds with a status date after a certain date using the < operator and funds with a status date in a range using the ^ operator. Format: YYYY-MM-DD"
      },
      "verticalsPreferences": {
        "type": "string",
        "description": "Find investors by their verticals preferences. Pass a vertical code"
      },
      "industryPreferences": {
        "type": "string",
        "description": "Find investors by their industry preferences. Pass an industry code"
      },
      "additionalPreferences": {
        "type": "string",
        "description": "Find investors by additional investment preferences code"
      },
      "geographicalPreferences": {
        "type": "string",
        "description": "Find investors by their geographical preferences. Pass a state code , area code , province code , territory code , country code or regions code"
      },
      "preferredInvestmentAmount": {
        "type": "string",
        "description": "Find investors by their preferred investment amount. Search for investors with preferred investment more than an amount using the > operator, investors with preferred investment less than an amount using the < operator or investors with preferred investment within a range using the ^ operator. Amounts in millions"
      },
      "preferredDealTypes": {
        "type": "string",
        "description": "Find investors by their preferred deal type code"
      },
      "companyNames": {
        "type": "string",
        "description": "Find investors by the exact matched companies they have invested in. Accepts company names, pbIds, websites, and tickers. Use a comma to separate multiple values"
      },
      "onlyMostRecentTransaction": {
        "type": "string",
        "description": "Find investors by their most recent company transactions. To use this parameter set it as True"
      },
      "dealType": {
        "type": "string",
        "description": "Find investors by the types of deals and investments they have done. Pass a deal type code"
      },
      "dealStatus": {
        "type": "string",
        "description": "Find investors by status of their past deals and investments. Distinguish between failed, upcoming, completed deals and more. Pass a deal status code"
      },
      "dealSize": {
        "type": "string",
        "description": "Find investors who have done a deal of a certain size. Search for investors with a deal larger than an amount using the > operator, investors with a deal smaller than a certain amount using the < operator and investors with a deal size in a range using the ^ operator. Amounts in millions"
      },
      "includeDealsWithoutDealSize": {
        "type": "string",
        "description": "Include investors made investments without a known deal size. Set this parameter as True only when Deal Size parameter is applied. False by default"
      },
      "excludeDealsWithoutDealSize": {
        "type": "string",
        "description": "Exclude investors made investments without a known deal size. Set this parameter as True only when Deal Size parameter is not applied. False by default"
      },
      "dealDate": {
        "type": "string",
        "description": "Find investors who have had a deal within a certain time frame. Search for investors with a deal after a certain date using the > operator, investors with a deal before a certain date using the < operator and investors with a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "dealIndustry": {
        "type": "string",
        "description": "Find investors by the industry code of companies they have invested in"
      },
      "dealVerticals": {
        "type": "string",
        "description": "Find investors by the vertical code of companies they have invested in"
      },
      "dealIndustryAndVertical": {
        "type": "string",
        "description": "When using both deal industry and deal vertical parameters, \"OR\" logic is used by default. To use \"AND\" logic, set this parameter to True"
      },
      "dealKeywords": {
        "type": "string",
        "description": "Find investors by the keywords of companies they have invested in"
      },
      "dealCity": {
        "type": "string",
        "description": "Find investors by the city of the companies they have invested in"
      },
      "dealStateProvince": {
        "type": "string",
        "description": "Find investors by the state code or province code of the companies they have invested in"
      },
      "dealCountry": {
        "type": "string",
        "description": "Find investors by the country code of the companies they have invested in"
      },
      "dealPostCode": {
        "type": "string",
        "description": "Find investors by the post code of the companies they have invested in, included to support searching for both US postal code and foreign"
      },
      "dealLocationType": {
        "type": "string",
        "description": "Search for investors by additional parameter (related to the companies they have invested in) specifying HQ Only (HQ_ONLY), Non-HQ Only (NON_HQ_ONLY) or any office location (ANY) values. Set this parameter in pair with dealCity, dealStateProvince, dealCountry, dealPostCode options"
      },
      "limitedPartnerNames": {
        "type": "string",
        "description": "Find investors by the exact match of limited partners invested in their funds. Accepts limited partner names, pbIds, websites, and tickers. Use a comma to separate multiple values"
      },
      "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[].investorId` | `string` | No | — | — |
| `result.data.items[].investorName` | `string` | No | — | — |
| `result.data.items[].sandbox` | `boolean` | No | — | — |
| `result.data.items[].website` | `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": {
          "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": {
                "investorId": {
                  "type": "string"
                },
                "investorName": {
                  "type": "string"
                },
                "sandbox": {
                  "type": "boolean"
                },
                "website": {
                  "type": "string"
                }
              },
              "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.