Skrapp API Reference

API Reference

Skrapp API is a simple and powerful HTTP RESTful API that allows users to programmatically manage their Skrapp account and utilize key features like email search, verification, and company search. Here's a quick overview:

API Features

All APIs return data in JSON format.
They follow standard HTTP response codes for success or failure.
An authentication key is required and must be provided in the X-Access-Key header. This key can be retrieved from your Skrapp account settings or from the authentication section below.

API Categories

Account APIs:

Account Data: Retrieve details like account name, email, creation date, and credits. Account Section
List Data: Get list metadata such as name, size, and creation date. Data Section
List Leads: Access lead details, including names and emails. Leads Section

Search APIs:

Email Finder: Search for an email based on a person's name and company or domain. Email Finder Section
Bulk Email Finder: Perform the email search function in bulk. Bulk Email Finder Section
Company Profiles Search: Search for leads using filters like location and job title. Company Profiles Section
Company Data Search: Retrieve key company information. Company Data Search Section

Verification APIs:

Email Verifier: Verify the validity of an email. Email Verifier Section
Bulk Email Verifier: Perform email verification in bulk. Bulk Email Verifier Section

For more technical details, visit references on HTTP Response Codes, JSON, REST

API Main URL

All of our API endpoints are HTTPS secured. HTTP requests are rejected.

https://api.skrapp.io

Authentication

To access our API endpoints, you must authenticate using your API key. This key needs to be included in the HTTP request header as "X-Access-Key“.

Authentication is done through your API key, which not only confirms your identity but also allows you to interact with the API. It’s important to keep your API key confidential, as it serves both for authentication and identification. Sharing or exposing it could lead to unauthorized access to your account.

Your API Key

******************************************

API Header Name

X-Access-Key

Authentication Method

HTTP Basic Auth.

Simple HTTP request with API key

curl "https://api.skrapp.io/api/v2/account" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

If you are logged in, your API key is included in all the examples on this page, so you can test any example right away. Only you can see this value.

Account Data

GET

The account data endpoint allows you to retrieve your account data programmatically. Your account data contains your name, email, social accounts, package, package expiry date, search credits and your lists names and IDs.

Account request example

curl "https://api.skrapp.io/api/v2/account" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

Account JSON Response

"credit": {
#Email Search credits 
 "email": {
"quota": 10000,
 "used": 4991
}, 
# Email Verifier credits
"verifier": {
"quota": 20000,
 "used": 228,
}, 
# Company Search credits
"search": {
"quota": 5000,
"used": 65
} 
}

HTTP Request

URL

https://api.skrapp.io/api/v2/account

Method

GET

HTTP Headers

X-Access-Key

******************************************

JSON Response

package

Your current plan or package

Text

packageRDate

Your monthly subscription renewal date.

Timestamp

credit

Your current email search, verifier, and company search credits.

Object

options

Your current email search, verifier, and company search credits.

Object

lists

Your lists information. This attribute does not return your lists data.

Another resource is dedicated to this

Array

List Data

GET

The list data endpoint enables you to access all metadata associated with a specific list. However, it does not return the leads stored within the list.

List data request example

curl "https://api.skrapp.io/api/v2/list/:listId" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

List data JSON Response

{
  "list_id": 100,
  "name": "My List",
  "creation_date": "2020-07-16T18:34:27.325Z",
  "count_leads": 75
}

HTTP Request

URL

https://api.skrapp.io/api/v2/list

Method

GET

URL Parameters

listId (/:listId/)

Your monthly subscription renewal date.

Required

HTTP Headers

X-Access-Key

******************************************

JSON Response

list_id

The ID of your list

Number

name

The name of your list

Text

creation_date

The creation date and time of your list

Datetime

count_leads

The number of leads saved in your list

Datetime

List Leads

GET

The list leads endpoint allows you to retrieve leads from your lists. You can specify the list ID and other optional parameters to retrieve leads in a JSON format.

