Find Companies
Search the Icypeas lead database for companies. Returns {total, leads[], pagination}, paginated (pagination.size 1-200, default 100; pass back pagination.token with the same query for the next page). query filters (any other key is rejected): include/exclude lists {"include":[...],"exclude":[...]} (max 200 values each) for name, lid (LinkedIn vanity id, e.g. "google"), urn (LinkedIn numeric id as string, e.g. "1527"), companyId (domain, website, URN, LinkedIn URL or vanity name), type (Privately Held, Sole Proprietorship, Self-Employed, Partnership, Public Company, Nonprofit, Educational Institution, Government Agency), industry (LinkedIn industry names, e.g. "Software Development"), location (prefer ISO country codes like "US"; "Paris, France" narrows to a city; values are OR'd), keyword (free text across the company profile), domain (bare domain like "acme.com"); ranges for headcount and revenue using only the keys ">", ">=", "<", "<=" with numeric values, e.g. {"headcount":{">=":11,"<=":200}} (gte/lte/min/max/from/to and string numbers are rejected); headcountGrowth {"timespan":"6months"|"12months"|"24months","min":-10,"max":50} (timespan required; min/max are percentages -100 to 10000). Example: {"query":{"industry":{"include":["Software Development"]},"location":{"include":["DE"]},"headcount":{">=":11,"<=":200}},"pagination":{"size":50}}
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: "icypeas",
path: "/api/find-companies",
body: {
"query": {}
}
});
console.log(output);Body parameters
Filters; any other key is rejected. Include/exclude {"include":[...],"exclude":[...]} for name, lid, urn, companyId, type, industry, location, keyword, domain (bare, e.g. "acme.com"). Ranges for headcount and revenue with only ">", ">=", "<", "<=" and numbers, e.g. {"headcount":{">=":11,"<=":200}}. headcountGrowth: {"timespan":"6months"|"12months"|"24months","min":-10,"max":50}.
Optional. {"size": 1-200 (default 100), "token": "<pagination.token from the previous response>"}. The query must not change between pages; tokens expire.
Response