The Companies API icon

The Companies API

Access company data, enrichment, analytics and more using The Companies API

Overview

This node operation, Search similar companies, allows users to find companies that are similar based on one or more domain names. It is useful for scenarios such as competitor analysis, market research, lead generation, or enriching company data by discovering related businesses.

For example, a marketing team could input domains of known competitors to retrieve a list of companies with similar profiles, helping them identify potential new targets or partners. Similarly, sales teams can use this to expand their prospect lists by finding companies related to existing clients.

The node sends query parameters including domains and various filters to an external API, which returns matching companies ranked and sorted according to specified criteria.

Properties

Name Meaning
Domains One or more domain names (as strings) used to find similar companies. Multiple values allowed.
Simplified Boolean flag indicating whether to return simplified company data.
Page Number specifying the page of results to retrieve (pagination). Defaults to 1.
Size Number specifying how many results per page to return. Defaults to 25.
Sort key Field by which to sort the results. Options include various company attributes such as business type, industries, name, total employees, year founded, monthly visitors, revenue, location codes, score, socials, and more.
Sort order Order of sorting: ascending ("asc") or descending ("desc"). Defaults to descending.
Proximity exact Numeric value to specify exact proximity for similarity filtering. Optional.
Proximity term Term describing proximity level: "close", "near", or "far". Defaults to "close".
Sort fields Additional string fields to sort by; multiple values allowed.

Output

The output JSON contains the data returned from the external API call to search for similar companies. This typically includes an array of company objects with detailed information depending on the simplified flag and other parameters.

Each item in the output corresponds to one input item, paired by index. If the operation fails for an item and "continue on fail" is enabled, the output will contain an error message for that item instead.

The node does not output binary data.

Dependencies

  • Requires an API token credential for authentication with The Companies API service.
  • Uses the official SDK of The Companies API (@thecompaniesapi/sdk) to perform requests.
  • The node expects proper configuration of the API token credential within n8n.

Troubleshooting

  • Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error stating "Unknown operation". Ensure the operation name is exactly "searchSimilarCompanies".
  • SDK method not found: If the SDK does not have the expected method, it throws an error like "SDK method ... not found". This may indicate version mismatch or misconfiguration.
  • Empty or invalid input: Providing empty domains or invalid types may result in no results or errors. Make sure to provide valid domain strings.
  • API authentication errors: If the API token is missing, expired, or invalid, the node will fail to authenticate. Verify the API token credential setup.
  • Pagination issues: Requesting pages beyond available data may return empty results. Adjust page and size accordingly.

Links and References


If you need further details about other operations or resources, feel free to ask!

Discussion