List Leads request example

curl "https://api.skrapp.io/api/v2/list/:listId/leads?start=0&size=100&kw=John" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

List Leads JSON Response

{
  "count_results": 10000,
  "next_start": 100,
  "data": [
    {
      "id": 1,
      "name": "John Doe",
      "first_n": "John",
      "last_n": "Doe",
      "email": "Johndoe@example.com",
      "email_status": "ok",
      "linkedin_url": "linkedin.com/in/john-doe",
      "location": "Delaware, US",
      "domain": "example.com",
      "company_industry": "internet",
      "company_founded": "2020",
      "company_size": 50,
      "company_hq": "Delaware, US"
    }
  ]
}

HTTP Request

URL

https://api.skrapp.io/api/v2/list/:listId/leads

Method

GET

URL Parameters

listId (/:listId/)

The ID of the list

Required

URL Query Attributes

start

The maximum value of the leads ID field. This ID is not inclusive

Optional

Number

Default: ID of most recent lead

size

The number of leads to return per query

Text

Optional

Default: 25

A text keyword filter applied to the name, email, title, company website, and company name field

Optional

Text

rules

Maximum Size: The maximum value the size query attribute can accept is 500

HTTP Headers

X-Access-Key

******************************************

JSON Response

count_results

The overall number of results if a keyword is provided

Number

next_start

The value of the "start" query paramater for the next query

Number

data

An array containing the leads returned by your query

Array

Email Finder

GET

The Email Finder API endpoint allows you to programmatically find verified professional email addresses. It provides an email based on a first name, last name, and either a domain or company name.

Email Finder request example

curl "https://api.skrapp.io/api/v2/find?firstName=John&lastName=Doe&domain=skrapp.io" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

Email Finder JSON response

{
  "email": "john.doe@skrapp.io",
  "quality": {
    "status": "ok",
    "status_message": "john.doe@skrapp.io is a valid email address."
  }
}

HTTP Request

URL

https://api.skrapp.io/api/v2/find

Method

GET

HTTP Headers

X-Access-Key

******************************************

Content-Type

application/json

URL Query Attributes

fullName

The full name attribute

Text

Optional

companyName

The company name attribute

Text

Optional

Rules

Name

Either the first name and last name together, or the full name, must be provided.

Company

Either the company domain name, website, or company name must be provided.

JSON Response

Object

The email result

Text

pattern

The email format pattern of the company

Text

quality

The verification status of the email

Object

Quality Object

Object

status

The status code of the email verification. The possible values of this attribute are: ok (Valid), nok (Invalid), oka (Catch-All)

Text

status_message

The readable message reply of the email verification

Text

Bulk Email Finder

POST

The Bulk Email Finder API endpoint enables you to programmatically find multiple email addresses at once. The request body requires an array of names and companies, and in response, it returns an array of emails along with additional data such as the email verification status.

Bulk Email Finder request example

curl -X POST "https://api.skrapp.io/api/v2/find_bulk" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json" 
 -d ’[{"firstName":"John","lastName":"Doe","domain":"microsoft.com"},{"firstName":"John","lastName":"Doe","domain":"salesforce.com"}]'

Bulk Email Finder JSON response

[
  {
    "firstName": "John",
    "lastName": "Doe",
    "name": "John Doe",
    "domain": "microsoft.com",
    "company": "Microsoft",
    "companyLinkedInID": 1035,
    "email": "john.doe@microsoft.com",
    "quality": {
      "status": "oka"
    }
  },
  {
    "firstName": "John",
    "lastName": "Doe",
    "name": "John Doe",
    "domain": "salesforce.com",
    "company": "Salesforce",
    "companyLinkedInID": 3185,
    "email": "john.doe@salesforce.com",
    "quality": {
      "status": "oka"
    }
  }
]

HTTP Request

URL

https://api.skrapp.io/api/v2/find_bulk

