Company / Similar

Scroll

Cost: 5 credit per company returned. 5 credits if no results are found.

Finds similar companies to the given company by id or domain. The POST route allows specifying further filtering parameters. At most 100 companies are returned per request.

You can request the next page of results by using the cursor parameter. The cursor is a string that encodes the current position in the result set. In case on no cursor is provided, the first page of results is returned. You can then use the next_cursor parameter to get the next page of results.

This will allow you to scroll over the results without having to keep track of the current page number and also allow paginating into more than 10.000 results.

post/companies/similar/scroll

Request

  • Base URL: https://api.companyenrich.com
  • URL: https://api.companyenrich.com/companies/similar/scroll
  • Auth: API key in header Authorization

Query parameters

expandstring[]

Expandable response fields. Repeat the parameter to request multiple expansions.

Supported values:

  • workforce: costs 5 credits per company and adds the workforce field to CompanyInfo.
waitForEnrichmentboolean

Whether to wait for on-demand enrichment when a seed company is not stored yet. When false, valid missing domains are scheduled for background enrichment and the request returns a 404 if any seed company is missing, so it can be retried with a stable seed set later. This only controls seed-company enrichment; preparing a similarity vector for a stored company may still require processing.

Request body

pageSizeinteger

The number of results to return in each page. Must be between 1 and 100

cursorstring nullable

The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored.

domainsstring[]

The domains to find similar companies for. Up to 10 domains are allowed.

similarityWeightnumber double

The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. Larger values will prioritize more similar companies, smaller values will prioritize more established companies.

minScorenumber double nullable

The minimum similarity score required for results. Must be between 0 and 1. When omitted, the default cutoff is used.

querystring nullable

The search query to apply on the company name and domain

categoryOperatorunknown
keywordsOperatorunknown
technologiesOperatorunknown
requireFeatureRequirement[] nullable

The features that must exist for the company

regionsstring[] nullable

The region IDs to filter by

countriesstring[] nullable

The 2 letter country codes to filter by

statesinteger[] nullable

The state IDs to filter by

citiesinteger[] nullable

The city IDs to filter by

typeCompanyType[] nullable

The list of company types to filter by

categoryCompanyCategory[] nullable

The list of company categories to filter by

employeesCompanyEmployees[] nullable

The list of employee counts to filter by

reportedEmployeesCompanyEmployees[] nullable

The list of externally reported employee counts to filter by

revenueCompanyRevenue[] nullable

The list of revenue ranges to filter by

naicsCodeinteger[] nullable

The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included

keywordsstring[] nullable

The keywords to filter by

technologiesstring[] nullable

The technologies to filter by

fundingRoundsCompanyFundingRound[] nullable

The funding rounds to filter by

Response

OK

nextCursorstring nullable

The cursor for the next page

previousCursorstring nullable

The cursor for the previous page

totalItemsinteger

The total number of items in the list

startIndexinteger nullable

The index of the first item in the entire result set

Changes

No recorded changes to this operation across all 1 revision of this API.