# Supadata

Supadata is a web and video-to-text API that extracts transcripts from YouTube, TikTok, Instagram, Facebook, X (Twitter) and video files, retrieves social media metadata, and converts web content to markdown for AI training and content analysis.

- **Category:** ai web scraping
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 11
- **Triggers:** 0
- **Slug:** `SUPADATA`
- **Version:** 20260223_00

## Tools

### Get Account Information

**Slug:** `SUPADATA_GET_ME`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video Transcript

**Slug:** `SUPADATA_GET_TRANSCRIPT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Video URL from any supported platform (YouTube, TikTok, Twitter, Instagram, Facebook) or a file URL. Example: 'https://youtu.be/dQw4w9WgXcQ' |
| `lang` | string | No | Preferred language code of the transcript (ISO 639-1 format like 'en', 'es', 'fr'). If not provided, the first available language will be returned. If the requested language is unavailable, the API defaults to the first available language. |
| `mode` | string ("native" | "auto" | "generate") | No | Transcript retrieval mode. |
| `text` | boolean | No | When true, returns plain text transcript. When false, returns structured transcript with timestamps. Default is false. |
| `chunkSize` | integer | No | Maximum characters per transcript chunk. Only applies when text=false (structured transcript mode). Use this to split long transcripts into manageable segments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transcript by Job ID

**Slug:** `SUPADATA_GET_TRANSCRIPT_BY_JOB_ID`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The unique job ID of the transcript job. This is returned when you submit a transcript request. Example: '41060930-5273-4a89-80a2-9ba5ea5bc03f'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Website URL Map

**Slug:** `SUPADATA_GET_WEB_MAP`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of the website to crawl and extract all links from. Must be a valid HTTP/HTTPS URL. |
| `lang` | string | No | Preferred language for the scraped content (ISO 639-1 code, e.g., 'en', 'de', 'fr'). Sets Accept-Language header to influence website language selection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Scrape Web Page

**Slug:** `SUPADATA_GET_WEB_SCRAPE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of the webpage to scrape. Must be a valid HTTP/HTTPS URL. |
| `lang` | string | No | ISO 639-1 language code to request content in (e.g., 'en', 'es', 'fr'). Defaults to 'en'. |
| `no_links` | boolean | No | If true, exclude Markdown links from the extracted content. Useful for cleaner text output. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get YouTube Channel Metadata

**Slug:** `SUPADATA_GET_YOUTUBE_CHANNEL`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The YouTube channel identifier. Accepts multiple formats: channel ID (e.g., 'UC_x5XG1OV2P6uZZ5FSM9Ttw'), handle (e.g., '@GoogleDevelopers'), or full URL (e.g., 'https://youtube.com/@GoogleDevelopers'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get YouTube Channel Videos

**Slug:** `SUPADATA_GET_YOUTUBE_CHANNEL_VIDEOS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("all" | "video" | "short" | "live") | No | Type of videos to retrieve: 'all' (default) returns all types, 'video' for regular videos only, 'short' for YouTube Shorts only, 'live' for live streams only |
| `limit` | integer | No | Maximum number of videos to return. Default is 30, maximum is 5000. When type is 'all', limit applies to regular videos first, then shorts and live videos |
| `channel_id` | string | Yes | YouTube channel URL, handle (e.g., '@RickAstleyVEVO'), or channel ID (e.g., 'UC_x5XG1OV2P6uZZ5FSM9Ttw') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get YouTube Playlist Metadata

**Slug:** `SUPADATA_GET_YOUTUBE_PLAYLIST`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | YouTube playlist URL or ID. Supports various formats including full URLs (e.g., 'https://www.youtube.com/playlist?list=PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc') or just the playlist ID (e.g., 'PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get YouTube Playlist Videos

**Slug:** `SUPADATA_GET_YOUTUBE_PLAYLIST_VIDEOS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of video IDs to return. Default is 100, maximum is 5000. |
| `playlistId` | string | Yes | YouTube playlist URL or ID to fetch video IDs from. Can be a full playlist URL like 'https://www.youtube.com/playlist?list=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf' or just the playlist ID like 'PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get YouTube Video Metadata

**Slug:** `SUPADATA_GET_YOUTUBE_VIDEO`

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').

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | The YouTube video ID (11-character string found in YouTube URLs after 'v=' or '/watch?v='). Example: 'dQw4w9WgXcQ' from 'https://youtube.com/watch?v=dQw4w9WgXcQ'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search YouTube

**Slug:** `SUPADATA_SEARCH_YOUTUBE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("video" | "channel" | "playlist") | No | Type of resource to search for. If not specified, returns all types. Options: 'video', 'channel', 'playlist'. |
| `limit` | integer | No | Maximum number of results to return. Default is 10, max is 5000. Note: Uses 1 credit per page (~20 results). |
| `query` | string | Yes | The search query term to search on YouTube. Examples: 'python tutorial', 'cooking recipes', 'music videos'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |