YouTube Search Suggestions
Structured YouTube data: send queries. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “Overview”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).
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/youtube-search-suggestions/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "queries=lofi" \ --max-time 210const params = new URLSearchParams({ queries: "lofi" });
const res = await fetch(`https://api.scrapier.io/api/v2/youtube-search-suggestions/?${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}`);
console.log(body.data.suggestions);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/youtube-search-suggestions/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"queries": "lofi"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["suggestions"])curl -X POST "https://api.scrapier.io/api/v2/youtube-search-suggestions/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"queries":"lofi"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
queries | string | yes | e.g. lofi | Search term (<= 100 chars). Required on first call; ignored when cursor is supplied. |
cursor | string | no | — | 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. |
country | string | no | US | ISO 3166-1 alpha-2 country code (gl). Locked into the cursor. |
language | string | no | — | UI language (hl) e.g. en, pt-BR. Blank = picked from country. Locked into the cursor. |
enrich_entities | boolean | no | true | Attach entity/channel cards to suggestions. Locked into the cursor. |
expansion_alphabet | string | no | — | Characters appended during expansion. Blank = a-z0-9. Locked into the cursor. |
Advanced
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | false | When 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. |
Response
Section titled “Response”{ "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" }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.suggestions.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
queries | string | lofi | — |
page | integer | 1 | — |
page_size | integer | 14 | — |
suggestions | array | [1 item] | The results. |
next_cursor | string | eyJoIjoiYWJjMTIzIiwiaSI6ImxvZmkiLCJsayI6eyJjb… | Pass back as cursor for the next page. null on the last page. |
suggestions[].text | string | lofi girl | — |
suggestions[].position | integer | 3 | — |
suggestions[].seed_query | string | lofi | — |
suggestions[].seed_position | integer | 2 | — |
suggestions[].depth | integer | 0 | — |
suggestions[].type_code | integer | 0 | — |
suggestions[].type | string | query | — |
suggestions[].subtypes | array | [2 items] | — |
suggestions[].is_verbatim | boolean | false | — |
suggestions[].is_expansion | boolean | false | — |
suggestions[].is_entity | boolean | false | — |
suggestions[].entity | null | null | — |
suggestions[].word_count | integer | 2 | — |
suggestions[].search_url | string | https://www.youtube.com/results?search_query=… | — |
suggestions[].keyword | string | lofi | — |
suggestions[].country | string | US | — |
suggestions[].language | string | en | — |
suggestions[].scraped_at | string | 2026-09-17T06:46:43.251Z | — |
Pagination
Section titled “Pagination”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 };}import requests
URL = "https://api.scrapier.io/api/v2/youtube-search-suggestions/"HEADERS = {"X-API-Key": "YOUR_API_KEY"}params = {"queries": "lofi"}items = []
for _ in range(10): # each page is one billed call resp = requests.get(URL, headers=HEADERS, params=params, timeout=210) resp.raise_for_status() data = resp.json()["data"] items.extend(data.get("suggestions") or []) if not data.get("next_cursor"): # None = last page break params = {"cursor": data["next_cursor"]}Errors
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- Nothing special: send the inputs, read the result.
Related
Section titled “Related”- YouTube Channel Info — Structured YouTube data: send
urls. Single lookup, 1 credit per successful call. - YouTube Channel Live/Streams — Structured YouTube data: send
channels. Cursor-paginated, 1 credit per successful call. - YouTube Channel Video Scraper — Structured YouTube data: send
youtube_channels. Cursor-paginated, 1 credit per successful call. - YouTube Comment Replies — Structured YouTube data: send
continuation_tokens. Cursor-paginated, 1 credit per successful call.