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.

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.

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

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.

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

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation