AD-SearchAPI 2.0.0

A comprehensive Python client library for the Search API with enhanced error handling and balance management

Search API Python Client v2.0

A comprehensive Python client library for the Search API with enhanced error handling, balance management, and improved data processing. Acquire your API key through @ADSearchEngine_bot on Telegram.

🚀 New in v2.0

• Enhanced Balance Management: Automatic balance checking before operations
• Access Logs Integration: Retrieve and analyze API access logs
• Improved Error Handling: Comprehensive exception hierarchy with detailed error messages
• Advanced Caching: Configurable response caching with TTL
• Better Data Models: Enhanced data structures with metadata
• Context Manager Support: Automatic resource cleanup
• Comprehensive Validation: Input validation for all search types
• Multiple Phone Formats: Support for international, national, and E164 formats
• Batch Operations: Efficient handling of multiple searches
• Debug Mode: Detailed logging for troubleshooting

📦 Installation

pip install AD-SearchAPI

⚡ Quick Start

from search_api import SearchAPI, InsufficientBalanceError

# Initialize the client
client = SearchAPI(api_key="your_api_key")

try:
    # Check balance first
    balance = client.get_balance()
    print(f"Current balance: {balance}")
    
    # Get access logs
    access_logs = client.get_access_logs()
    print(f"Total access log entries: {len(access_logs)}")
    
    # Search by email
    result = client.search_email(
        "[e-mail]",
        include_house_value=True,
        include_extra_info=True
    )
    
    print(f"Name: {result.person.name if result.person else 'N/A'}")
    print(f"Total results: {result.total_results}")
    print(f"Search cost: ${result.search_cost}")
    
    for addr in result.addresses:
        print(f"Address: {addr}")
        if addr.zestimate:
            print(f"  Zestimate: ${addr.zestimate:,.2f}")
    
except InsufficientBalanceError as e:
    print(f"Insufficient balance: {e}")
    print(f"Current: {e.current_balance}, Required: {e.required_credits}")

🔧 Advanced Configuration

from search_api import SearchAPI, SearchAPIConfig

config = SearchAPIConfig(
    api_key="your_api_key",
    debug_mode=True,           # Enable debug logging
    enable_caching=True,       # Enable response caching
    cache_ttl=1800,           # 30 minutes cache
    max_cache_size=500,       # Maximum cache entries
    timeout=120,              # 2 minutes timeout
    max_retries=5,           # Retry failed requests
    proxy={                   # Optional proxy
        "http": "http://proxy:8080",
        "https": "https://proxy:8080"
    }
)

client = SearchAPI(config=config)

💰 Balance Management

The client automatically checks your account balance before making requests:

from search_api import InsufficientBalanceError

try:
    # Get current balance
    balance = client.get_balance()
    print(f"Balance: {balance.current_balance} {balance.currency}")
    print(f"Cost per search: {balance.credit_cost_per_search}")
    
    # Check if you have enough for multiple searches
    required_credits = 10
    if balance.current_balance < required_credits:
        print(f"⚠️  Insufficient balance for {required_credits} searches")
    else:
        print(f"✅ Sufficient balance for {required_credits} searches")
        
except InsufficientBalanceError as e:
    print(f"❌ Insufficient balance: {e}")
    print(f"   Current: {e.current_balance}")
    print(f"   Required: {e.required_credits}")

📊 Access Logs

Retrieve and analyze your API access logs:

# Get all access logs
access_logs = client.get_access_logs()

print(f"Total access log entries: {len(access_logs)}")

# Show recent activity
for log in access_logs[:5]:
    print(f"IP: {log.ip_address}")
    print(f"Last accessed: {log.last_accessed}")
    print(f"Endpoint: {log.endpoint}")
    print(f"Status: {log.status_code}")
    print(f"Response time: {log.response_time:.3f}s")
    print("---")

# Analyze access patterns
unique_ips = set(log.ip_address for log in access_logs)
print(f"Unique IP addresses: {len(unique_ips)}")

# Find most active IP
ip_counts = {}
for log in access_logs:
    ip_counts[log.ip_address] = ip_counts.get(log.ip_address, 0) + 1

most_active_ip = max(ip_counts.items(), key=lambda x: x[1])
print(f"Most active IP: {most_active_ip[0]} ({most_active_ip[1]} accesses)")

🔍 Search Operations

Email Search

result = client.search_email(
    "[e-mail]",
    include_house_value=True,
    include_extra_info=True,
    phone_format="international"  # or "national", "e164"
)

print(f"Email: {result.email}")
print(f"Valid: {result.email_valid}")
print(f"Type: {result.email_type}")

if result.person:
    print(f"Name: {result.person.name}")
    print(f"DOB: {result.person.dob}")
    print(f"Age: {result.person.age}")

for addr in result.addresses:
    print(f"Address: {addr}")
    if addr.zestimate:
        print(f"  Zestimate: ${addr.zestimate:,.2f}")

for phone in result.phone_numbers:
    print(f"Phone: {phone.number}")
    print(f"  Valid: {phone.is_valid}")
    print(f"  Type: {phone.phone_type}")
    print(f"  Carrier: {phone.carrier}")

