Skip to main content
POST
YouTube channel

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

Channel (@handle or URL), playlist or video URL. e.g. @NASA

max_results
integer
default:10

Videos (up to 1000)

Required range: 0 <= x <= 1000
max_results_shorts
integer
default:0

Shorts (up to 1000)

Required range: 0 <= x <= 1000
max_results_streams
integer
default:0

Streams (up to 1000)

Required range: 0 <= x <= 1000
sort_videos_by
enum<string>

Sort channel videos by. Options: POPULAR = Popular, OLDEST = Oldest

Available options:
POPULAR,
OLDEST
download_subtitles
boolean

Download subtitles (when present on the video)

subtitles_language
enum<string>

Subtitle language. Options: any = Any, de = German, es = Spanish, fr = French, it = Italian, ja = Japanese, ko = Korean, nl = Dutch, pt = Portuguese, ru = Russian

Available options:
any,
de,
es,
fr,
it,
ja,
ko,
nl,
pt,
ru
subtitles_format
enum<string>

Subtitle format. Options: vtt = WEBVTT, xml = XML, plaintext = Plain text

Available options:
vtt,
xml,
plaintext

Response

Run completed.

session_id
string

Session identifier for this run.

kind
string

Data source identifier for this endpoint.

url
string
sort_videos_by
string
max_results
integer
max_results_shorts
integer
max_results_streams
integer
download_subtitles
boolean
subtitles_language
string
subtitles_format
string
partial
boolean

True when the scrape stopped early and returned the records collected so far.

human
string

Markdown summary of the result, for display.

machine
object

Structured result payload.

total_points
integer

Points charged for this run.