Not sure where to start? Tell us what you have and we’ll show you the fastest way to get the data you need.
Tip
New here? Start with Getting started to create your account and API key.
Pick your starting point
- I have a Social URL → Get their full profile
- I have an email, name, or domain → Find the matching profile
- I have filters (job title, location…) → Search our database
Profiles
Turn a Social URL into a complete person or company profile.
| Endpoint | Credits | Delivery | When to use |
|---|---|---|---|
POST /v2/fetch/persons/check |
0 | Sync | Check if a person profile exists before spending credits |
POST /v2/fetch/companies/check |
0 | Sync | Check if a company profile exists before spending credits |
POST /v2/fetch/persons |
1 | Sync | Retrieve a cached person profile. Fast and cheap |
POST /v2/fetch/companies |
1 | Sync | Retrieve a cached company profile. Fast and cheap |
POST /v2/fetch/persons/live |
2 | Async | Force a fresh scrape when you need the latest data |
POST /v2/fetch/companies/live |
2 | Async | Force a fresh scrape when you need the latest data |
Tip
Recommended flow: Call Check first (free), then Fetch if the record is recent, or Live if it’s missing or stale. See Data freshness for the full optimization strategy.
Enrichment
Find a profile when you don’t have a Social URL. Send the details you have, get the full profile back in the same response.
| Endpoint | Credits | Delivery | Input |
|---|---|---|---|
POST /v2/enrich/persons |
2 | Sync | Any combination of email, name, company name or domain |
POST /v2/enrich/companies |
2 | Sync | A company domain (e.g. acme.com) |
Note
Credits are charged only when a match is found. A not-found response (404) is free.
Search
Query our database of indexed profiles with filters. No Social URL needed.
| Endpoint | Credits | Delivery | When to use |
|---|---|---|---|
POST /v2/search/persons |
1 | Sync | Search persons by job title, location, company… |
POST /v2/search/companies |
1 | Sync | Search companies by industry, size, location… |
Note
1 credit per search, up to 100 results per request.
Sync vs async
Most endpoints return data instantly in the API response. The Live endpoints, which scrape fresh data on demand, deliver their results asynchronously.
| Delivery | How it works |
|---|---|
| Async | Results pulled on demand via polling (recommended), or pushed to a webhook URL (advanced) |
| Sync | Instant JSON response |