API Reference
Skrapp API is built aroundREST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We supportcross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code).JSON is returned by all API responses, including errors.
API Main URL
All of our API endpoints are HTTPS secured. HTTP requests are rejected.
https://api.skrapp.io
Authentication
In order to reach our API endpoints, you need to authenticate using your API keyYour API Key goes here
which you must include in your HTTP request header "X-Access-Key".
Authentication to the API is performed viaHTTP Basic Auth.
Your API key serves for authentication and identification, you should keep it secret.
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.
Email Finder
The Email Finder API endpoint allows you to find emails programmatically. It returns an email based on a first name, last name and a domain name.
HTTP Request
URL
Method
GET
HTTP Headers
X-Access-Key
Your API key
Content-Type
application/json
URL Query Attributes
firstName
Text
lastName
Text
domain
The domain name of the company. Example: skrapp.io. This attribute is case-insensitiveText
JSON ResponseObject
pattern
The email pattern related to the domainText
accuracy
The accuracy of the emailNumber
quality
Contains the verification status of the emailObject
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",
"pattern": "{first}.{last}",
"accuracy": 98
}
Bulk Email Finder
The Bulk Email Finder API endpoint allows you to find emails in bulk programmatically. It takes as a request body, an array of names and companies, and returns an array of emails along with complementary data.
HTTP Request
URL
Method
POST
HTTP Headers
X-Access-Key
Your API key
Content-Type
application/json
Request Body Rules
Limit
100
Request BodyArray of the below Object
firstName
Text
lastName
Text
domain
The domain name of the company. Example: skrapp.io. This attribute is case-insensitiveText
JSON ResponseArray of the below Object
firstName
Text
lastName
Text
name
Text
company
Text
email
Text
quality
Contains the verification status of the emailObject
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": "jdoe@salesforce.com",
"quality": {
"status": "oka"
}
}
]
Company Search
The Company Search API endpoint allows you to find people working in any company and look up their professional email addresses.
HTTP Request
URL
Method
GET
HTTP Headers
X-Access-Key
Your API key
URL Query Attributes
title
Job title keywordOptionalText
location
Geographic location keywordOptionalText
size
The number of leads to returnNumberMaximum: 150
companyName
The name of the company. Example: Skrapp. This attribute is case-insensitiveText
companyWebsite
The website of the company. Example: https://skrapp.ioText
nextId
Next results’ ID in pagination. ID is returned with every query in the meta objectText
JSON ResponseObject
meta
Search results meta dataMeta Object
company
Search results company dataCompany Object
results
An array containing results returned by your queryArray<Profile>
MetaObject
total_all
Overall total results available in databaseNumber
last_name
Total results returned in queryNumber
next_results_id
ID to get next results in pagination. To be put in nextId query parameterText
CompanyObject
name
Company nameText
domain
Company domainText
website
Company website URLText
industry
Company industryText
type
Type of the company (Private/Public)Text
linkedin_url
Linkedin URLText
specialities
Company specialities.Text Array
revenue
Estimated revenue of the companyText
employee_count
Exact number of employeesNumber
employee_count_range
Employee count rangeText
address
Address of the headquartersText
city
City of headquartersText
country
Country of headquartersText
geo_area
Geographic areaText
postal_code
Postal codeText
crunchbase_url
Crunchbase.com URLText
logo_url_primary
Skrapp.io logos api endpoint primaryText
logo_url_secondary
Skrapp.io logos api endpoint secondaryText
ProfileObject
first_name
Lead’s first nameText
last_name
Lead’s last nameText
full_name
Lead’s full nameText
location
Lead’s locationText
position
Lead’s positionObject
email
Lead’s email addressText
email_quality
Contains the verification status of the lead’s email addressObject
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_results": 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",
"specialities": [
"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"
}
}
]
}
Account Data
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, email credits and your lists names and IDs.
HTTP Request
URL
Method
GET
HTTP Headers
X-Access-Key
Your API key
JSON Response
package
Your current plan or packageText
packageRDate
Your monthly subscription renewal date OR your package expiry date. This depends on your type of enrollment (Monthly OR One Time Purchase).Timestamp
credit
Your current credits. Used credits and total quotaObject
options
Your account privileges and optionsObject
lists
Your lists information. This attribute does not return your lists data. Another resource is dedicated to thisArray
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
{
"name": "John Doe",
"email": "john.doe@skrapp.io",
"package": "Enterprise plan",
"packageRDate": 1507089600000,
"credit": {
"email": {
"quota": 20000,
"used": 1000
}
},
"options": {
"csv_import": true
},
"lists": [
{
"id": 1,
"name": "List 1",
"path": "/app/list/1"
},
{
"id": 2,
"name": "List 2",
"path": "/app/list/2"
}
]
}
List Data
The list data endpoint allows you to retrieve all the metadata related to one of your lists. This endpoint does not return the leads saved in your list.
HTTP Request
URL
Method
GET
URL Parameters
listId (/:listId/)
The ID of the listRequired
HTTP Headers
X-Access-Key
Your API key
JSON Response
list_id
The ID of your listNumber
name
The name of your listText
creation_date
The creation date and time of your listDatetime
count_leads
The number of leads saved in your listNumber
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": 10000,
"name": "My List",
"creation_date": "2020-07-16T18:34:27.325Z",
"count_leads": 75
}
List Leads
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.
HTTP Request
URL
Method
GET
URL Parameters
listId (/:listId/)
The ID of the listRequired
URL Query Attributes
start
The maximum value of the leads ID field. This ID is not inclusive
OptionalNumberDefault: ID of most recent leadsize
The number of leads to return
OptionalNumberDefault: 25Maximum: 500kw
A text keyword filter applied to the name, email, title, company website, and company name fieldOptionalText
HTTP Headers
X-Access-Key
Your API key
JSON Response
count_results
The overall number of results if a keyword is providedNumber
next_start
The value of the "start" query paramater for the next queryNumber
data
An array containing the leads returned by your queryArray
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": 1000,
"next_start": 100,
"data": [
{
"id": 1,
"name": "John Doe",
"first_n": "John",
"last_nd": "Doe",
"email": "john@example.com",
"email_status": "ok",
"linkedin_url": "linkedin.com/in/john-doe",
"location": "Delaware, US",
"domain": "example.com",
"company_industry": "Internet",
"compnay_founded": "2020",
"company_size": 50,
"company_hq": "Delaware, US"
}
]
}