Supadata

Retrieve organization details, plan information, and credit usage for the authenticated account. Use this to check account status, credit balance, and subscription plan.

Retrieve unified metadata for supported social-media content. Supports YouTube videos, TikTok videos, Instagram reels and posts, Twitter/X posts, and Facebook videos and posts. Each request costs one credit. Engagement statistics may be cached for up to about 10 minutes. HTTP 429 responses are plan-dependent and can indicate either the request-rate limit or usage-credit quota was exceeded.

Get transcript from a video on supported platforms or from a file URL. Use this tool when you need to: - Retrieve transcripts from YouTube, TikTok, Twitter, Instagram, or Facebook videos - Extract transcript from video file URLs - Get transcripts in specific languages - Choose between native captions or AI-generated transcripts For large videos, the API returns a job ID. You'll need to poll the /transcript/{jobId} endpoint to get the final result. For smaller videos, the transcript is returned immediately. The response varies based on the 'text' parameter: - text=true: Returns plain text transcript as a string - text=false: Returns structured list of chunks with timestamps and text

Get results for a transcript job by job ID. Use this to retrieve results of asynchronous transcript processing. Check the status field to determine if the job is complete.

Retrieve the current status and result of a video extraction job. Call this action repeatedly, waiting about one second between calls, until status is completed or failed. Polling is free. Completed results expire after one hour and then return HTTP 404, so retrieve and store them promptly. HTTP 429 responses are plan-dependent and can indicate a request-rate limit or usage-credit quota was exceeded.

Poll a web crawl and retrieve its pages. Polling is free. Repeat while status is scraping; completed, failed, and cancelled are terminal. When next is returned, continue with the skip value from that URL. Requests may return HTTP 429 according to plan limits.

Crawl a website and extract all URLs/links found on it. Use this to create a sitemap, discover all pages of a website, or prepare for content scraping across multiple pages. Returns a list of all URLs discovered during the crawl.

Extract content from any webpage and convert it to Markdown format. Use this tool when you need to: - Read and extract text content from a web page - Get metadata (title, description) from a webpage - Discover links on a webpage - Get character counts of page content The tool returns the page content in Markdown format, making it easy to process and understand. One API credit is consumed per scrape request.

Poll a transcript or video metadata batch. Polling is free; repeat until status is completed or failed. An unfinished, abandoned job can age out with errorCode=job-expired. Use limit and offset to page completed results. Requests may return HTTP 429 according to plan limits.

Fetches metadata for a YouTube channel including name, description, subscriber count, video count, view count, and channel images. Accepts channel IDs, handles, or full YouTube URLs.

Tool to retrieve video IDs from a YouTube channel. Returns lists of regular video IDs, YouTube Shorts IDs, and live stream IDs. Videos are ordered latest first. Use this to get video IDs that can be passed to the Get YouTube Video endpoint for full metadata.

Retrieve metadata for a YouTube playlist including title, description, video count, view count, last updated timestamp, and channel information. Use this when you need playlist-level information. For the list of videos in a playlist, use the Get YouTube Playlist Videos action instead.

Tool to retrieve video IDs from a YouTube playlist. Returns lists of standard video IDs, YouTube Shorts IDs, and live stream IDs contained in the playlist.

Retrieve comprehensive metadata for a YouTube video by its ID. Use this tool when you need to get details about a specific YouTube video including: - Title, description, and tags - Channel information - View and like counts - Upload date and duration - Live stream status - Available transcript languages The video_id is the 11-character identifier found in YouTube URLs (e.g., 'dQw4w9WgXcQ' from 'https://youtube.com/watch?v=dQw4w9WgXcQ').

Search YouTube for videos, channels, or playlists by keyword. Returns matching content with metadata like titles, thumbnails, view counts, and channel information.

Start asynchronous structured extraction from a supported public video. Supadata analyzes what is seen and heard in public YouTube, TikTok, Instagram, X (Twitter), and Facebook videos or public media files. Supported files are MP4, WEBM, MP3, FLAC, MPEG, MPGA, M4A, OGG, and WAV, up to 200 MB; videos longer than 55 minutes are unsupported. Extraction always returns a job ID for polling. It costs five credits per started video minute, with a five-credit minimum; polling is free. HTTP 429 responses are plan-dependent and can indicate either the plan's request-rate limit or usage-credit quota was exceeded.

Start an asynchronous website crawl. This Pro+ operation follows child links under the supplied URL. Respect the site's robots.txt and terms of service. Supadata charges one credit per crawled page: a small estimate is charged upfront when the job is submitted and settled to the actual page count when the crawl completes. Polling is free. Plan-dependent HTTP 429 responses can indicate a request-rate limit or usage-credit quota was exceeded.

Start an asynchronous YouTube transcript batch from exactly one list of video IDs, playlist, or channel. This feature requires Supadata Pro or above. Supadata charges one credit per requested video at submission, then settles to the actual video count when processing finishes. Unavailable transcripts remain billed; videos that fail for other reasons are not billed. Plan rate or usage limits can return HTTP 429.

Start an asynchronous YouTube video metadata batch. This feature requires a Pro plan or above and accepts exactly one source: video IDs, a playlist, or a channel. Playlist and channel batches process regular videos only. Supadata charges one credit per requested video at submission and settles the charge to the actual result count when processing finishes; polling is free. HTTP 429 responses are plan-dependent and can indicate either the plan's request-rate limit or usage-credit quota was exceeded.

Translate a YouTube transcript into a requested ISO 639-1 language. Provide exactly one YouTube URL or video ID. This feature requires Supadata Pro or above, costs 30 credits per transcript minute, and may take 20 or more seconds. HTTP 429 responses indicate a plan-dependent rate or usage limit was exceeded.