Scroll
Find similar companies with cursor-based pagination for large result sets. Accepts the same parameters as /companies/similar. Pagination billing: call the first page normally and save billing.requestId from the Orthogonal /v1/run response. For later page, offset, or cursor calls on the same logical search, pass parentRequestId with unchanged non-pagination parameters. Valid continuation calls still get their own request IDs and quoted price, but are charged 0. Changing filters starts a new billable request.
Dynamic pricing
body.pageSize * 5 * 0.01225
Example code
// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";
const orthogonal = new Orthogonal({
apiKey: process.env.ORTHOGONAL_API_KEY,
});
const output = await orthogonal.run({
api: "company-enrich",
path: "/companies/similar/scroll",
body: {
"pageSize": "value"
}
});
console.log(output);Query parameters
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`.
Body parameters
REQUIRED. Number of results per page (1-100). Determines cost: 5 credits ($0.06125) per result returned. Total call cost = pageSize x per-result cost.
The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored. For later cursor pages of the same logical search, keep non-pagination parameters unchanged and pass top-level parentRequestId from the first Orthogonal /v1/run response.
The domains to find similar companies for. Up to 10 domains are allowed.
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.
Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results.
The search query to apply on the company name and domain
The range of years
The funding amount range to filter by
The range of years
The operator to apply to the filters. Defaults to And.
The operator to apply to the filters. Defaults to And.
The operator to apply to the filters. Defaults to And.
Filter companies by workforce growth percentage over a selected period and department.
Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.
The features that must exist for the company
The region IDs to filter by
The 2 letter country codes to filter by
The state IDs to filter by
The city IDs to filter by
The list of company types to filter by
The list of company categories to filter by
The list of employee counts to filter by
The list of revenue ranges to filter by
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
The keywords to filter by
The technologies to filter by
The funding rounds to filter by
Response
Actual Orthogonal credits charged for this /v1/run call. Accepted continuation pages are charged 0.
Price this call would normally cost before continuation billing is applied.
Unique Orthogonal request ID for this page or poll call. Save the first call requestId and pass it as parentRequestId on later pages.
Parent Orthogonal request ID when this call is a continuation of an earlier search.
Root Orthogonal request ID for the full logical search.
True when this call was accepted as a continuation page or poll.
False for accepted continuation pages because they are not charged again.
Quoted price for this page or poll before continuation billing.
Actual credits charged for this page or poll. Accepted continuations return 0.
Total charged so far for the full logical search, including the first page and accepted continuations.