cocoonventures / hunterio

A Ruby wrapper around Hunter.io API V2

Hunter

A ruby wrapper around Hunter.io API. Direct access to all the web's email addresses.

Installation

Add this line to your application's Gemfile:

gem 'hunterio'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hunterio

Usage

require 'hunter'
hunter = Hunter.new('Your secret API key')

Your secret API key. You can generate it here (https://hunter.io/api_keys)

Domain Search API

Returns all the email addresses found using one given domain name, with our sources.

response = hunter.domain_search('stripe.com')

Accessing response

response.status
response.webmail
response.emails
response.pattern

Email Verifier API

Allows you to verify the deliverability of an email address.

response = hunter.email_verifier('[e-mail]')

Accessing response

response.status
response.result
response.score
response.regexp
response.gibberish
response.disposable
response.webmail
response.mx_records
response.smtp_server
response.smtp_check
response.accept_all
response.sources

Email Finder API

Guesses the most likely email of a person from his first name, his last name and a domain name.

response = hunter.email_finder('Vincenzo', 'Ruggiero', {domain: 'prospect.io', company: 'Prospect.io'})

Accessing response

response.status
response.email
response.score
response.domain

Email Count API

Returns the number of email addresses found for a domain. This is a FREE API call.

response = hunter.email_count('prospect.io')

Accessing count response

response.status
response.total
response.personal_emails
response.generic_emails

License

The Hunter GEM is released under the MIT License.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Credits

This gem is inspired by the emailhunter gem made by Davide Santangelo