API reference

Everything you need to call the Icypeas API: one base URL, one header, JSON in and JSON out.

Basics

Base URL	https://app.icypeas.com/api
Authentication	Authorization: YOUR_API_KEY header. See Authentication.
Format	Send Content-Type: application/json and a JSON body. Responses are JSON.
Method	POST for almost everything, GET for single scraping.
Success	Check "success": true in the body. Input errors return HTTP 200 with "success": false. See Errors.
Speed	Each endpoint has a rate limit.
OpenAPI	Download the OpenAPI 3.1 spec for Postman, Insomnia or code generators.

Endpoints

Emails

Endpoint	What it does
POST /email-search	Find a person's professional email from their name and company.
POST /email-verification	Check that an email address exists.
POST /domain-search	Find the role-based emails of a domain.
POST /bulk-search	Run up to 5,000 of the above in one call.

Results

Endpoint	What it does
POST /bulk-single-searchs/read	Get the result of one search, or list your searches.
POST /search-files/read	Follow the progress and stats of your bulk searches.

Profiles, companies and leads

Endpoint	What it does
GET /scrape/profile · POST /scrape	Get a person's data from their profile URL.
GET /scrape/company · POST /scrape	Get a company's data from its page URL.
POST /url-search/profile · POST /url-search	Find a person's profile URL.
POST /url-search/company · POST /url-search	Find a company's page URL.
POST /reverse-email-lookup	Find the profile behind an email.
POST /find-people	Search people in the lead database.
POST /find-companies	Search companies in the lead database.

Account

Endpoint	What it does
POST /a/actions/subscription-information	Your plan and remaining credits.

Webhooks (sent by Icypeas to you)

Webhook	When
Search item processed	Each time a single search, or a row of a bulk search, is done.
Bulk search done	When a whole bulk search is done.