kadoa_sdk 0.20.0

Official Kadoa SDK for Python - Web data extraction and automation

Kadoa SDK for Python

Official Python SDK for the Kadoa API, providing easy integration with Kadoa's web data extraction platform.

Installation

We recommend using uv, a fast and modern Python package manager:

uv add kadoa-sdk
# or
uv pip install kadoa-sdk

Alternatively, you can use traditional pip:

pip install kadoa-sdk

Requirements: Python 3.12 or higher

Quick Start

from kadoa_sdk import KadoaClient, KadoaClientConfig
from kadoa_sdk.extraction.types import ExtractionOptions

client = KadoaClient(
    KadoaClientConfig(
        api_key='your-api-key'
    )
)

# AI automatically detects and extracts data
result = client.extraction.run(
    ExtractionOptions(
        urls=['https://sandbox.kadoa.com/ecommerce'],
        name='My First Extraction'
    )
)

print(f"Extracted {len(result.data)} items")

That's it! With the SDK, data is automatically extracted. For more control, specify exactly what fields you want using the builder API.

Realtime WebSockets

realtime = await client.connect_realtime()
realtime.on_event(lambda event: print("Event:", event))
realtime.on_connection(
    lambda connected, reason=None: print("Connection:", connected, reason)
)

The SDK reconnects automatically when the realtime service drains a socket during deploys. When the server includes _cursor on events, the client resumes with lastCursor on the replacement subscribe and suppresses overlap duplicates by event["id"].

Documentation

For comprehensive documentation, examples, and API reference, visit:

• Full Documentation - Complete guide with examples
• API Reference - Detailed API documentation
• GitHub Examples - Working code examples

Requirements

• Python 3.12 or higher
• Dependencies are automatically installed

Support

• Documentation: docs.kadoa.com
• Support: [e-mail]
• Issues: GitHub Issues

License

MIT