Method

POST

HTTP Headers

X-Access-Key

******************************************

Content-Type

application/json

Request Body Rules

Limit

100

Request Body

fullName

The full name attribute

Text

Optional

Company

The company name attribute

Text

Optional

Rules

Name

Either the first name and last name together, or the full name, must be provided.

Company

Either the company domain name, website, or company name must be provided.

JSON Response

Object

firstName

The first name

Text

lastName

The last name

Text

name

The full name

Text

company

The company name

Text

The email address

Text

quality

Contains the verification status of the email

Object

Company Profiles Search

GET

The feature provided by the Company Profiles Search API endpoint enables users to explore employees associated with a company and access their professional email addresses.

Company Search request example

curl "https://api.skrapp.io/profile/search/email?companyName=microsoft&size=10" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

Company Search JSON response

{
  "meta": {
    "total_all": 95770,
    "total": 1,
    "next_results_id": "FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFmNzc0RjdHNFUnJLc3dwNy1ieDdsY3cAAAAAPyrHaRY2cEhmdkNlN1R6eVk5MlJPdzdSZnNR"
  },
  "company": {
    "name": "Microsoft",
    "domain": "microsoft.com",
    "website": "https://news.microsoft.com/",
    "industry": "Software Development",
    "type": "Public Company",
    "linkedin_url": "https://linkedin.com/company/1035",
    "specialties": [
      "Business Software",
      "Developer Tools",
      "Home & Educational Software",
      "Tablets",
      "Search"
    ],
    "revenue": "1 BILLION USD - 1000 BILLION USD",
    "employee_count": 226899,
    "employee_count_range": "10001+",
    "address": "1 Microsoft Way",
    "city": "Redmond",
    "country": "United States",
    "geo_area": "Washington",
    "postal_code": "98052",
    "crunchbase_url": "https://www.crunchbase.com/organization/microsoft?utm_source=linkedin&utm_medium=referral&utm_campaign=linkedin_companies&utm_content=profile_cta",
    "logo_url_primary": "https://logos.skrapp.io/company/1035",
    "logo_url_secondary": "https://logos-cdn.skrapp.io/logos/microsoft.com"
  },
  "results": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "location": "Greater Seattle Area",
      "position": {
        "title": "Office 365 Exchange Online Live Site SRE",
        "location": "Redmond, WA",
        "start_date": {
          "month": 11,
          "year": 2010
        }
      },
      "email": "john.doe@microsoft.com",
      "email_quality": {
        "status": "oka",
        "status_message": "john.doe@microsoft.com is a catch-all mailbox"
      }
    }
  ]
}

HTTP Request

URL

https://api.skrapp.io/profile/search/email

Method

GET

HTTP Headers

X-Access-Key

******************************************

URL Query Attributes

title

Job title keyword. Keyword search guidelines are below.

Text

Optional

location

Geographic location keyword. Keyword search guidelines are below.

Text

Optional

You can conduct a keyword search (job title and location) using the profiles API in two ways:

1- Single keyword (e.g., ?title=marketing+manager): This search will yield results with job titles that include both the keywords 'marketing‘ and 'manager‘. In this scenario, it functions as an 'AND‘ operator, requiring both keywords to be present.

2- Array of keywords (e.g., ?title={marketing,manager}): This search will return results with job titles containing at least one of the keywords from the input array. Here, it operates as an 'OR‘ operator, allowing either 'marketing‘ or 'manager‘ to be present in the results.

size

The number of leads to return per query

Number

Maximum: 150

companyName

The name of the company. This attribute is case-insensitive. E.G.: skrapp. This field is mandatory if the companyWebsite attribute is not provided.

Text

companyWebsite

The website of the company. E.G.: https://skrapp.io. This field is mandatory if the companyName attribute is not provided.

Text

nextId

Pagination ID to get the next set of results in the loop matching the search query. This value is returned in the response of the initial call or subsequent ones.

