Making an API Call

You are here


Making an API Call

Making an API call is really easy. All you need is:

  • An Email Address to clean (email)
  • Your API Key (api_key)

There are 2 main APIs both take exactly the same parameters as either POST or GET data:

DEEP CLEAN: https://api.listwisehq.com/clean/deep.php

The deep clean API does the FULL ListWise cleaning processing.
The same level of thorough cleaning as when you upload email lists into the application.
This API will cost you 1 Credit for each unique email request (however, calling the API again with an email that has already been through the API or through the application will be Free)

QUICK CLEAN: https://api.listwisehq.com/clean/quick.php

The quick clean API is 100% FREE (as long as you have an active ListWise account with at least 1 credit available). This API is guaranteed to give you a result within 1000ms so is excellent for any place where you need a near instant validation of an email.
The quick clean API current performs the following email checks:
Address syntax and RFC checks, Domain checks (DNS and MX Servers), Typo fixing, Spam-trap checking, Free-mail checking and No-reply checking

Both APIs return JSON format with the following fields:

Field Value
email The email address being cleaned (may be different from the original email passed in for example if typo's have been fixed)
email_status
invalid - This address is invalid (fails syntax or RFC checks)
no-reply - This address is not expected to receive any reply emails
spam-trap - This address has been detected as a spam-trap
bad-mx - The mail server is not present or is not configured correctly
bounced - This address does not exist and will bounce back
catch-all - The mail server accepts both fake and real addresses
suspicious - This address has been rejected or deferred after multiple checks without a confirmed result. It may bounce
unknown - The mail server returns an unexpected result. This address may bounce
clean - This address is clean
processing - This address is currently being processed, you should check back again within 5-10 minutes
free_mail yes / no: this address is a free-mail address
typo_fixed yes / no: this address has had typo's fixed
error_code 1: Not enough parameters
2: Invalid user
3: No credits available
4: API communication error
error_msg error message matching the error_code

Example API Call (Quick Clean):

https://api.listwisehq.com/clean/quick.php?email=someone@example.com&api_key=YourApiKey

Example API Call (Deep Clean):

https://api.listwisehq.com/clean/deep.php?email=someone@example.com&api_key=YourApiKey

Example API Response:

{"email":"someone@example.com","email_status":"clean","free_mail":"no","typo_fixed":"no"}

Q. Is there any kind of throttle on the APIs?

A. One simultaneous connection per IP.



Tags: 

ListWise Logo White

ListWise is brought to you by CyberCom
CyberCom Logo White

Our Privacy Policy
Terms of Service

About

ListWise is the world's simplest and most accurate email list cleaning solution. ListWise intelligently cleans your list, validating every email, getting rid of duplicates and potential bounces and gives you a clean, fresh list that you can then use for your email marketing efforts.

GET IN TOUCH

  • Email: support@cybercomglobal.com
  • Phone Numbers:
    • Intl: +64 9 309 8288
    • AU: +61 2 9098 8405
    • CA: +1 604 259 1329
    • UK: +44 20 3670 2364
    • US: +1 929 229 4855
    • NZ Freephone: 0800 121 131
  • Level 3, 99 Queen Street,
    Auckland, 1010, New Zealand