Metadata-Version: 2.4
Name: supacrawlx
Version: 0.1.0
Summary: Official Python SDK for SupaCrawlX — extract transcripts, metadata, and structured data from any URL.
License: MIT
Project-URL: Homepage, https://supacrawlx.com
Project-URL: Documentation, https://supacrawlx.com/docs
Project-URL: Repository, https://github.com/supacrawlx/supacrawlx-python
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.28.0

# supacrawlx

Official Python SDK for [SupaCrawlX](https://supacrawlx.com) — extract transcripts, metadata, and structured data from YouTube, TikTok, Instagram, X (Twitter), Facebook, and any web URL.

## Install

```bash
pip install supacrawlx
```

Requires Python 3.8+.

## Quickstart

```python
from supacrawlx import Client

client = Client(api_key="YOUR_API_KEY")

# Universal transcript (auto-detects the platform from the URL)
transcript = client.transcript("https://youtu.be/dQw4w9WgXcQ")
print(transcript)

# Metadata for any supported URL
meta = client.metadata("https://youtu.be/dQw4w9WgXcQ")
```

## Resource groups

The client exposes one method per area:

- `client.youtube` — transcript, search, channel, playlist, batch
- `client.web` — scrape, crawl, map
- `client.video` — analyze
- `client.jobs` — poll async jobs (e.g. crawls)
- `client.transcript(url)` / `client.metadata(url)` — universal helpers

## Configuration

```python
client = Client(
    api_key="YOUR_API_KEY",
    base_url="https://api.supacrawlx.com",  # default
    timeout=30,                              # seconds
)
```

## Error handling

```python
from supacrawlx import APIError, RateLimitError, InsufficientCreditsError

try:
    client.transcript("https://youtu.be/bad")
except APIError as e:
    print(e)
```

Full reference: https://supacrawlx.com/docs

License: MIT