Text

JSON Response

Object

Company Data Search

GET

The Company Data Search API endpoint allows users to research key information about any company, including industry, revenue, and headcount. This information enables users to conduct accurate and segmented prospecting campaigns for sales and marketing. Additionally, it helps enrich existing databases in sales automation platforms or CRMs, improving the quality of lead targeting and leads data management. To track your Company Data Search API credits, check the "search“ field under "credit“ in the Account API

Company data search request example

curl "https://api.skrapp.io/lwh/company/search?kw=skrapp.io" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

Company Search JSON response

{
  "result:": [
    {
      "name": "Skrapp.io",
      "domain": "skrapp.io",
      "website": "https://skrapp.io",
      "industry": "Technology, Information and Internet",
      "type": "Privately Held",
      "linkedin_url": "https://linkedin.com/company/19223256",
      "revenue": "500 THOUSAND USD - 1 MILLION USD",
      "employee_count": 6,
      "employee_count_range": "2-10",
      "address": "160 Robinson Road, #14-04 Singapore Business Federation Centre",
      "city": "Singapore",
      "country": "Singapore",
      "geo_area": "Singapore",
      "postal_code": "068914",
      "logo_url_primary": "https://logos.skrapp.io/company/19223256",
      "logo_url_secondary": "https://logos-cdn.skrapp.io/logos/skrapp.io"
    }
  ]
}

HTTP Request

URL

https://api.skrapp.io/company/search

Method

GET

HTTP Headers

X-Access-Key

******************************************

URL Query Attributes

Keyword of the company. Can either be a company name, domain or website.

Required

Text

JSON Response

Object

results

An array containing results of companies objects. Company object detailed below.

Array<Company>

Company

Object

name

Company name

Text

domain

Company domain name (E.G.: skrapp.io)

Text

website

