json format that names the parser. The data comes back in data.json.
{"type": "json", "parser": "youtube-search", "options": {...}}. See Parsers for how they work.
youtube-search
A YouTube search results page with the search in search_query.- Example page: https://www.youtube.com/results?search_query=lofi+beats
- Returns: A list of videos:
results,cursor,page,total. - Options:
type(Leave out for videos, channels and playlists. Use shorts for Shorts),duration,uploadDate,features,prioritize,cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call. Works without an API key.
Example response
Example response
youtube-video
A YouTube video link: watch, youtu.be, shorts or live.- Example page: https://www.youtube.com/watch?v=dQw4w9WgXcQ
- Returns: One video:
id,url,title,description,author,publishedAt,durationSeconds,views,likes,comments,thumbnailUrl,hashtags. - Price: 1 credit per call. Works without an API key.
Example response
Example response
youtube-transcript
A YouTube video link: watch, youtu.be, shorts or live.- Example page: https://www.youtube.com/watch?v=dQw4w9WgXcQ
- Returns:
startSeconds,endSeconds,text. - Options:
language(BCP 47 language tag, e.g. en or pt-BR. Any case is accepted),includeTimestamps. - Price: 1 credit per call. Works without an API key.
Example response
Example response
youtube-comments
A YouTube video link: watch, youtu.be, shorts or live.- Example page: https://www.youtube.com/watch?v=dQw4w9WgXcQ
- Returns: A list of comments:
results,cursor,page,total. - Options:
comment(A comment’s repliesCursor from an earlier response. Returns that comment’s replies),sort,cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call. Works without an API key.
Example response
Example response
youtube-channel
A YouTube channel link: @handle, /channel/, /c/ or /user/, with an optional tab.- Example page: https://www.youtube.com/@mkbhd
- Returns: One profile:
id,url,handle,name,bio,avatarUrl,isVerified,followers,following,posts,website,location,category. - 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(The cursor from the previous response. Send it as is). - Price: 1 credit per call. Works without an API key.
Example response
Example response
youtube-post
A YouTube community post link: /post/Ugkx… or a community page with ?lb=.- Example page: https://www.youtube.com/post/UgkxX6gkDxQ0KRucvyG7NLui0LhjHp0CLlfZ
- Returns: One post:
id,url,title,text,author,community,publishedAt,likes,comments,shares,views,media,hashtags. - Options:
sort(YouTube’s own comment sort),cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call.
Example response
Example response
youtube-playlist
A YouTube playlist page with list in the link.- Example page: https://www.youtube.com/playlist?list=PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI
- Returns: A list of videos:
results,cursor,page,total. - Options:
cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call.
Example response
Example response
tiktok-video
A TikTok video page or share link.- Example page: https://www.tiktok.com/@charlidamelio/video/7137423965982592302
- Returns: One video:
id,url,title,description,author,publishedAt,durationSeconds,views,likes,comments,thumbnailUrl,hashtags. - Price: 1 credit per call.
Example response
Example response
tiktok-comments
A TikTok video page or share link.- Example page: https://www.tiktok.com/@charlidamelio/video/7137423965982592302
- Returns: A list of comments:
results,cursor,page,total. - Options:
comment,cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call.
Example response
Example response
tiktok-transcript
A TikTok video page or share link.- Example page: https://www.tiktok.com/@charlidamelio/video/7137423965982592302
- Returns:
startSeconds,endSeconds,text. - Options:
language(BCP 47 language tag, e.g. en or pt-BR. Any case is accepted),includeTimestamps. - Price: 1 credit when the video has captions; otherwise 2 credits plus 1 credit for every 10 seconds of audio, up to 3 minutes. Works without an API key.
Example response
Example response
tiktok-profile
A TikTok profile page. Send options view videos to page through its videos.- Example page: https://www.tiktok.com/@khaby.lame
- Returns: One profile:
id,url,handle,name,bio,avatarUrl,isVerified,followers,following,posts,website,location,category. - Options:
cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call. Works without an API key.
Example response
Example response
tiktok-hashtag
A TikTok hashtag page.- Example page: https://www.tiktok.com/tag/booktok
- Returns: A list of videos:
results,cursor,page,total. - Options:
cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call.
Example response
Example response
tiktok-sound
A TikTok sound page that ends in the sound id.- Example page: https://www.tiktok.com/music/original-sound-7652012548169976607
- Returns: A list of videos:
results,cursor,page,total. - Options:
cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call.
Example response
Example response
tiktok-search
A TikTok user search page (/search/user) or video search page (/search) with a q query.- Example page: https://www.tiktok.com/search/user?q=street%20food
- Returns: A list of profiles:
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(The cursor from the previous response. Send it as is),query,type. - Price: 1 credit per call.
Example response
Example response
tiktok-followers
A TikTok profile page.- Example page: https://www.tiktok.com/@khaby.lame
- Returns: A list of profiles:
results,cursor,page,total. - Options:
cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call.
Example response
Example response
tiktok-following
A TikTok profile page.- Example page: https://www.tiktok.com/@khaby.lame
- Returns: A list of profiles:
results,cursor,page,total. - Options:
cursor(The cursor from the previous response. Send it as is). - Price: 1 credit per call.
Example response
Example response
instagram-transcript
An Instagram reel or video post.- Example page: https://www.instagram.com/reel/DfS8Xbng4MD/
- Returns:
startSeconds,endSeconds,text. - Options:
language(BCP 47 language tag, e.g. en or pt-BR. Any case is accepted),includeTimestamps. - Price: 1 credit plus 1 credit for every 30 seconds of audio, up to 5 minutes.
Example response
Example response