Python Client

pip install evomi-client

import asyncio
from evomi_client import EvomiClient

async def main():
    # Initialize with API key (or set EVOMI_API_KEY env var)
    client = EvomiClient(api_key="your-api-key")
    
    # Scrape a URL
    result = await client.scrape("https://example.com")
    print(result["content"])

asyncio.run(main())

from evomi_client import EvomiClientSync

client = EvomiClientSync(api_key="your-api-key")
result = client.scrape("https://example.com")
print(result["content"])

export EVOMI_API_KEY="your-api-key"

client = EvomiClient(api_key="your-api-key")

result = await client.scrape(
    "https://example.com",
    mode="auto",           # "request", "browser", or "auto"
    output="markdown",     # "html", "markdown", "screenshot", "pdf"
    device="windows",      # "windows", "macos", "android"
    proxy_type="residential",
    proxy_country="US",
    proxy_session_id="abc123",
    wait_until="domcontentloaded",
    ai_enhance=True,
    ai_prompt="Extract product data",
    ai_source="markdown",
    js_instructions=[{"click": ".load-more"}],
    execute_js="window.scrollTo(0, document.body.scrollHeight)",
    wait_seconds=2,
    screenshot=False,
    pdf=False,
    excluded_tags=["nav", "footer"],
    excluded_selectors=[".ads"],
    block_resources=["image", "stylesheet"],
    additional_headers={"X-Custom": "value"},
    capture_headers=True,
    network_capture=[{"url_pattern": "/api/.*"}],
    async_mode=False,
    config_id="cfg_abc123",
    scheme_id="sch_abc123",
    extract_scheme=[{"label": "title", "type": "content", "selector": "h1"}],
    storage_id="stor_abc123",
    use_default_storage=False,
    
)

result = await client.crawl(
    domain="example.com",
    max_urls=100,
    depth=2,
    url_pattern="/products/.*",
    scraper_config={"mode": "browser", "output": "markdown"},
    async_mode=False,
)

result = await client.map_website(
    domain="example.com",
    sources=["sitemap", "commoncrawl"],
    max_urls=500,
    url_pattern="/products/.*",
    check_if_live=False,
    depth=1,
    async_mode=False,
)

# Single query
result = await client.search_domains(
    query="e-commerce platforms",
    max_urls=20,
    region="us-en",
)

# Multiple queries (up to 10)
result = await client.search_domains(
    query=["web scraping tools", "data extraction services"],
    max_urls=20,
    region="us-en",
)

result = await client.agent_request(
    "Scrape example.com and extract all product prices"
)

result = await client.get_task_status(
    task_id="abc123",
    task_type="scrape"  # "scrape", "crawl", "map", "config_generate", "schema"
)

configs = await client.list_configs(
    page=1,
    per_page=20,
    sort_by="created_at",
    sort_order="desc",
)

config = await client.create_config(
    name="Product Scraper",
    config={"mode": "browser", "output": "markdown"}
)

config = await client.get_config("cfg_abc123")

config = await client.update_config(
    "cfg_abc123",
    name="New Name",
    config={"mode": "request"}
)

await client.delete_config("cfg_abc123")

config = await client.generate_config(
    name="Amazon Scraper",
    prompt="Scrape product title and price from Amazon product pages"
)

schemas = await client.list_schemas(
    page=1,
    per_page=20,
    sort_by="created_at",
    sort_order="desc",
)

schema = await client.create_schema(
    name="Product Schema",
    config={
        "url": "https://example.com/product",
        "extract_scheme": [
            {"label": "title", "type": "content", "selector": "h1"},
            {"label": "price", "type": "content", "selector": ".price"}
        ]
    },
    test=True,
    fix=False,
)

schema = await client.get_schema("sch_abc123")

schema = await client.update_schema(
    "sch_abc123",
    name="Updated Schema",
    config={"url": "...", "extract_scheme": [...]},
    test=True,
)

await client.delete_schema("sch_abc123")

status = await client.get_schema_status("sch_abc123")

schedules = await client.list_schedules(
    page=1,
    per_page=20,
    active_only=False,
)

schedule = await client.create_schedule(
    name="Daily Price Check",
    config_id="cfg_abc123",
    interval_minutes=1440,  # Daily
    start_time="09:00",     # UTC
    stop_on_error=True,
)

