> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Video

> Parsers for video: youtube-search, youtube-video, youtube-transcript, youtube-comments, youtube-channel, youtube-post, youtube-playlist, tiktok-live and more.

Send the example URL to [scrape](https://docs.stophy.dev/api-reference/endpoint/scrape.md) with the format `{"type": "json", "parser": "<name>"}`. See [Pre-built parsers](https://docs.stophy.dev/scrape/prebuilt-parsers).

### `youtube-search`

A YouTube search results page with the search in search\_query. Example: `https://www.youtube.com/results?search_query=lofi+beats`

Returns `results`, `cursor`, `page`, `total`.

Works without an API key when you send no options.

Options:

* `type`: Leave out for videos, channels and playlists. Use shorts for Shorts.
* `duration`
* `uploadDate`
* `features`
* `prioritize`
* `cursor`

### `youtube-video`

A YouTube video link: watch, youtu.be, shorts or live. Example: `https://www.youtube.com/watch?v=dQw4w9WgXcQ`

Returns `id`, `url`, `title`, `description`, `author`, `publishedAt`, `durationSeconds`, `views`, `likes`, `comments`, `thumbnailUrl`, `hashtags`.

Works without an API key when you send no options.

### `youtube-transcript`

A YouTube video link: watch, youtu.be, shorts or live. Example: `https://www.youtube.com/watch?v=dQw4w9WgXcQ`

Returns `startSeconds`, `endSeconds`, `text`.

Works without an API key when you send no options.

Options:

* `language`
* `includeTimestamps`

### `youtube-comments`

A YouTube video link: watch, youtu.be, shorts or live. Example: `https://www.youtube.com/watch?v=dQw4w9WgXcQ`

Returns `results`, `cursor`, `page`, `total`.

Works without an API key when you send no options.

Options:

* `comment`: A comment's repliesCursor from an earlier response. Returns that comment's replies.
* `sort`
* `cursor`

### `youtube-channel`

A YouTube channel link: @handle, /channel/, /c/ or /user/, with an optional tab. Example: `https://www.youtube.com/@mkbhd`

Returns `id`, `url`, `handle`, `name`, `bio`, `avatarUrl`, `isVerified`, `followers`, `following`, `posts`, `website`, `location`, `category`.

Works without an API key when you send no options.

Options:

* `tab`: YouTube's own channel tab. Releases are a music channel's albums.
* `sort`: YouTube's own sort for the videos, shorts and live tabs.
* `cursor`

### `youtube-post`

A YouTube community post link: /post/Ugkx... or a community page with ?lb=. Example: `https://www.youtube.com/post/UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ`

Returns `id`, `url`, `title`, `text`, `author`, `community`, `publishedAt`, `likes`, `comments`, `shares`, `views`, `media`, `hashtags`.

Options:

* `sort`: YouTube's own comment sort.
* `cursor`

### `youtube-playlist`

A YouTube playlist page with list in the link. Example: `https://www.youtube.com/playlist?list=PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `cursor`

### `tiktok-video`

A TikTok video page or share link. Example: `https://www.tiktok.com/@charlidamelio/video/7137423965982592302`

Returns `id`, `url`, `title`, `description`, `author`, `publishedAt`, `durationSeconds`, `views`, `likes`, `comments`, `thumbnailUrl`, `hashtags`.

### `tiktok-comments`

A TikTok video page or share link. Example: `https://www.tiktok.com/@charlidamelio/video/7137423965982592302`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `comment`
* `cursor`

### `tiktok-transcript`

A TikTok video page or share link. Example: `https://www.tiktok.com/@charlidamelio/video/7137423965982592302`

Returns `startSeconds`, `endSeconds`, `text`.

Options:

* `language`
* `includeTimestamps`

### `tiktok-profile`

A TikTok profile page. Set options.view to videos to page through its videos. Example: `https://www.tiktok.com/@khaby.lame`

Returns `id`, `url`, `handle`, `name`, `bio`, `avatarUrl`, `isVerified`, `followers`, `following`, `posts`, `website`, `location`, `category`.

Works without an API key when you send no options.

Options:

* `view`: `videos`.
* `cursor`

### `tiktok-hashtag`

A TikTok hashtag page. Example: `https://www.tiktok.com/tag/booktok`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `cursor`

### `tiktok-sound`

A TikTok sound page that ends in the sound id. Example: `https://www.tiktok.com/music/original-sound-7652012548169976607`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `cursor`

### `tiktok-search`

A TikTok user search page (/search/user) or video search page (/search) with a q query. Example: `https://www.tiktok.com/search/user?q=street%20food`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `sort`: TikTok's Sort by, for videos. Leave out for Relevance.
* `datePosted`: TikTok's Date posted, for videos. Leave out for All time.
* `cursor`

### `tiktok-followers`

A TikTok profile page. Example: `https://www.tiktok.com/@khaby.lame`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `cursor`

### `tiktok-following`

A TikTok profile page. Example: `https://www.tiktok.com/@khaby.lame`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `cursor`

### `tiktok-trending`

TikTok's Explore page, with an optional region in the link, such as region=DE, for another country's feed. Example: `https://www.tiktok.com/explore`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `country`: One of the 27 markets TikTok trends covers: ae, ar, au, br, ca, co, de, eg, es, fr, gb, id, il, it, jp, kr, mx, my, ph, sa, sg, th, tr, tw, us, vn, za. Any case is accepted.

### `tiktok-live`

A TikTok account's live page. Example: `https://www.tiktok.com/@khaby.lame/live`

Returns `userId`, `username`, `userUrl`, `name`, `isVerified`, `isLive`.

### `twitch-profile`

A Twitch channel page, like twitch.tv/twitch. Gives the channel's name, description, followers, whether it is live now (with the stream's title, game, viewers and start time) and its 10 newest past broadcasts. Example: `https://www.twitch.tv/twitch`

Returns `id`, `url`, `handle`, `name`, `bio`, `avatarUrl`, `isVerified`, `followers`, `following`, `posts`, `website`, `location`, `category`.

### `twitch-clips`

A Twitch channel's clips page, like twitch.tv/twitch/clips. The range in the link (24hr, 7d, 30d or all) picks the period, and a link with no range gives the last 7 days. options.limit sets how many clips, up to 100. Twitch gives one page of clips, so there is no next page. Example: `https://www.twitch.tv/twitch/clips`

Returns `results`, `cursor`, `page`, `total`.

Options:

* `period`: Which clips to rank by views: the last day, week or month, or all time. Matches the range on the channel's clips page. Defaults to week.
* `limit`: Return at most this many clips. You pay \$0.001 for each 10 returned.

### `instagram-transcript`

An Instagram reel or video post. Example: `https://www.instagram.com/reel/DfS8Xbng4MD/`

Returns `startSeconds`, `endSeconds`, `text`.

Options:

* `language`
* `includeTimestamps`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.