Skip to content

Structured YouTube data: send queries. Cursor-paginated, 1 credit per successful call.

GET · POST1 credit / successful callCursor-paginated
GEThttps://api.scrapier.io/api/v2/youtube-search-suggestions/Open in Playground

Call GET /api/v2/youtube-search-suggestions/ with queries. The results are in data.suggestions; send data.next_cursor back as cursor to get the next page. 5 optional parameters refine the call (see Parameters).

Terminal window
curl -G "https://api.scrapier.io/api/v2/youtube-search-suggestions/" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "queries=lofi" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
queriesstringyese.g. lofiSearch term (<= 100 chars). Required on first call; ignored when cursor is supplied.
cursorstringno—Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page.
countrystringnoUSISO 3166-1 alpha-2 country code (gl). Locked into the cursor.
languagestringno—UI language (hl) e.g. en, pt-BR. Blank = picked from country. Locked into the cursor.
enrich_entitiesbooleannotrueAttach entity/channel cards to suggestions. Locked into the cursor.
expansion_alphabetstringno—Characters appended during expansion. Blank = a-z0-9. Locked into the cursor.
Advanced
NameTypeDefaultDescription
use_proxybooleantrueRoute the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise.
raw_databooleanfalseWhen true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes.
{
"success": true,
"data": {
"queries": "lofi",
"page": 1,
"page_size": 14,
"suggestions": [
{
"text": "lofi girl",
"position": 3,
"seed_query": "lofi",
"seed_position": 2,
"depth": 0,
"type_code": 0,
"type": "query",
"subtypes": [
512,
433
],
"is_verbatim": false,
"is_expansion": false,
"is_entity": false,
"entity": null,
"word_count": 2,
"search_url": "https://www.youtube.com/results?search_query=lofi+girl",
"keyword": "lofi",
"country": "US",
"language": "en",
"scraped_at": "2026-09-17T06:46:43.251Z"
}
],
"next_cursor": "eyJoIjoiYWJjMTIzIiwiaSI6ImxvZmkiLCJsayI6eyJjb3VudHJ5IjoiVVMifSwicCI6Mn0"
}
}

Sample from the live catalog; arrays trimmed to 3 items. Results are in data.suggestions.

FieldTypeExampleDescription
queriesstringlofi—
pageinteger1—
page_sizeinteger14—
suggestionsarray[1 item]The results.
next_cursorstringeyJoIjoiYWJjMTIzIiwiaSI6ImxvZmkiLCJsayI6eyJjb…Pass back as cursor for the next page. null on the last page.
suggestions[].textstringlofi girl—
suggestions[].positioninteger3—
suggestions[].seed_querystringlofi—
suggestions[].seed_positioninteger2—
suggestions[].depthinteger0—
suggestions[].type_codeinteger0—
suggestions[].typestringquery—
suggestions[].subtypesarray[2 items]—
suggestions[].is_verbatimbooleanfalse—
suggestions[].is_expansionbooleanfalse—
suggestions[].is_entitybooleanfalse—
suggestions[].entitynullnull—
suggestions[].word_countinteger2—
suggestions[].search_urlstringhttps://www.youtube.com/results?search_query=…—
suggestions[].keywordstringlofi—
suggestions[].countrystringUS—
suggestions[].languagestringen—
suggestions[].scraped_atstring2026-09-17T06:46:43.251Z—

Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.

const url = "https://api.scrapier.io/api/v2/youtube-search-suggestions/";
let params = { queries: "lofi" };
const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call
const res = await fetch(`${url}?${new URLSearchParams(params)}`, {
headers: { "X-API-Key": "YOUR_API_KEY" },
signal: AbortSignal.timeout(210_000),
});
const body = await res.json();
if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
const data = body.data;
items.push(...(data.suggestions ?? []));
if (!data.next_cursor) break; // null = last page
params = { cursor: data.next_cursor };
}

Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.

StatusMeaningRetry?Charged?
400Bad or missing input.No — fix the paramsNo
401 / 403Missing, invalid or revoked API key.No — fix the keyNo
402Out of credits (body has balance).No — top upNo
404Unknown endpoint slug.No — check the slugNo
429 / 503Busy or throttled.Yes — after Retry-AfterNo
5xxTarget site or upstream failure, or timeout.Yes — with backoffNo
  • Nothing special: send the inputs, read the result.