schedule = await client.get_schedule("sched_abc123")

schedule = await client.update_schedule(
    "sched_abc123",
    name="New Name",
    interval_minutes=720,
)

await client.delete_schedule("sched_abc123")

await client.toggle_schedule("sched_abc123")

runs = await client.list_schedule_runs(
    "sched_abc123",
    page=1,
    per_page=20,
)

configs = await client.list_storage_configs()

# S3-compatible storage
storage = await client.create_storage_config(
    name="My S3",
    storage_type="s3_compatible",
    config={
        "bucket": "my-bucket",
        "region": "us-east-1",
        "access_key": "...",
        "secret_key": "...",
    },
    set_as_default=True,
)

# Google Cloud Storage
storage = await client.create_storage_config(
    name="My GCS",
    storage_type="gcs",
    config={
        "bucket": "my-bucket",
        "credentials_json": "...",
    },
)

# Azure Blob Storage
storage = await client.create_storage_config(
    name="My Azure",
    storage_type="azure_blob",
    config={
        "container": "my-container",
        "connection_string": "...",
    },
)

storage = await client.update_storage_config(
    "stor_abc123",
    name="Renamed Storage",
    set_as_default=True,
)

await client.delete_storage_config("stor_abc123")

data = await client.get_public_api()
# Returns proxy credentials and product information

data = await client.get_proxy_data()
# Returns: {"products": {"rp": {...}, "sdc": {...}, "mp": {...}}, ...}

options = await client.get_targeting_options()

data = await client.get_scraper_data()

data = await client.get_browser_data()

result = await client.rotate_session(
    session_id="abc12345",
    product="rp"  # "rpc", "rp", "sdc", "mp"
)

proxies = await client.generate_proxies(
    product="rp",
    countries="US,GB,DE",
    city="New York",
    session="sticky",
    amount=10,
    protocol="http",
    lifetime=30,
    adblock=True,
)
# Returns plain text, one proxy per line

info = await client.get_account_info()
print(info.get("credits", "N/A"))

from evomi_client import WebhookConfig

# Discord webhook
webhook = WebhookConfig(
    url="https://discord.com/api/webhooks/...",
    webhook_type="discord",
    events=["completed", "failed"]
)

# Custom webhook with HMAC signature
webhook = WebhookConfig(
    url="https://your-server.com/webhook",
    webhook_type="custom",
    events=["completed"],
    secret="your-secret-key"
)

from evomi_client import EvomiClient, WebhookConfig

client = EvomiClient(api_key="your-api-key")

webhook = WebhookConfig(
    url="https://discord.com/api/webhooks/...",
    webhook_type="discord",
    events=["completed", "failed"]
)

result = await client.scrape(
    "https://example.com",
    mode="browser",
    webhook=webhook
)

# With crawl
result = await client.crawl(
    domain="example.com",
    max_urls=100,
    webhook=webhook
)

# With map_website
result = await client.map_website(
    domain="example.com",
    webhook=webhook
)

# With search_domains
result = await client.search_domains(
    query="e-commerce platforms",
    webhook=webhook
)

schedule = await client.create_schedule(
    name="Daily Price Check",
    config_id="cfg_abc123",
    interval_minutes=1440,
    webhook=webhook
)

from evomi_client import EvomiClient, ProxyType, ProxyProtocol

client = EvomiClient(api_key="your-api-key")

# Build a proxy string for US residential proxy
proxy_string = await client.build_proxy_string(
    proxy_type=ProxyType.RESIDENTIAL,
    country="US",
    session="abc12345"
)
print(proxy_string)
# Output: http://user:[email protected]:1000

from evomi_client import ProxyConfig, ProxyType, ProxyProtocol

config = ProxyConfig(
    proxy_type=ProxyType.RESIDENTIAL,
    protocol=ProxyProtocol.HTTP,
    country="US",
    city="New York",
    username="your-username",
    password="your-password"
)

proxy_string = config.build_proxy_string()

import httpx

try:
    result = await client.scrape("https://example.com")
except httpx.HTTPStatusError as e:
    print(f"API error: {e.response.status_code}")
    print(f"Details: {e.response.text}")