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

# LeadMagic: Competitors Search

> Find a company's competitors from its domain, website URL or name. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Find a company's competitors from its domain, website URL or name.

> [!NOTE]
>
> Tool ID: `leadmagic_competitors_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(
  'leadmagic_competitors_search',
  {
    "company_domain": "example.com",
    "company_url": "https://example.com",
    "company_name": "Example Corp"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline run leadmagic_competitors_search --input '{
  "company_domain": "example.com",
  "company_url": "https://example.com",
  "company_name": "Example Corp"
}'
```

## 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": {
    "competitors": [
      {
        "name": "Example",
        "shortDescription": "example",
        "founded_year": "example"
      }
    ]
  }
}
```

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

## Input reference

Find competitors of a company by analyzing market position and industry data.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.company_domain` | `string` | No | — | Company website domain |
| `payload.company_url` | `string` | No | — | Company profile URL or identifier (optional) |
| `payload.company_name` | `string` | No | — | Company name |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Find competitors of a company by analyzing market position and industry data.",
    "properties": {
      "company_domain": {
        "type": "string",
        "description": "Company website domain"
      },
      "company_url": {
        "type": "string",
        "description": "Company profile URL or identifier (optional)"
      },
      "company_name": {
        "type": "string",
        "description": "Company name"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.competitors` | `array` | No | — | — |
| `result.data.competitors[].name` | `string` | No | — | — |
| `result.data.competitors[].shortDescription` | `string` | No | — | — |
| `result.data.competitors[].founded_year` | `string` | No | — | — |
| `result.data.competitors[].companyType` | `string` | No | — | — |
| `result.data.competitors[].hq` | `string` | No | — | — |
| `result.data.competitors[].employeesCount` | `integer` | No | — | — |
| `result.data.competitors[].valuation` | `integer` | No | — | — |
| `result.data.competitors[].tags` | `array` | No | — | — |
| `result.data.competitors[].tags[].name` | `string` | No | — | — |
| `result.data.competitors[].tags[].slug` | `string` | No | — | — |
| `result.data.competitors[].tags[].primary` | `boolean` | No | — | — |
| `result.data.competitors[].twitter_followers` | `integer` | No | — | — |
| `result.data.competitors[].growth` | `integer` | No | — | — |
| `result.data.competitors[].non_hq_locations` | `array` | No | — | — |
| `result.data.competitors[].more_locations` | `boolean` | No | — | — |
| `result.data.competitors[].financial_metrics` | `object` | No | — | — |
| `result.data.competitors[].financial_metrics.currency_code` | `string` | No | — | — |
| `result.data.competitors[].financial_metrics.period` | `string` | No | — | — |
| `result.data.competitors[].financial_metrics.revenue` | `integer` | No | — | — |
| `result.data.competitors[].financial_metrics.cost_of_goods_sold` | `integer \| null` | No | — | — |
| `result.data.competitors[].financial_metrics.gross_profit` | `integer \| null` | No | — | — |
| `result.data.competitors[].financial_metrics.net_income` | `integer \| null` | No | — | — |
| `result.data.competitors[].operating_metrics` | `array` | No | — | — |
| `result.data.competitors[].operating_metrics[].period` | `string` | No | — | — |
| `result.data.competitors[].operating_metrics[].value` | `string` | No | — | — |
| `result.data.competitors[].operating_metrics[].definition` | `string` | No | — | — |
| `result.data.competitors[].operating_metrics[].operating_metric_group` | `string` | No | — | — |
| `result.data.competitors[].operating_metrics[].currency_code` | `string \| null` | No | — | — |
| `result.data.competitors[].funding_metrics` | `object` | No | — | — |
| `result.data.competitors[].funding_metrics.date` | `string` | No | — | — |
| `result.data.competitors[].funding_metrics.latest` | `integer` | No | — | — |
| `result.data.competitors[].funding_metrics.currency_code` | `string` | No | — | — |
| `result.data.competitors[].funding_metrics.total` | `integer` | No | — | — |
| `result.data.competitors[].twitterEngagement` | `object` | No | — | — |
| `result.data.competitors[].twitterEngagement.handle` | `string` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics` | `array` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].collectedAt` | `string` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].tweets` | `integer` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].following` | `integer` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].followers` | `integer` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].tweetsForPeriod` | `integer` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].avgTweetsPerDay` | `number` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].avgRetweetsPerTweet` | `number` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].avgLikesPerTweet` | `number` | No | — | — |
| `result.data.competitors[].twitterEngagement.analytics[].tweetsPercentageEngagementForPeriod` | `number` | 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": {
          "competitors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "shortDescription": {
                  "type": "string"
                },
                "founded_year": {
                  "type": "string"
                },
                "companyType": {
                  "type": "string"
                },
                "hq": {
                  "type": "string"
                },
                "employeesCount": {
                  "type": "integer"
                },
                "valuation": {
                  "type": "integer"
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "slug": {
                        "type": "string"
                      },
                      "primary": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "twitter_followers": {
                  "type": "integer"
                },
                "growth": {
                  "type": "integer"
                },
                "non_hq_locations": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "more_locations": {
                  "type": "boolean"
                },
                "financial_metrics": {
                  "type": "object",
                  "properties": {
                    "currency_code": {
                      "type": "string"
                    },
                    "period": {
                      "type": "string"
                    },
                    "revenue": {
                      "type": "integer"
                    },
                    "cost_of_goods_sold": {
                      "type": [
                        "integer",
                        "null"
                      ]
                    },
                    "gross_profit": {
                      "type": [
                        "integer",
                        "null"
                      ]
                    },
                    "net_income": {
                      "type": [
                        "integer",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": false
                },
                "operating_metrics": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "period": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      },
                      "definition": {
                        "type": "string"
                      },
                      "operating_metric_group": {
                        "type": "string"
                      },
                      "currency_code": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "funding_metrics": {
                  "type": "object",
                  "properties": {
                    "date": {
                      "type": "string"
                    },
                    "latest": {
                      "type": "integer"
                    },
                    "currency_code": {
                      "type": "string"
                    },
                    "total": {
                      "type": "integer"
                    }
                  },
                  "additionalProperties": false
                },
                "twitterEngagement": {
                  "type": "object",
                  "properties": {
                    "handle": {
                      "type": "string"
                    },
                    "analytics": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "collectedAt": {
                            "type": "string"
                          },
                          "tweets": {
                            "type": "integer"
                          },
                          "following": {
                            "type": "integer"
                          },
                          "followers": {
                            "type": "integer"
                          },
                          "tweetsForPeriod": {
                            "type": "integer"
                          },
                          "avgTweetsPerDay": {
                            "type": "number"
                          },
                          "avgRetweetsPerTweet": {
                            "type": "number"
                          },
                          "avgLikesPerTweet": {
                            "type": "number"
                          },
                          "tweetsPercentageEngagementForPeriod": {
                            "type": "number"
                          }
                        },
                        "additionalProperties": false
                      }
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          }
        },
        "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: `1.68` per pricing unit.

## Related documentation

* [Connect integrations](https://deepline.com/docs/integrations.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.