Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json

Search query text

Minimum string length: 1
language
string

Language for results

Required string length: 2 - 16
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$
country
string

Country code for results

Required string length: 2
Pattern: ^[A-Za-z]{2}$
geo
string

Geo location for results

Required string length: 2 - 32
type
enum<string>

Type of result to search for

Available options:
video,
channel,
playlist,
all
limit
integer

Max number of results

Required range: x <= 1000
start_page
integer

First result page to fetch

Required range: x <= 9007199254740991
end_page
integer

Last result page to fetch

Required range: x <= 9007199254740991

Response

YouTube crawl job queued.

request_id
string
required
mode
enum<string>
required
Available options:
async
status
enum<string>
required
Available options:
queued
job_id
string
required
job_type
string