Company website URL (E.G.: https://skrapp.io)

Text

industry

Company industry (E.G.: Information Technologies)

Text

type

Type of the company (E.G.: Private/Public)

Text

linkedin_url

Linkedin URL

Text

specialities

Company specialities.

Text

revenue

Estimated revenue of the company.

Text

employee_count

Exact number of employees working for the company.

Text

employee_count_range

Employee count range.

Text

address

Address of the headquarters

Text

city

City of the headquarters

Text

country

Country of the headquarters

Text

geo_area

Geographic area of the headquarters

Text

postal_code

Postal code of the headquarters

Text

crunchbase_url

Crunchbase.com URL

Text

logo_url_primary

Primary URL of the company logo provided by Skrapp.io logos API.

Text

logo_url_secondary

Fallback URL of the company logo provided by Skrapp.io logos API.

Text

Profile

Object

first_name

Lead’s first name.

Text

last_name

Lead’s last name.

Text

full_name

Lead’s full name.

Text

location

Lead’s location

Text

position

Lead’s position in the company.

Object

Lead’s email address.

Text

email_quality

Contains the verification status of the lead’s email address.

Object

Email Verifier

GET

The Email Verifier API endpoint enables you to verify email addresses programmatically. It provides detailed information on the validity status of an email, including syntax, format, and mailbox type. This helps ensure the accuracy and deliverability of emails, improving the success of your outreach efforts. For more details about the email verifier results, visit: http://skrapp.io/email-verifier

Email Verifier request example

curl "https://api.skrapp.io/api/v3/verify?email=john.doe@skrapp.io" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

Email Verifier JSON response

{
  "email": "john.doe@skrapp.io",
  "domain": "skrapp.io",
  "email_status": "catch-all",
  "message": "Email is reachable, but it's a catch-all address, and the recipient's existence is uncertain.",
  "format": "valid",
  "mailbox_status": "valid",
  "mailbox_type": "professional",
  "mailbox_exchange": "aspmx.l.google.com."
}

HTTP Request

URL

https://api.skrapp.io/v3/verify

Method

GET

HTTP Headers

X-Access-Key

******************************************

Content-Type

application/json

URL Query Attributes

The email attribute

Text

JSON Response

The email result

Text

domain

Domain of email

Text

email_status

The email verification status
For more information on Skrapp's email verification status terminology, visit this support article: Email verification statuses

Text

message

The verification response message

Text

format

The format which is either 'valid‘ or 'invalid‘, This represents a simple regex check of the input email.

Text

mailbox_type

The mailbox type specifies the email's usage: professional (company domain), temporary (disposable email), or webmail (free providers like Google or Yahoo).

Text

mailbox_exchange

The email exchange server for the input email domain, retrieved from the MX records. For more information about MX records, visit this wikipedia page

Text

Bulk Email Verifier

GET

The Bulk Email Verifier API endpoint allows you to verify emails in bulk programmatically. It takes input an array of emails from different domains as a param and returns their verification status object in an array.

Bulk Email Verifier request example

curl "https://api.skrapp.io/v3/verify_bulk?email=john.doe@skrapp.io,magnus@skrapp.io" 
 -H "X-Access-Key:Your API Key" 
 -H "Content-Type:application/json"

Bulk Email Verifier JSON response

[
  {
    "email": "john.doe@skrapp.io",
    "domain": "skrapp.io",
    "email_status": "catch-all",
    "message": "Email is reachable, but it's a catch-all address, and the recipient's\r\n existence is uncertain.",
    "format": "valid",
    "mailbox_status": "valid",
    "mailbox_type": "professional",
    "mailbox_exchange": "aspmx.l.google.com."
  },
  {
    "email": "johanna.doe@skrapp.io",
    "domain": "skrapp.io",
    "email_status": "catch-all",
    "message": "Email is reachable, but it's a catch-all address, and the recipient's \r\nexistence is uncertain.",
    "format": "valid",
    "mailbox_status": "valid",
    "mailbox_type": "professional",
    "mailbox_exchange": "aspmx.l.google.com."
  }
]

HTTP Request

URL

https://api.skrapp.io/api/v2/find_bulk

Method

GET

HTTP Headers

X-Access-Key

******************************************

Content-Type

application/json

Request Body Rules

Limit

URL Query Attributes

The email attribute

Array

JSON Response

Array [Verification Object]

The email address

Text

domain

Domain of email

Text

email_status

The email verification status
For more information on Skrapp's email verification status terminology, visit this support article: Email verification statuses

Text

message

The verification response message

Text

format

The format which is either 'valid‘ or 'invalid‘
This represents a simple regex check of the input email.

Text

mailbox_type

The mailbox type specifies the email's usage: professional (company domain), temporary (disposable email), or webmail (free providers like Google or Yahoo).

Text

mailbox_exchange

The email exchange server for the input email domain, retrieved from the MX records. For more information about MX records, visit this wikipedia page

Text

Lead generation

Email Finder

Lead Search

Bulk Email Finder

Company Search

Chrome Extension

LinkedIn Email Finder

Website Email Finder

Email Verification

Email Verifier

For Developers

API Documentation

Video tutorials

Blog

Help Center

Email Glossary

Sales Glossary

Companies Index

API Reference

API Features

API Categories

API Main URL

Authentication

Simple HTTP request with API key

Account Data

Account request example

Account JSON Response

List Data

List data request example

List data JSON Response

List Leads

List Leads request example

List Leads JSON Response

Email Finder

Email Finder request example

Email Finder JSON response

Bulk Email Finder

Bulk Email Finder request example

Bulk Email Finder JSON response

Company Profiles Search

Company Search request example

Company Search JSON response

Company Data Search

Company data search request example

Company Search JSON response

Email Verifier

Email Verifier request example

Email Verifier JSON response

Bulk Email Verifier

Bulk Email Verifier request example

Bulk Email Verifier JSON response