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

> Find companies, investors, funds, people and other private market entities by name or keyword. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Find companies, investors, funds, people and other private market entities by name or keyword.

> [!NOTE]
>
> Tool ID: `pitchbook_general_search`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_general_search',
  {
    "query": "software companies hiring engineers",
    "page": "example",
    "perPage": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute pitchbook_general_search --input '{
  "query": "software companies hiring engineers",
  "page": "example",
  "perPage": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "stats": {
      "total": 123,
      "perPage": 123,
      "page": 123
    },
    "items": [
      {
        "sandbox": true,
        "pbId": "pb_123",
        "name": "Example"
      }
    ]
  }
}
```

Use `deepline describe pitchbook_general_search --json` for the latest machine-readable contract.

## Input reference

Retrieves business entities matching the specified criteria

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.query` | `string` | No | — | Pass some of the parameters: - an entity ID (will return results for entities with matching IDs). - name (entities can be found by formal, also known as and legal names. Exact and partial matches are returned). - website (only exact matches are returned for website inputs). - ticker (takes entity ticker and searches across all exchanges. results are returned for exact matches only). - xticker (takes exchange and ticker symbol. results are returned for exact matches only) |
| `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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves business entities matching the specified criteria",
    "properties": {
      "query": {
        "type": "string",
        "description": "Pass some of the parameters: - an entity ID (will return results for entities with matching IDs); - name (entities can be found by formal, also known as and legal names. Exact and partial matches are returned); - website (only exact matches are returned for website inputs); - ticker (takes entity ticker and searches across all exchanges; results are returned for exact matches only); - xticker (takes exchange and ticker symbol; results are returned for exact matches only)"
      },
      "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[].sandbox` | `boolean` | No | — | — |
| `result.data.items[].pbId` | `string \| null` | No | — | — |
| `result.data.items[].name` | `string \| null` | No | — | — |
| `result.data.items[].discriminator` | `string` | No | — | — |
| `result.data.items[].website` | `string \| null` | No | — | — |
| `result.data.items[].pitchBookProfileLink` | `string` | No | — | — |
| `result.data.items[].primaryFirmType` | `object` | No | — | — |
| `result.data.items[].primaryFirmType.pbId` | `string` | No | — | — |
| `result.data.items[].primaryFirmType.type` | `"GENERAL" \| "COMPANY" \| "INVESTOR" \| "LIMITED_PARTNER" \| "SERVICE_PROVIDER" \| "PERSON" \| "DEAL" \| "FUND"` | No | — | — |
| `result.data.items[].otherFirmTypes` | `array` | No | — | — |
| `result.data.items[].otherFirmTypes[].pbId` | `string` | No | — | — |
| `result.data.items[].otherFirmTypes[].type` | `"GENERAL" \| "COMPANY" \| "INVESTOR" \| "LIMITED_PARTNER" \| "SERVICE_PROVIDER" \| "PERSON" \| "DEAL" \| "FUND"` | No | — | — |
| `result.data.items[].stockTicker` | `string \| null` | No | — | — |
| `result.data.items[].fundId` | `string` | No | — | — |
| `result.data.items[].fundName` | `string` | No | — | — |
| `result.data.items[].primaryCompanyId` | `string` | No | — | — |
| `result.data.items[].primaryCompanyName` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "sandbox": {
                      "type": "boolean"
                    },
                    "pbId": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "name": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "discriminator": {
                      "type": "string"
                    }
                  },
                  "required": [],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "sandbox": {
                      "type": "boolean"
                    },
                    "pbId": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "name": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "discriminator": {
                      "type": "string"
                    },
                    "website": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "pitchBookProfileLink": {
                      "type": "string"
                    },
                    "primaryFirmType": {
                      "type": "object",
                      "properties": {
                        "pbId": {
                          "type": "string"
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "GENERAL",
                            "COMPANY",
                            "INVESTOR",
                            "LIMITED_PARTNER",
                            "SERVICE_PROVIDER",
                            "PERSON",
                            "DEAL",
                            "FUND"
                          ]
                        }
                      },
                      "additionalProperties": false
                    },
                    "otherFirmTypes": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "pbId": {
                            "type": "string"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "GENERAL",
                              "COMPANY",
                              "INVESTOR",
                              "LIMITED_PARTNER",
                              "SERVICE_PROVIDER",
                              "PERSON",
                              "DEAL",
                              "FUND"
                            ]
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "stockTicker": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "sandbox": {
                      "type": "boolean"
                    },
                    "pbId": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "name": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "discriminator": {
                      "type": "string"
                    },
                    "fundId": {
                      "type": "string"
                    },
                    "fundName": {
                      "type": "string"
                    }
                  },
                  "required": [],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "sandbox": {
                      "type": "boolean"
                    },
                    "pbId": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "name": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "discriminator": {
                      "type": "string"
                    },
                    "primaryCompanyId": {
                      "type": "string"
                    },
                    "primaryCompanyName": {
                      "type": "string"
                    }
                  },
                  "required": [],
                  "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](https://deepline.com/docs/providers/pitchbook/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.