> ## 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: Get Similar Companies

> Company Similar Companies. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Company Similar Companies.

<Info>
  Tool ID: `pitchbook_get_similar_companies`
</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_get_similar_companies',
  {
    "pbId": "pb_123"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute pitchbook_get_similar_companies --input '{
  "pbId": "pb_123"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": [
    {
      "companyId": "company_123",
      "similarCompanyId": "similar_company_123",
      "similarCompanyName": "Example Corp"
    }
  ]
}
```

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

## Input reference

Retrieves top 10 similar companies/competitors

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.pbId` | `string` | Yes | — | Company pbId |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves top 10 similar companies/competitors",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Company pbId"
      }
    },
    "required": [
      "pbId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `array` | Yes | — | Provider response payload. |
| `result.data[].companyId` | `string` | No | — | — |
| `result.data[].similarCompanyId` | `string` | No | — | — |
| `result.data[].similarCompanyName` | `string` | No | — | — |
| `result.data[].similarityScore` | `number` | No | — | Format: `float`. |
| `result.data[].competitor` | `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": "array",
        "description": "Provider response payload.",
        "items": {
          "type": "object",
          "properties": {
            "companyId": {
              "type": "string"
            },
            "similarCompanyId": {
              "type": "string"
            },
            "similarCompanyName": {
              "type": "string"
            },
            "similarityScore": {
              "type": "number",
              "format": "float"
            },
            "competitor": {
              "type": "boolean"
            }
          },
          "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.