A Ruby API client to https://clearbit.com.
Add this line to your application's Gemfile:
gem 'clearbit'
And then execute:
$ bundle
Or install it yourself as:
$ gem install clearbit
First authorize requests by setting the API key found on your account's settings page.
Clearbit.key = ENV['CLEARBIT_KEY']
Then you can lookup people by email address:
person = Clearbit::Streaming::Person[email: '[email protected]']
If the person can't be found, then nil
will be returned.
See the documentation for more information.
You can lookup company data by domain name:
company = Clearbit::Streaming::Company[domain: 'uber.com']
If the company can't be found, then nil
will be returned.
See the documentation for more information.
The gem also includes a clearbit
executable, which you can use like this:
$ clearbit person --email [email protected]
{
"name": {
"fullName": "Alex MacCaw",
"givenName": "Alex",
"familyName": "MacCaw"
},
...
Or to look up a company:
$ clearbit company --domain uber.com
{
"name": "Uber",
"legalName": "Uber, Inc.",
"categories": [
"Transport"
],
"founders": [
"Travis Kalanick",
"Garrett Camp"
],
...
For rack apps use the Clearbit::Webhook
module to wrap deserialization and verify the webhook is from trusted party:
post '/v1/webhooks/clearbit' do
begin
webhook = Clearbit::Webhook.new(env)
webhook.type #=> 'person'
webhook.body.name.given_name #=> 'Alex'
# ...
rescue Clearbit::Errors::InvalidWebhookSignature => e
# ...
end
end