Skip to main content

Clearbit python bindings

Project description

# Clearbit

A Python API client to [https://clearbit.com](https://clearbit.com).

## Installation

To install the Clearbit Python bindings, run:

pip install clearbit

Or

easy_install clearbit

## Usage

First authorize requests by setting the API key found on your [account’s settings page](https://clearbit.com/keys).

`python import clearbit clearbit.key = 'mykey' `

You can also set the API key via the CLEARBIT_KEY environment variable.

Then you can lookup people by email address. If the email’s domain is corporate we’ll also return a company response.

`python response = clearbit.Enrichment.find(email='alex@clearbit.com',stream=True) `

See the [documentation](https://clearbit.com/docs#person-api) for more information.

## Company lookup

You can lookup company data by domain name:

`python company = clearbit.Company.find(domain='uber.com',stream=True) `

If the company can’t be found, then None will be returned.

See the [documentation](https://clearbit.com/docs#company-api) for more information.

## Testing

Set the PYTHONPATH env var to the current directory to load the library locally:

export PYTHONPATH=.

## Deploy

python setup.py sdist upload -r pypi

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clearbit-0.1.7.tar.gz (5.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page