API Reference

Skrapp API is built around REST. 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 support cross-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 key {Your API Key goes here} which you must include in your HTTP request header "X-Access-Key".

Authentication to the API is performed via HTTP 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 goes here}" \
          -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.

URL Query Attributes
  • firstName

    First name of your lead. Example: John. This attribute is case-insensitive. Text

  • lastName

    Last name of your lead. Example: Doe. This attribute is case-insensitive. Text

  • domain

    The domain name of the company. Example: skrapp.io. This attribute is case-insensitive. Text

HTTP Headers
  • X-Access-Key

    Your API key.

JSON Response
  • pattern

    The email pattern related to the domain. Text

  • accuracy

    The accuracy of the email. Number

  • quality

    Email verifier results. Object

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 goes here}" \
          -H "Content-Type:application/json"
          

Email Finder JSON response

{
    "email": "john.doe@skrapp.io",
    "pattern": "{first}.{last}",
    "accuracy": 98
  }

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 Headers
  • X-Access-Key

    Your API key.

JSON Response
  • package

    Your current plan or package. Text

  • 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 quota. Object

  • options

    Your account privileges and options. Object

  • lists

    Your lists information. This attribute does not return your lists data. Another resource is dedicated to this. Array

Account request example

curl "https://api.skrapp.io/api/v2/account" \
              -H "X-Access-Key:{Your API Key goes here}" \
              -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.

URL Parameters
  • listId (/:listId/)

    The ID of the list. Required

HTTP Headers
  • X-Access-Key

    Your API 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. Number

List data request example

curl "https://api.skrapp.io/api/v2/list/:listId" \
              -H "X-Access-Key:{Your API Key goes here}" \
              -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.

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.
    Optional Number Default: 25 Maximum: 500

  • kw

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

HTTP Headers
  • X-Access-Key

    Your API 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

Account request example

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

Account JSON Response

{
            "count_results": 1000,
            "next_start": 2500,
            "data":[
                {
                    "id":2500,
                    "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"
                }
            ]
  }

Status Codes

Skrapp uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with Skrapp's servers.

HTTP status code summary

200 - OK Everything worked as expected.
400 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid API key provided.
402 - Request Failed The parameters were valid but the request failed.
404 - Not Found The requested resource doesn't exist.
409 - Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
429 - Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 - Server Errors