Skip to main content

Multi-signal email validation SDK. Detect fake signups, burner emails, and disposable domains.

Project description

BigShield Python SDK

Multi-signal email validation SDK. Detect fake signups, burner emails, and disposable domains.

Install

pip install bigshield

Quick Start

from bigshield import BigShield

client = BigShield("ev_live_your_api_key")

# Validate a single email
result = client.validate("user@example.com")
print(result.risk_score)    # 22
print(result.is_valid)      # True
print(result.recommendation)  # "accept"

# Check individual signals
for signal in result.signals:
    print(f"{signal.name}: {signal.score_impact} (confidence: {signal.confidence})")

Async Support

from bigshield import AsyncBigShield

client = AsyncBigShield("ev_live_your_api_key")
result = await client.validate("user@example.com")

Validate with Context

Pass additional context for stronger fraud detection:

result = client.validate(
    "user@example.com",
    wait=True,          # Wait for Tier 2 signals
    ip="203.0.113.1",   # Client IP
    fingerprint="fp_abc123",
    user_agent="Mozilla/5.0 ...",
)

Batch Validation

result = client.batch_validate([
    "alice@example.com",
    "bob@tempmail.com",
    "carol@gmail.com",
])

for r in result.results:
    print(f"{r.email}: {r.risk_score} ({r.recommendation})")

Error Handling

from bigshield import BigShield, AuthError, RateLimitError

client = BigShield("ev_live_your_api_key")

try:
    result = client.validate("user@example.com")
except AuthError:
    print("Invalid API key")
except RateLimitError as e:
    print(f"Rate limited. Retry after {e.retry_after}s")

Configuration

client = BigShield(
    "ev_live_your_api_key",
    base_url="https://bigshield.app",  # Custom base URL
    timeout=15.0,                       # Request timeout in seconds
    retries=3,                          # Number of retries on server errors
)

Documentation

Full API docs at bigshield.app/docs.

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

bigshield-1.0.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

bigshield-1.0.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file bigshield-1.0.0.tar.gz.

File metadata

  • Download URL: bigshield-1.0.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for bigshield-1.0.0.tar.gz
Algorithm Hash digest
SHA256 3392e773faf1e03b56b07b66fc4345b4b599d25aaac1e1aa495c3c0805b28b13
MD5 01ee5a99ae7c4c13017db0f536bc164a
BLAKE2b-256 3f371fe1559d21d726d1127ec64056d3bb193550f51a9089eb4fff33780168d7

See more details on using hashes here.

File details

Details for the file bigshield-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: bigshield-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for bigshield-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1f96bc5bb7a6562c207025d3d173c2460781d31b1c41a586b7f46e086da04a9
MD5 93ae73f65a9f85adde308e880b15c590
BLAKE2b-256 42d1d74435976d2f0fbb2682cb4a66f288a1032616cf804dcb5caaef2ce14af7

See more details on using hashes here.

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