Getting Started
Introduction
SupaCrawlX is a single API for turning the messy web into clean, structured data. Point it at a video, a social post, or any web page and get back transcripts, metadata, and machine-readable content — ready to drop straight into your AI pipelines, automations, and data products.
What you can build
The API is organized into four capabilities. Use them on their own or combine them — they share one base URL, one API key, and the same JSON response style.
Video Transcripts
Pull accurate transcripts from YouTube, TikTok, Instagram, Facebook, X, and raw video files — with optional timestamps and automatic language detection.
Media Metadata
Read the data behind a post: title, author, caption, view and engagement counts, and publish dates across the major social platforms.
Web Extract
Scrape a single page, crawl a whole site, or map its URLs — and get back clean Markdown and structured content instead of raw HTML.
YouTube Data
Search videos, look up channel details, and run transcripts across many videos at once with batch jobs.
Core concepts
A handful of ideas show up in every part of the API. Learn them once and the rest of these docs will feel familiar.
Base URL
Every request goes to https://api.supacrawlx.com/v1. There is no separate sandbox host — you control behaviour with parameters.
API keys
Authentication is a single x-api-key header. Create, name, and rotate keys from your dashboard.
Credits
Each successful call spends credits from your monthly allowance. Costs vary by endpoint and are listed alongside it in the API reference.
JSON in, JSON out
Responses are always JSON. A successful call returns the data you asked for; a failure returns a consistent error object.
Request IDs
Every response carries a requestId. Quote it when you reach out and we can trace the exact call.
Start building
Ready to make your first call? These guides take you from zero to a working integration.
Quick Start
Install an SDK and make your first request in about five minutes.
Authentication
Create an API key and send it safely with every request.
Rate Limits
Per-plan request limits, monthly credits, and response headers.
API Reference
Browse every endpoint, parameter, and response shape.
SDKs & no-code tools
Rather not call the REST API directly? Reach for one of our official SDKs, or drop SupaCrawlX into a workflow without writing any code:
- Python SDK and Node.js SDK for typed access from your backend
- Automation platforms: n8n, Make, and Zapier
- An MCP server so AI agents can call SupaCrawlX as a tool
Help & support
Stuck on something? Here is where to look:
- Check live API health on the Status page.
- Email support@supacrawlx.com — include the
requestIdfrom your response so we can trace it. - Find guides, examples, and tooling on the Community Resources page.