Skip to main content
POST
YouTube search

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string
required

Search term. e.g. web scraping tutorial

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
sorting_order
enum<string>

Sorting order. Options: rating = Rating, date = Upload date, views = View count

Available options:
rating,
date,
views
date_filter
enum<string>

Upload date. Options: hour = Last hour, today = Today, week = This week, month = This month, year = This year

Available options:
hour,
today,
week,
month,
year
video_type
enum<string>

Type. Options: video = Video, movie = Film

Available options:
video,
movie
length_filter
enum<string>

Length. Options: under4 = Under 4 minutes, between420 = 4-20 minutes, plus20 = Over 20 minutes

Available options:
under4,
between420,
plus20
features
enum<string>[]

Features

Available options:
hd,
subtitles,
creative_commons,
3d,
live,
purchased,
4k,
360,
location,
hdr,
vr180
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.

query
string
sorting_order
string
date_filter
string
video_type
string
length_filter
string
features
any[]
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.