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

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

Deal Search.

<Info>
  Tool ID: `pitchbook_deal_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_deal_search',
  {
    "companyNames": "Example Corp",
    "ownershipStatus": "example",
    "backingStatus": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_deal_search --input '{
  "companyNames": "Example Corp",
  "ownershipStatus": "example",
  "backingStatus": "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": [
      {
        "dealId": "deal_123",
        "companyId": "company_123",
        "companyName": "Example Corp"
      }
    ]
  }
}
```

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

## Input reference

Retrieves deals along with the companies associated with the deal

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.companyNames` | `string` | No | — | Accepts company names, pbIds, websites, and tickers to find all deals. Returns a list of deals related to companies that are an exact match. Use a comma to separate multiple values |
| `payload.ownershipStatus` | `string` | No | — | Search for deals by ownership status code of the companies involved |
| `payload.backingStatus` | `string` | No | — | Search for deals by backing status code of the companies involved |
| `payload.businessStatus` | `string` | No | — | Search for deals by business status code of the companies involved |
| `payload.city` | `string` | No | — | Search for deals by city location of the companies involved |
| `payload.stateProvince` | `string` | No | — | Search for deals by state code or province code of the companies involved |
| `payload.country` | `string` | No | — | Search for deals by country code of the companies involved |
| `payload.postCode` | `string` | No | — | Search for deals by postcode of the companies involved, included to support searching for both US postal code and foreign |
| `payload.locationType` | `string` | No | — | Search for deals by additional parameter concerning the companies involved 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.dateFounded` | `string` | No | — | Deals can be found by founding date of the companies involved. Search for deals of companies founded after a certain date using the > operator, companies founded before a certain date using the \< operator and companies founded between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.industry` | `string` | No | — | Deals can be found by the industry code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.verticals` | `string` | No | — | Deals can be found by the vertical code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.industryAndVertical` | `string` | No | — | When using both industry and vertical parameters, "OR" logic is used by default. To use "AND" logic, set this parameter to True. Set this parameter in pair with industry and vertical options |
| `payload.gecsSector` | `string` | No | — | Deals can be found by the GECS sector code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.gecsIndustryGroup` | `string` | No | — | Deals can be found by the GECS industry group code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.gecsIndustry` | `string` | No | — | Deals can be found by the GECS industry code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.totalRaised` | `string` | No | — | Find deals by the companies' total amount of money they have raised to date in millions. Use the > operator to find companies that have raised more than a certain value, use the \< to find companies who have raised less than a certain value and the ^ operator to search within a range. Amounts in millions |
| `payload.keywords` | `string` | No | — | Search for deals by keywords associated with the companies involved or keywords appearing in their business description. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.onlyMostRecentTransaction` | `string` | No | — | Find most recent deals. To use this parameter set it as True |
| `payload.dealType` | `string` | No | — | Find specific deal type code |
| `payload.dealStatus` | `string` | No | — | Distinguish between failed, upcoming, completed deals and more. Pass a deal status code |
| `payload.dealSize` | `string` | No | — | Find deals of a certain size. Search for deals larger than an amount using the > operator, deals smaller than a certain amount using the \< operator and deals in a range using the ^ operator. Amounts in millions |
| `payload.includeDealsWithoutDealSize` | `string` | No | — | Include deals 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 deals 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 deals within a certain time frame. Search for a deal after a certain date using the > operator, a deal before a certain date using the \< operator and a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.partialExit` | `string` | No | — | Find deals with partial investor's exit within them. To use this parameter set it as True |
| `payload.fullExit` | `string` | No | — | Find deals with full investor's exit within them. To use this parameter set it as True |
| `payload.investorNames` | `string` | No | — | Search for deals by who invested in them with an exact match. Accepts investor names, pbIds, websites, and tickers to return all deals they participated in. Use a comma to separate multiple values |
| `payload.exitType` | `string` | No | — | Find specific deal types with investor's exit within them. Pass a exit type code |
| `payload.exitStatus` | `string` | No | — | Distinguish between failed, upcoming, completed exits and more. Pass a deal status code |
| `payload.exitSize` | `string` | No | — | Find deals of a certain size with investor's exit within them. Search for deals with an exit larger than an amount using the > operator, deals with an exit smaller than a certain amount using the \< operator and deals with an exit size in a range using the ^ operator. Amounts in millions |
| `payload.exitDate` | `string` | No | — | Find deals of a certain time frame with investor's exit within them. Search for deals with an exit after a certain date using the > operator, companies with an exit before a certain date using the \< operator and companies with an exit between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.preMoneyValuation` | `string` | No | — | Search for deals by companies' valuation prior to a financing. Search for deals with companies' valuation prior to a financing larger than an amount using the > operator, deals with companies' valuation prior to a financing smaller than a certain amount using the \< operator and deals with companies' valuation prior to a financing in a range using the ^ operator. Amounts in millions |
| `payload.postValuation` | `string` | No | — | Search for deals by companies' valuation prior at or post investment. Search for deals with companies' valuation prior at or post investment larger than an amount using the > operator, deals with companies' valuation prior at or post investment smaller than a certain amount using the \< operator and deals with companies' valuation prior at or post investment in a range using the ^ operator. Amounts in millions |
| `payload.revenue` | `string` | No | — | Find deals by the revenue of the companies involved. Search for deals with companies' revenue more than an amount using the > operator, deals with companies' revenue less than an amount using the \< operator or deals with companies' revenue in a range using the ^ operator. Amounts in millions |
| `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 deals along with the companies associated with the deal",
    "properties": {
      "companyNames": {
        "type": "string",
        "description": "Accepts company names, pbIds, websites, and tickers to find all deals. Returns a list of deals related to companies that are an exact match. Use a comma to separate multiple values"
      },
      "ownershipStatus": {
        "type": "string",
        "description": "Search for deals by ownership status code of the companies involved"
      },
      "backingStatus": {
        "type": "string",
        "description": "Search for deals by backing status code of the companies involved"
      },
      "businessStatus": {
        "type": "string",
        "description": "Search for deals by business status code of the companies involved"
      },
      "city": {
        "type": "string",
        "description": "Search for deals by city location of the companies involved"
      },
      "stateProvince": {
        "type": "string",
        "description": "Search for deals by state code or province code of the companies involved"
      },
      "country": {
        "type": "string",
        "description": "Search for deals by country code of the companies involved"
      },
      "postCode": {
        "type": "string",
        "description": "Search for deals by postcode of the companies involved, included to support searching for both US postal code and foreign"
      },
      "locationType": {
        "type": "string",
        "description": "Search for deals by additional parameter concerning the companies involved 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"
      },
      "dateFounded": {
        "type": "string",
        "description": "Deals can be found by founding date of the companies involved. Search for deals of companies founded after a certain date using the > operator, companies founded before a certain date using the < operator and companies founded between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "industry": {
        "type": "string",
        "description": "Deals can be found by the industry code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "verticals": {
        "type": "string",
        "description": "Deals can be found by the vertical code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "industryAndVertical": {
        "type": "string",
        "description": "When using both industry and vertical parameters, \"OR\" logic is used by default. To use \"AND\" logic, set this parameter to True. Set this parameter in pair with industry and vertical options"
      },
      "gecsSector": {
        "type": "string",
        "description": "Deals can be found by the GECS sector code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "gecsIndustryGroup": {
        "type": "string",
        "description": "Deals can be found by the GECS industry group code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "gecsIndustry": {
        "type": "string",
        "description": "Deals can be found by the GECS industry code of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "totalRaised": {
        "type": "string",
        "description": "Find deals by the companies' total amount of money they have raised to date in millions. Use the > operator to find companies that have raised more than a certain value, use the < to find companies who have raised less than a certain value and the ^ operator to search within a range. Amounts in millions"
      },
      "keywords": {
        "type": "string",
        "description": "Search for deals by keywords associated with the companies involved or keywords appearing in their business description. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "onlyMostRecentTransaction": {
        "type": "string",
        "description": "Find most recent deals. To use this parameter set it as True"
      },
      "dealType": {
        "type": "string",
        "description": "Find specific deal type code"
      },
      "dealStatus": {
        "type": "string",
        "description": "Distinguish between failed, upcoming, completed deals and more. Pass a deal status code"
      },
      "dealSize": {
        "type": "string",
        "description": "Find deals of a certain size. Search for deals larger than an amount using the > operator, deals smaller than a certain amount using the < operator and deals in a range using the ^ operator. Amounts in millions"
      },
      "includeDealsWithoutDealSize": {
        "type": "string",
        "description": "Include deals 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 deals 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 deals within a certain time frame. Search for a deal after a certain date using the > operator, a deal before a certain date using the < operator and a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "partialExit": {
        "type": "string",
        "description": "Find deals with partial investor's exit within them. To use this parameter set it as True"
      },
      "fullExit": {
        "type": "string",
        "description": "Find deals with full investor's exit within them. To use this parameter set it as True"
      },
      "investorNames": {
        "type": "string",
        "description": "Search for deals by who invested in them with an exact match. Accepts investor names, pbIds, websites, and tickers to return all deals they participated in. Use a comma to separate multiple values"
      },
      "exitType": {
        "type": "string",
        "description": "Find specific deal types with investor's exit within them. Pass a exit type code"
      },
      "exitStatus": {
        "type": "string",
        "description": "Distinguish between failed, upcoming, completed exits and more. Pass a deal status code"
      },
      "exitSize": {
        "type": "string",
        "description": "Find deals of a certain size with investor's exit within them. Search for deals with an exit larger than an amount using the > operator, deals with an exit smaller than a certain amount using the < operator and deals with an exit size in a range using the ^ operator. Amounts in millions"
      },
      "exitDate": {
        "type": "string",
        "description": "Find deals of a certain time frame with investor's exit within them. Search for deals with an exit after a certain date using the > operator, companies with an exit before a certain date using the < operator and companies with an exit between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "preMoneyValuation": {
        "type": "string",
        "description": "Search for deals by companies' valuation prior to a financing. Search for deals with companies' valuation prior to a financing larger than an amount using the > operator, deals with companies' valuation prior to a financing smaller than a certain amount using the < operator and deals with companies' valuation prior to a financing in a range using the ^ operator. Amounts in millions"
      },
      "postValuation": {
        "type": "string",
        "description": "Search for deals by companies' valuation prior at or post investment. Search for deals with companies' valuation prior at or post investment larger than an amount using the > operator, deals with companies' valuation prior at or post investment smaller than a certain amount using the < operator and deals with companies' valuation prior at or post investment in a range using the ^ operator. Amounts in millions"
      },
      "revenue": {
        "type": "string",
        "description": "Find deals by the revenue of the companies involved. Search for deals with companies' revenue more than an amount using the > operator, deals with companies' revenue less than an amount using the < operator or deals with companies' revenue in a range using the ^ operator. Amounts in millions"
      },
      "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[].dealId` | `string` | No | — | — |
| `result.data.items[].companyId` | `string` | No | — | — |
| `result.data.items[].companyName` | `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": {
                "dealId": {
                  "type": "string"
                },
                "companyId": {
                  "type": "string"
                },
                "companyName": {
                  "type": "string"
                },
                "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.