Skip to main content

Python SDK for the Revenuebase Email Verification and Company Resolver API.

Project description

Revenuebase Python SDK

Python SDK for the Revenuebase API — email verification, organization resolution, and batch job management.

Requirements

  • Python ≥ 3.8

Install

pip install revenuebase-sdk

Quickstart

from revenuebase_sdk import RevenuebaseClient

client = RevenuebaseClient(api_key="your-api-key")
# Or set REVENUEBASE_API_KEY in your environment and call RevenuebaseClient()

# Verify a single email
result = client.email.verify(email="user@acme.com")
print(result.status)  # "Valid", "Invalid", or "Unknown"

# With full metadata
result = client.email.verify(email="user@acme.com", metadata=True)
print(result.mx_record_present, result.email_provider)

# Check your credit balance
usage = client.account.balance()
print(usage.credits)

Authentication

Pass your API key via the api_key parameter or the REVENUEBASE_API_KEY environment variable. The key is sent as the x-key header on every request.

export REVENUEBASE_API_KEY="your-api-key"

Resources

account

Method Description
balance() Get your remaining credit balance.
rotate_api_key() Generate a new API key (invalidates the previous one immediately).

email

Method Description
verify(*, email, metadata=False) Verify a single email. Returns Valid, Invalid, or Unknown. Rate limited to 5 req/s.
batch_upload(*, file, filename, metadata=False) Upload a .csv or .json file for async batch verification.

jobs

Method Description
list() List all active (queued or processing) batch jobs.
get(*, process_id) Get the status of a batch job.
cancel(*, process_id) Cancel a queued or in-progress batch job.
download(*, process_id) Download the results of a completed job as bytes.

organization

Method Description
resolve(*, company_name, result_count=3, ...) Match an organization name to verified records using semantic search.
discover(*, keyword, result_count=1000, ...) Discover organizations matching a keyword or description.

Both methods accept optional headquarter filters: headquarters_country, headquarters_state, headquarters_city, headquarters_street, headquarters_zip.

Batch verification workflow

import time

# 1. Upload the file
with open("emails.csv", "rb") as f:
    job = client.email.batch_upload(file=f, filename="emails.csv")

print(f"Job {job.process_id} queued")

# 2. Poll until complete
while True:
    status = client.jobs.get(process_id=job.process_id)
    print(status.current_status)
    if status.current_status in ("COMPLETED", "ERROR", "CANCELLED"):
        break
    time.sleep(5)

# 3. Download results
if status.current_status == "COMPLETED":
    data = client.jobs.download(process_id=job.process_id)
    with open("results.csv", "wb") as f:
        f.write(data)

Organization resolution

# Match by name
result = client.organization.resolve(
    company_name="Stripe",
    result_count=3,
    headquarters_country="US",
)
for org in result.companies:
    print(org.company_name, org.similar_score, org.headquarters_city)

# Discover by keyword
result = client.organization.discover(
    keyword="enterprise cybersecurity SaaS",
    result_count=100,
    headquarters_country="US",
)

Async usage

import asyncio
from revenuebase_sdk import AsyncRevenuebaseClient

async def main():
    async with AsyncRevenuebaseClient(api_key="your-api-key") as client:
        result = await client.email.verify(email="user@acme.com")
        print(result.status)

asyncio.run(main())

Error handling

from revenuebase_sdk import (
    AuthenticationError,
    BadRequestError,
    RateLimitError,
    APIConnectionError,
)

try:
    result = client.email.verify(email="user@acme.com")
except AuthenticationError:
    print("Invalid API key")
except BadRequestError as e:
    print(f"Bad request: {e.message}")
except RateLimitError:
    print("Rate limited — slow down requests")
except APIConnectionError as e:
    print(f"Network error: {e.message}")

Per-request options

# Override timeout for a single call
result = (
    client
    .with_options(timeout=5.0, max_retries=0)
    .email.verify(email="user@acme.com")
)

Migrating from v1

All v1 endpoints are still accessible under client.v1 but are deprecated and will be retired on July 7, 2026. Every call emits a DeprecationWarning at runtime.

v1 (deprecated) v2 replacement
client.user_operations.get_credits() client.account.balance()
client.user_operations.rotate_api_key() client.account.rotate_api_key()
client.email_processing.validate_email(email=...) client.email.verify(email=...)
client.email_processing.batch_upload(...) client.email.batch_upload(...)
client.email_processing.get_batch_status(process_id=...) client.jobs.get(process_id=...)
client.email_processing.list_queued() client.jobs.list()
client.email_processing.cancel_batch(process_id=...) client.jobs.cancel(process_id=...)
client.email_processing.download_batch(process_id=...) client.jobs.download(process_id=...)
client.company_resolver.resolve(...) client.organization.resolve(...)
client.company_resolver.discover(...) client.organization.discover(...)

Development

pip install -e ".[dev]"
pytest
mypy src
ruff check src

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

revenuebase_sdk-0.2.0.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

revenuebase_sdk-0.2.0-py3-none-any.whl (34.0 kB view details)

Uploaded Python 3

File details

Details for the file revenuebase_sdk-0.2.0.tar.gz.

File metadata

  • Download URL: revenuebase_sdk-0.2.0.tar.gz
  • Upload date:
  • Size: 25.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for revenuebase_sdk-0.2.0.tar.gz
Algorithm Hash digest
SHA256 43f8baf9f7fa43fea87883e9239d64061a3ca9ec2786b95b2c42703fe56e6b63
MD5 38dc696642fc0e49ea0bb3e35b3084f7
BLAKE2b-256 03db4ffc50065523d9b8d6d26546de7150069eb3c4e08174537626cca733040c

See more details on using hashes here.

Provenance

The following attestation bundles were made for revenuebase_sdk-0.2.0.tar.gz:

Publisher: publish-pypi.yml on revenuebase/revenuebase-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file revenuebase_sdk-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: revenuebase_sdk-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 34.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for revenuebase_sdk-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80f6414c6d0334192e49df53d075f585d9a8e1582ace1f1f52098bddd2f3b9c7
MD5 a9b2a64d8d1d896ab58d0486d4a9d7cc
BLAKE2b-256 c5ab02f9a271a8f13b5abd86598329a9332a00df912f293bea89161d4433a50e

See more details on using hashes here.

Provenance

The following attestation bundles were made for revenuebase_sdk-0.2.0-py3-none-any.whl:

Publisher: publish-pypi.yml on revenuebase/revenuebase-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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