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

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

Company Search.

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

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_company_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": [
      {
        "companyId": "company_123",
        "companyName": "Example Corp",
        "sandbox": true
      }
    ]
  }
}
```

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

## Input reference

Retrieves companies matching the specified criteria

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.companyNames` | `string` | No | — | Accepts company names, pbIds, websites, and tickers. Returns a list of companies that are an exact match. Use a comma to separate multiple values |
| `payload.ownershipStatus` | `string` | No | — | Companies can be found by their ownership status code |
| `payload.backingStatus` | `string` | No | — | Companies can be found by their backing status code |
| `payload.businessStatus` | `string` | No | — | Companies can be found by their business status code |
| `payload.city` | `string` | No | — | Search for companies by their city location |
| `payload.stateProvince` | `string` | No | — | Search for companies by their state code or province code |
| `payload.country` | `string` | No | — | Search for companies by their country code |
| `payload.postCode` | `string` | No | — | Search for companies by their postcode, included to support searching for both US postal code and foreign |
| `payload.locationType` | `string` | No | — | Search for companies 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.dateFounded` | `string` | No | — | Companies can be found by founding date. Search for 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.keywords` | `string` | No | — | Search for companies by keywords associated with them or appearing in their business descriptions. If two or more keywords are specified, the OR operator is applied. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.industry` | `string` | No | — | Companies can be found by the industry code . 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 | — | Companies can be found by the vertical code . 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 any combination of industry, verticals, and emergingSpaces parameters, "OR" logic is used by default. To use "AND" logic, set this parameter to True. |
| `payload.emergingSpaces` | `string` | No | — | Emerging spaces are defined by PB analysts for specific products or technological innovations that are growing in popularity. These spaces are dynamic and change over time. Companies can be found by the emerging space code . Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.gecsSector` | `string` | No | — | Companies can be found by the GECS sector code . 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 | — | Companies can be found by the GECS industry group code . 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 | — | Companies can be found by the GECS industry code . Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications |
| `payload.dealType` | `string` | No | — | Find companies with a 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 companies who have had a deal of a certain size. Search for companies with a deal larger than an amount using the > operator, companies with a deal smaller than a certain amount using the \< operator and companies with a deal size in a range using the ^ operator. Amounts in millions |
| `payload.includeDealsWithoutDealSize` | `string` | No | — | Include companies 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 companies 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 companies who have had a deal within a certain time frame. Search for companies with a deal after a certain date using the > operator, companies with a deal before a certain date using the \< operator and companies with a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.totalRaised` | `string` | No | — | Find companies by the 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.investorNames` | `string` | No | — | Accepts investor names, pbIds, websites, and tickers. Returns a list of companies that have been invested in by specified investors that are an exact match to the input. Use a comma to separate multiple values |
| `payload.partialExit` | `string` | No | — | Find companies who have had a deal with partial investor's exit within them. To use this parameter set it as True |
| `payload.fullExit` | `string` | No | — | Find companies who have had a deal with full investor's exit within them. To use this parameter set it as True |
| `payload.exitType` | `string` | No | — | Find companies with a specific exit of deal 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 companies who have had a deal with investor's exit within them of a certain size. Search for companies with an exit larger than an amount using the > operator, companies with an exit smaller than a certain amount using the \< operator and companies with an exit size in a range using the ^ operator. Amounts in millions |
| `payload.exitDate` | `string` | No | — | Find companies who have had a deal within a certain time frame. Search for companies with a deal after a certain date using the > operator, companies with a deal before a certain date using the \< operator and companies with a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD |
| `payload.revenue` | `string` | No | — | Find companies that have a certain amount of revenue. Search for companies with more revenue than an amount using the > operator, companies with less revenue than an amount using the \< operator or companies within a range using the ^ operator. Amounts in millions |
| `payload.onlyMostRecentTransaction` | `string` | No | — | Find companies by their most recent deal. To use this parameter set it as True |
| `payload.employeeCount` | `string` | No | — | Find companies by their current employee count. Search for companies with a headcount larger than a value using the > operator, companies with a headcount smaller than a value using the \< operator and companies with a headcount in a range using the ^ operator |
| `payload.totalPatentDocuments` | `string` | No | — | Add this parameter to filter based on total patents count. Use the > operator to indicate a minimum value, the \< operator to indicate a maximum value, and a range of two values with the ^ operator. |
| `payload.activePatentDocuments` | `string` | No | — | Add this parameter to filter based on active patents count. Use the > operator to indicate a minimum value, the \< operator to indicate a maximum value, and a range of two values with the ^ operator. |
| `payload.pendingPatentDocuments` | `string` | No | — | Add this parameter to filter based on pending patents count. Use the > operator to indicate a minimum value, the \< operator to indicate a maximum value, and a range of two values with the ^ operator. |
| `payload.totalPatentFamilies` | `string` | No | — | Add this parameter to filter based on patent family count. Use the > operator to indicate a minimum value, the \< operator to indicate a maximum value, and a range of two values with the ^ operator. |
| `payload.inactiveFamilyDocuments` | `string` | No | — | Add this parameter to filter based on inactive documents count. Use the > operator to indicate a minimum value, the \< operator to indicate a maximum value, and a range of two values with the ^ operator. |
| `payload.patentsExpiringNextYear` | `string` | No | — | Add this parameter to filter based on count of patents expiring next year. Use the > operator to indicate a minimum value, the \< operator to indicate a maximum value, and a range of two values with the ^ operator. |
| `payload.patentFilingLocation` | `string` | No | — | Patents can be found by their filing location . 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 companies matching the specified criteria",
    "properties": {
      "companyNames": {
        "type": "string",
        "description": "Accepts company names, pbIds, websites, and tickers. Returns a list of companies that are an exact match. Use a comma to separate multiple values"
      },
      "ownershipStatus": {
        "type": "string",
        "description": "Companies can be found by their ownership status code"
      },
      "backingStatus": {
        "type": "string",
        "description": "Companies can be found by their backing status code"
      },
      "businessStatus": {
        "type": "string",
        "description": "Companies can be found by their business status code"
      },
      "city": {
        "type": "string",
        "description": "Search for companies by their city location"
      },
      "stateProvince": {
        "type": "string",
        "description": "Search for companies by their state code or province code"
      },
      "country": {
        "type": "string",
        "description": "Search for companies by their country code"
      },
      "postCode": {
        "type": "string",
        "description": "Search for companies by their postcode, included to support searching for both US postal code and foreign"
      },
      "locationType": {
        "type": "string",
        "description": "Search for companies 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"
      },
      "dateFounded": {
        "type": "string",
        "description": "Companies can be found by founding date. Search for 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"
      },
      "keywords": {
        "type": "string",
        "description": "Search for companies by keywords associated with them or appearing in their business descriptions. If two or more keywords are specified, the OR operator is applied. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "industry": {
        "type": "string",
        "description": "Companies can be found by the industry code . 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": "Companies can be found by the vertical code . 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 any combination of industry, verticals, and emergingSpaces parameters, \"OR\" logic is used by default. To use \"AND\" logic, set this parameter to True."
      },
      "emergingSpaces": {
        "type": "string",
        "description": "Emerging spaces are defined by PB analysts for specific products or technological innovations that are growing in popularity. These spaces are dynamic and change over time. Companies can be found by the emerging space code . Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "gecsSector": {
        "type": "string",
        "description": "Companies can be found by the GECS sector code . 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": "Companies can be found by the GECS industry group code . 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": "Companies can be found by the GECS industry code . Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications"
      },
      "dealType": {
        "type": "string",
        "description": "Find companies with a 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 companies who have had a deal of a certain size. Search for companies with a deal larger than an amount using the > operator, companies with a deal smaller than a certain amount using the < operator and companies with a deal size in a range using the ^ operator. Amounts in millions"
      },
      "includeDealsWithoutDealSize": {
        "type": "string",
        "description": "Include companies 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 companies 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 companies who have had a deal within a certain time frame. Search for companies with a deal after a certain date using the > operator, companies with a deal before a certain date using the < operator and companies with a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "totalRaised": {
        "type": "string",
        "description": "Find companies by the 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"
      },
      "investorNames": {
        "type": "string",
        "description": "Accepts investor names, pbIds, websites, and tickers. Returns a list of companies that have been invested in by specified investors that are an exact match to the input. Use a comma to separate multiple values"
      },
      "partialExit": {
        "type": "string",
        "description": "Find companies who have had a deal with partial investor's exit within them. To use this parameter set it as True"
      },
      "fullExit": {
        "type": "string",
        "description": "Find companies who have had a deal with full investor's exit within them. To use this parameter set it as True"
      },
      "exitType": {
        "type": "string",
        "description": "Find companies with a specific exit of deal 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 companies who have had a deal with investor's exit within them of a certain size. Search for companies with an exit larger than an amount using the > operator, companies with an exit smaller than a certain amount using the < operator and companies with an exit size in a range using the ^ operator. Amounts in millions"
      },
      "exitDate": {
        "type": "string",
        "description": "Find companies who have had a deal within a certain time frame. Search for companies with a deal after a certain date using the > operator, companies with a deal before a certain date using the < operator and companies with a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD"
      },
      "revenue": {
        "type": "string",
        "description": "Find companies that have a certain amount of revenue. Search for companies with more revenue than an amount using the > operator, companies with less revenue than an amount using the < operator or companies within a range using the ^ operator. Amounts in millions"
      },
      "onlyMostRecentTransaction": {
        "type": "string",
        "description": "Find companies by their most recent deal. To use this parameter set it as True"
      },
      "employeeCount": {
        "type": "string",
        "description": "Find companies by their current employee count. Search for companies with a headcount larger than a value using the > operator, companies with a headcount smaller than a value using the < operator and companies with a headcount in a range using the ^ operator"
      },
      "totalPatentDocuments": {
        "type": "string",
        "description": "Add this parameter to filter based on total patents count. Use the > operator to indicate a minimum value, the < operator to indicate a maximum value, and a range of two values with the ^ operator."
      },
      "activePatentDocuments": {
        "type": "string",
        "description": "Add this parameter to filter based on active patents count. Use the > operator to indicate a minimum value, the < operator to indicate a maximum value, and a range of two values with the ^ operator."
      },
      "pendingPatentDocuments": {
        "type": "string",
        "description": "Add this parameter to filter based on pending patents count. Use the > operator to indicate a minimum value, the < operator to indicate a maximum value, and a range of two values with the ^ operator."
      },
      "totalPatentFamilies": {
        "type": "string",
        "description": "Add this parameter to filter based on patent family count. Use the > operator to indicate a minimum value, the < operator to indicate a maximum value, and a range of two values with the ^ operator."
      },
      "inactiveFamilyDocuments": {
        "type": "string",
        "description": "Add this parameter to filter based on inactive documents count. Use the > operator to indicate a minimum value, the < operator to indicate a maximum value, and a range of two values with the ^ operator."
      },
      "patentsExpiringNextYear": {
        "type": "string",
        "description": "Add this parameter to filter based on count of patents expiring next year. Use the > operator to indicate a minimum value, the < operator to indicate a maximum value, and a range of two values with the ^ operator."
      },
      "patentFilingLocation": {
        "type": "string",
        "description": "Patents can be found by their filing location . 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[].companyId` | `string` | No | — | — |
| `result.data.items[].companyName` | `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": {
                "companyId": {
                  "type": "string"
                },
                "companyName": {
                  "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.