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:

Verification APIs:

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

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 enpoint 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

kw

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

Email

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

email

The email address

Text

quality

Contains the verification status of the email

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

email

The email attribute

Text

JSON Response

email

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

50

URL Query Attributes

email

The email attribute

Array

JSON Response

Array [Verification Object]

email

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

Skrapp logo

Skrapp.io: Your B2B Lead Generation Solution! Find verified business emails and enrich company data from LinkedIn and Sales Navigator effortlessly.

Skrapp Private Limited is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Microsoft or LinkedIn, or any of their subsidiaries or affiliates.
The name LinkedIn, as well as related names, marks, logos, emblems, and images are registered trademarks of their respective owners.

Copyright © 2024 by Skrapp.io. All rights reserved.