DocsIntegrationsPlaygroundPricing
Get API Key
Python SDK

Python SDK

Official Python library for SupaCrawlX. Supports Python 3.8+ with full type hints and all API endpoints.

Installation

pip install supacrawlx

Quick Start

from supacrawlx import Client

client = Client("YOUR_API_KEY")

# Transcript
transcript = client.transcript("https://www.youtube.com/watch?v=dQw4w9WgXcQ")
print(transcript.text)

# Web scrape
page = client.web.scrape("https://example.com")
print(page.content)

All Methods

Transcripts

client.transcript(url, lang=None, mode="auto", timestamps=False)→ TranscriptResponse
client.youtube.transcript(url, lang=None, mode="auto")→ TranscriptResponse
client.youtube.batch_transcript(urls, lang=None)→ List[BatchTranscriptItem]

YouTube

client.youtube.search(q, limit=10)→ List[VideoResult]
client.youtube.channel(url_or_id)→ ChannelResponse
client.youtube.playlist(url_or_id)→ PlaylistResponse

Web

client.web.scrape(url, format="markdown")→ ScrapeResponse
client.web.crawl(url, max_pages=10)→ Job
client.web.map(url)→ MapResponse

Other

client.metadata(url)→ MetadataResponse
client.video.analyze(url, prompt=None, schema=None)→ Job
client.jobs.get(job_id)→ Job

Error Handling

from supacrawlx import Client, APIError

try:
    result = client.transcript("...")
except APIError as e:
    print(e.status_code, e.code, e.message)

Configuration

api_keystrYour SupaCrawlX API key (required)
base_urlstrAPI base URL (default: https://api.supacrawlx.com)
timeoutintRequest timeout in seconds (default: 30)