> ## 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.

# PredictLeads: Company Similar Companies

> Returns a list of a company's Similar Companies and, for the top 20, provides a reason why they are considered similar. PredictLeads Company Similar Companies.

Returns a list of a company's Similar Companies and, for the top 20, provides a reason why they are considered similar.

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

## 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(
  'predictleads_company_similar_companies',
  {
    "company_id_or_domain": "example.com"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute predictleads_company_similar_companies --input '{
  "company_id_or_domain": "example.com"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe predictleads_company_similar_companies --json` for the complete live contract.

## Input reference

Returns a list of a company's Similar Companies and, for the top 20, provides a reason why they are considered similar.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.company_id_or_domain` | `string` | Yes | — | Company's ID or domain. |
| `payload.page` | `integer` | No | `1` | Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. Minimum: 1. |
| `payload.limit` | `integer` | No | `20` | Limit the number of shown items per page. Maximum: 50. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a list of a company's Similar Companies and, for the top 20, provides a reason why they are considered similar.",
    "properties": {
      "company_id_or_domain": {
        "type": "string",
        "description": "Company's ID or domain."
      },
      "page": {
        "type": "integer",
        "description": "Page number of shown items. **NOTE**: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons.",
        "default": 1,
        "minimum": 1
      },
      "limit": {
        "type": "integer",
        "description": "Limit the number of shown items per page.",
        "default": 20,
        "maximum": 50
      }
    },
    "required": [
      "company_id_or_domain"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | PredictLeads provides Similar Companies data for over 18.5 million companies, identifying businesses that are similar to a given company. The intelligent matching is powered by all PredictLeads datasets, including technologies, news events, job openings, and more, including a reason attribute explaining why two companies are similar. |
| `result.data.data` | `array` | Yes | — | — |
| `result.data.data[].id` | `string` | Yes | — | ID of the `SimilarCompany` object. Format: `uuid`. |
| `result.data.data[].type` | `"company_similarity"` | Yes | — | Type of the `SimilarCompany` object. |
| `result.data.data[].attributes` | `object` | Yes | — | Attributes of the `SimilarCompany` object. |
| `result.data.data[].attributes.score` | `number` | Yes | — | Similarity score between the companies. Minimum: 0. Maximum: 1. |
| `result.data.data[].attributes.position` | `integer \| null` | Yes | — | Position of the similar company in the list. Minimum: 1. Maximum: 50. |
| `result.data.data[].attributes.reason` | `string \| null` | Yes | — | Reason why this company is considered a similar company. |
| `result.data.data[].attributes.refreshed_at` | `string` | Yes | — | Date & time (ISO 8601) when the similar company data was last refreshed. Format: `date-time`. |
| `result.data.data[].relationships` | `object` | Yes | — | The data contains references to related objects listed in the `included` property. |
| `result.data.data[].relationships.company` | `object` | Yes | — | The data contains a reference to related `CompanyLite` object listed in the `included` property. |
| `result.data.data[].relationships.company.data` | `object` | Yes | — | — |
| `result.data.data[].relationships.company.data.id` | `string` | Yes | — | ID of the included `CompanyLite` object. Format: `uuid`. |
| `result.data.data[].relationships.company.data.type` | `"company"` | Yes | — | Type of the included `CompanyLite` object. |
| `result.data.data[].relationships.similar_company` | `object` | Yes | — | The data contains a reference to related `CompanyLite` object listed in the `included` property. |
| `result.data.data[].relationships.similar_company.data` | `object` | Yes | — | — |
| `result.data.data[].relationships.similar_company.data.id` | `string` | Yes | — | ID of the included `CompanyLite` object. Format: `uuid`. |
| `result.data.data[].relationships.similar_company.data.type` | `"company"` | Yes | — | Type of the included `CompanyLite` object. |
| `result.data.included` | `array` | Yes | — | Contains objects referenced in property `relationships`. |
| `result.data.included[].id` | `string` | Yes | — | ID of the `CompanyLite` object. Format: `uuid`. |
| `result.data.included[].type` | `"company"` | Yes | — | Type of the `CompanyLite` object. |
| `result.data.included[].attributes` | `object` | Yes | — | Attributes of the `CompanyLite` object. |
| `result.data.included[].attributes.domain` | `string` | Yes | — | Company domain name. |
| `result.data.included[].attributes.company_name` | `string \| null` | Yes | — | Company name if available. |
| `result.data.included[].attributes.ticker` | `string \| null` | Yes | — | Company stock symbol (ticker) if available. |
| `result.data.meta` | `object` | No | — | Meta information about `SimilarCompaniesDataset` object. |
| `result.data.meta.schema_version` | `string` | Yes | — | Represents schema version of objects. |
| `result.data.meta.record_state` | `"active"` | Yes | — | Represents record state of objects. |
| `result.data.meta.count` | `integer` | No | — | Total number of results. **NOTE**: Only included in API responses when the request parameter `page` is provided, for performance reasons. |
| `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": "PredictLeads provides Similar Companies data for over 18.5 million companies, identifying businesses that are similar to a given company. The intelligent matching is powered by all PredictLeads datasets, including technologies, news events, job openings, and more, including a reason attribute explaining why two companies are similar.",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "The `SimilarCompany` object.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "ID of the `SimilarCompany` object.",
                  "format": "uuid"
                },
                "type": {
                  "description": "Type of the `SimilarCompany` object.",
                  "const": "company_similarity"
                },
                "attributes": {
                  "type": "object",
                  "description": "Attributes of the `SimilarCompany` object.",
                  "properties": {
                    "score": {
                      "type": "number",
                      "description": "Similarity score between the companies.",
                      "minimum": 0,
                      "maximum": 1
                    },
                    "position": {
                      "type": [
                        "integer",
                        "null"
                      ],
                      "description": "Position of the similar company in the list.",
                      "minimum": 1,
                      "maximum": 50
                    },
                    "reason": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Reason why this company is considered a similar company."
                    },
                    "refreshed_at": {
                      "type": "string",
                      "description": "Date & time (ISO 8601) when the similar company data was last refreshed.",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "score",
                    "position",
                    "reason",
                    "refreshed_at"
                  ],
                  "additionalProperties": false
                },
                "relationships": {
                  "type": "object",
                  "description": "The data contains references to related objects listed in the `included` property.",
                  "properties": {
                    "company": {
                      "type": "object",
                      "description": "The data contains a reference to related `CompanyLite` object listed in the `included` property.",
                      "properties": {
                        "data": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "ID of the included `CompanyLite` object.",
                              "format": "uuid"
                            },
                            "type": {
                              "description": "Type of the included `CompanyLite` object.",
                              "const": "company"
                            }
                          },
                          "required": [
                            "id",
                            "type"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "required": [
                        "data"
                      ],
                      "additionalProperties": false
                    },
                    "similar_company": {
                      "type": "object",
                      "description": "The data contains a reference to related `CompanyLite` object listed in the `included` property.",
                      "properties": {
                        "data": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "ID of the included `CompanyLite` object.",
                              "format": "uuid"
                            },
                            "type": {
                              "description": "Type of the included `CompanyLite` object.",
                              "const": "company"
                            }
                          },
                          "required": [
                            "id",
                            "type"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "required": [
                        "data"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "company",
                    "similar_company"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "type",
                "attributes",
                "relationships"
              ],
              "additionalProperties": false
            }
          },
          "included": {
            "type": "array",
            "description": "Contains objects referenced in property `relationships`.",
            "items": {
              "type": "object",
              "description": "The `CompanyLite` object.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "ID of the `CompanyLite` object.",
                  "format": "uuid"
                },
                "type": {
                  "description": "Type of the `CompanyLite` object.",
                  "const": "company"
                },
                "attributes": {
                  "type": "object",
                  "description": "Attributes of the `CompanyLite` object.",
                  "properties": {
                    "domain": {
                      "type": "string",
                      "description": "Company domain name."
                    },
                    "company_name": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Company name if available."
                    },
                    "ticker": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Company stock symbol (ticker) if available."
                    }
                  },
                  "required": [
                    "domain",
                    "company_name",
                    "ticker"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "type",
                "attributes"
              ],
              "additionalProperties": false
            }
          },
          "meta": {
            "type": "object",
            "description": "Meta information about `SimilarCompaniesDataset` object.",
            "properties": {
              "schema_version": {
                "type": "string",
                "description": "Represents schema version of objects."
              },
              "record_state": {
                "type": "string",
                "description": "Represents record state of objects.",
                "const": "active"
              },
              "count": {
                "type": "integer",
                "description": "Total number of results. **NOTE**: Only included in API responses when the request parameter `page` is provided, for performance reasons."
              }
            },
            "required": [
              "schema_version",
              "record_state"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "data",
          "included"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.56` per pricing unit.

## Related documentation

* [PredictLeads provider guide](https://deepline.com/docs/providers/predictleads/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.