Phone Search

results = client.search_phone(
    "[phone]",
    include_house_value=True,
    include_extra_info=True,
    phone_format="international"
)

for result in results:
    print(f"Phone: {result.phone.number}")
    print(f"Valid: {result.phone.is_valid}")
    print(f"Type: {result.phone.phone_type}")
    print(f"Carrier: {result.phone.carrier}")
    
    if result.person:
        print(f"Name: {result.person.name}")
        print(f"DOB: {result.person.dob}")
    
    print(f"Total results: {result.total_results}")
    print(f"Search cost: ${result.search_cost}")

Domain Search

result = client.search_domain("example.com")

print(f"Domain: {result.domain}")
print(f"Valid: {result.domain_valid}")
print(f"Total results: {result.total_results}")
print(f"Search cost: ${result.search_cost}")

for email_result in result.results:
    print(f"Email: {email_result.email}")
    print(f"Valid: {email_result.email_valid}")
    print(f"Type: {email_result.email_type}")
    
    if email_result.person:
        print(f"Name: {email_result.person.name}")

🛡️ Error Handling

The library provides comprehensive error handling with specific exception types:

from search_api import (
    SearchAPIError,
    AuthenticationError,
    ValidationError,
    InsufficientBalanceError,
    RateLimitError,
    ServerError,
    NetworkError,
    TimeoutError,
    ConfigurationError
)

try:
    result = client.search_email("[e-mail]")
except ValidationError as e:
    print(f"Invalid input: {e}")
except InsufficientBalanceError as e:
    print(f"Insufficient balance: {e}")
    print(f"Current: {e.current_balance}, Required: {e.required_credits}")
except AuthenticationError as e:
    print(f"Authentication failed: {e}")
except RateLimitError as e:
    print(f"Rate limit exceeded: {e}")
except ServerError as e:
    print(f"Server error: {e}")
except NetworkError as e:
    print(f"Network error: {e}")
except TimeoutError as e:
    print(f"Request timeout: {e}")
except SearchAPIError as e:
    print(f"API error: {e}")

🔄 Caching

The client supports configurable response caching:

# Enable caching with custom settings
config = SearchAPIConfig(
    api_key="your_api_key",
    enable_caching=True,
    cache_ttl=3600,      # 1 hour
    max_cache_size=1000   # Maximum 1000 cached responses
)

client = SearchAPI(config=config)

# Cache is automatically used for repeated searches
result1 = client.search_email("[e-mail]")  # Cached
result2 = client.search_email("[e-mail]")  # From cache

# Clear cache when needed
client.clear_cache()

🧹 Context Manager

Use the client as a context manager for automatic resource cleanup:

with SearchAPI(api_key="your_api_key") as client:
    balance = client.get_balance()
    result = client.search_email("[e-mail]")
    # Resources automatically cleaned up when exiting context

📊 Data Models

Address Model

@dataclass
class Address:
    street: str
    city: Optional[str] = None
    state: Optional[str] = None
    postal_code: Optional[str] = None
    country: Optional[str] = None
    zestimate: Optional[Decimal] = None
    zpid: Optional[str] = None
    bedrooms: Optional[int] = None
    bathrooms: Optional[float] = None
    living_area: Optional[int] = None
    home_status: Optional[str] = None
    last_known_date: Optional[date] = None

Person Model

@dataclass
class Person:
    name: Optional[str] = None
    dob: Optional[date] = None
    age: Optional[int] = None

PhoneNumber Model

@dataclass
class PhoneNumber:
    number: str
    country_code: str = "US"
    is_valid: bool = True
    phone_type: Optional[str] = None
    carrier: Optional[str] = None

BalanceInfo Model

@dataclass
class BalanceInfo:
    current_balance: float
    currency: str = "USD"
    last_updated: Optional[datetime] = None
    credit_cost_per_search: Optional[float] = None

AccessLog Model

@dataclass
class AccessLog:
    ip_address: str
    last_accessed: Optional[datetime] = None
    user_agent: Optional[str] = None
    endpoint: Optional[str] = None
    method: Optional[str] = None
    status_code: Optional[int] = None
    response_time: Optional[float] = None

🔧 Configuration Options

SearchAPIConfig

Parameter	Type	Default	Description
api_key	str	Required	Your API key
base_url	str	"https://search-api.dev/index.php"	API base URL
max_retries	int	3	Maximum retry attempts
timeout	int	90	Request timeout in seconds
debug_mode	bool	False	Enable debug logging
enable_caching	bool	True	Enable response caching
cache_ttl	int	3600	Cache time-to-live in seconds
max_cache_size	int	1000	Maximum cache entries
proxy	Dict	None	Proxy configuration
user_agent	str	Chrome UA	Custom user agent

📝 Examples

See the examples/ directory for comprehensive usage examples:

• basic_usage.py - Basic search operations, balance checking, and access logs
• advanced_usage.py - Advanced features like caching, batch operations, and access log analysis

🤝 Contributing

Contributions are welcome! Please submit a Pull Request with your changes or open an issue for discussion.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.