📚 Documentation & Examples
Everything you need to integrate with Hunter
🚀 Quick Start Examples
// Hunter API Example
const response = await fetch('https://hunter.io/api-documentation/v2', {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);Exploring the Hunter.io API Documentation
Hunter.io is a powerful tool that allows you to search for and verify email addresses on a large scale. The Hunter.io API is a great way to integrate this functionality into your own applications and tools, and this documentation will provide you with everything you need to get started.
How to Get a Hunter.io API Key
- Create a free account at https://hunter.io (email or Google sign-up).
- Open the API keys page: https://hunter.io/api-keys
- Copy your key (you can also generate or delete keys here).
- Pass it as the
api_keyquery parameter, or as anX-API-KEY/Authorization: Bearerheader. The base URL ishttps://api.hunter.io/v2/.
const res = await fetch(
`https://api.hunter.io/v2/domain-search?domain=example.com&api_key=YOUR_API_KEY`
);
const data = await res.json();
Free plan: The free tier includes 50 credits per month, shared across the API and the web app. A Domain Search or Email Finder call costs 1 credit; an Email Verification costs 0.5 credits. There's also a test-api-key you can use to try requests without spending credits. Paid plans raise the monthly allowance — see https://hunter.io/pricing for current limits.
Searching for Email Addresses
One of the key features of Hunter.io is its ability to search for email addresses associated with a particular domain. Here's an example of how to use the API to do this:
const fetch = require('node-fetch');
const domain = 'example.com';
const apiKey = 'your_api_key';
fetch(`https://api.hunter.io/v2/domain-search?domain=${domain}&api_key=${apiKey}`)
.then(res => res.json())
.then(data => {
console.log(data);
})
.catch(err => {
console.error(err);
});
In this example, we're using the node-fetch package to make an HTTP request to the Hunter.io API. We pass in our API key and the domain we're interested in, and the API will return a JSON object containing information about all the email addresses associated with that domain.
Verifying Email Addresses
Another useful feature of Hunter.io is its ability to verify email addresses to ensure that they're valid and active. Here's an example of how to use the API to do this:
const fetch = require('node-fetch');
const email = 'john.doe@example.com';
const apiKey = 'your_api_key';
fetch(`https://api.hunter.io/v2/email-verifier?email=${email}&api_key=${apiKey}`)
.then(res => res.json())
.then(data => {
console.log(data);
})
.catch(err => {
console.error(err);
});
This example is very similar to the previous one, but instead of passing in a domain, we're passing in an email address. The API will return a JSON object containing information about that email address, including whether or not it's a valid and active email address.
Conclusion
The Hunter.io API is a powerful tool that can be used to search for and verify email addresses on a large scale. With the examples provided in this blog post, you should be well on your way to integrating the API into your own applications and tools. If you have any questions or need further assistance, be sure to refer to the comprehensive documentation provided by Hunter.io.
