YouTube Autocomplete

Learn how to get YouTube search term suggestions using the Web Scraper API. Find out more about its parameters and see an example request.

With the youtube_autocomplete source, users can get related keyword suggestions for any search term of their choice. These suggestions can be used with the youtube_search source to discover more relevant videos and expand your YouTube data workflows.

Request samples

The following examples demonstrate how to retrieve search term suggestions for a given query.

curl 'https://realtime.oxylabs.io/v1/queries' \
--user 'USERNAME:PASSWORD' \
-H 'Content-Type: application/json' \
-d '{
        "source": "youtube_autocomplete",
        "query": "what is",
        "language": "en",
        "location": "US"
    }'

import requests
from pprint import pprint

# Structure payload.
payload = {
    "source": "youtube_autocomplete",
    "query": "what is",
    "language": "en",
    "location": "US"
}

# Get response.
response = requests.request(
    "POST",
    "https://realtime.oxylabs.io/v1/queries",
    auth=("USERNAME", "PASSWORD"),
    json=payload,
)

# Print the JSON response with the result.
pprint(response.json())

const https = require("https");

const username = "USERNAME";
const password = "PASSWORD";
const body = {
    source: "youtube_autocomplete",
    query: "what is",
    language: "en",
    location: "US"
};

const options = {
    hostname: "realtime.oxylabs.io",
    path: "/v1/queries",
    method: "POST",
    headers: {
        "Content-Type": "application/json",
        Authorization:
            "Basic " + Buffer.from(`${username}:${password}`).toString("base64"),
    },
};

const request = https.request(options, (response) => {
    let data = "";

    response.on("data", (chunk) => {
        data += chunk;
    });

    response.on("end", () => {
        const responseData = JSON.parse(data);
        console.log(JSON.stringify(responseData, null, 2));
    });
});

request.on("error", (error) => {
    console.error("Error:", error);
});

request.write(JSON.stringify(body));
request.end();

<?php

$params = array(
    'source' => 'youtube_autocomplete',
    'query' => 'what is',
    'language' => 'en',
    'location' => 'US'
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://realtime.oxylabs.io/v1/queries");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_USERPWD, "USERNAME" . ":" . "PASSWORD");

$headers = array();
$headers[] = "Content-Type: application/json";
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
echo $result;

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}

curl_close($ch);

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	const Username = "USERNAME"
	const Password = "PASSWORD"

	// Define the payload
	payload := map[string]interface{}{
		"source":   "youtube_autocomplete",
		"query":    "what is",
		"language": "en",
		"location": "US",
	}

	jsonValue, err := json.Marshal(payload)
	if err != nil {
		fmt.Println("Error marshalling JSON:", err)
		return
	}

	client := &http.Client{}
	request, err := http.NewRequest("POST", "https://realtime.oxylabs.io/v1/queries", bytes.NewBuffer(jsonValue))
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	request.SetBasicAuth(Username, Password)
	request.Header.Set("Content-Type", "application/json")

	response, err := client.Do(request)
	if err != nil {
		fmt.Println("Error making request:", err)
		return
	}
	defer response.Body.Close()

	responseText, err := ioutil.ReadAll(response.Body)
	if err != nil {
		fmt.Println("Error reading response:", err)
		return
	}

	fmt.Println(string(responseText))
}

using System;
using System.Net.Http;
using System.Net.Http.Json;
using System.Text;
using System.Threading.Tasks;

namespace OxyApi
{
    class Program
    {
        static async Task Main()
        {
            const string Username = "USERNAME";
            const string Password = "PASSWORD";

            var parameters = new
            {
                source = "youtube_autocomplete",
                query = "what is",
                language = "en",
                location = "US"
            };

            var client = new HttpClient();

            Uri baseUri = new Uri("https://realtime.oxylabs.io");
            client.BaseAddress = baseUri;

            var requestMessage = new HttpRequestMessage(HttpMethod.Post, "/v1/queries");
            requestMessage.Content = JsonContent.Create(parameters);

            var authenticationString = $"{Username}:{Password}";
            var base64EncodedAuthenticationString = Convert.ToBase64String(Encoding.UTF8.GetBytes(authenticationString));
            requestMessage.Headers.Add("Authorization", "Basic " + base64EncodedAuthenticationString);

            try
            {
                var response = await client.SendAsync(requestMessage);
                response.EnsureSuccessStatusCode();

                var contents = await response.Content.ReadAsStringAsync();
                Console.WriteLine(contents);
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine($"Request error: {e.Message}");
            }
        }
    }
}

package org.example;

import okhttp3.*;
import org.json.JSONObject;
import java.util.concurrent.TimeUnit;

public class Main implements Runnable {
    private static final String AUTHORIZATION_HEADER = "Authorization";
    public static final String USERNAME = "USERNAME";
    public static final String PASSWORD = "PASSWORD";

    public void run() {
        // Construct JSON payload
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("source", "youtube_autocomplete");
        jsonObject.put("query", "what is");
        jsonObject.put("language", "en");
        jsonObject.put("location", "US");

        Authenticator authenticator = (route, response) -> {
            String credential = Credentials.basic(USERNAME, PASSWORD);
            return response
                    .request()
                    .newBuilder()
                    .header(AUTHORIZATION_HEADER, credential)
                    .build();
        };

        var client = new OkHttpClient.Builder()
                .authenticator(authenticator)
                .readTimeout(180, TimeUnit.SECONDS)
                .build();

        var mediaType = MediaType.parse("application/json; charset=utf-8");
        var body = RequestBody.create(jsonObject.toString(), mediaType);
        var request = new Request.Builder()
                .url("https://realtime.oxylabs.io/v1/queries")
                .post(body)
                .build();

        try (var response = client.newCall(request).execute()) {
            if (response.body() != null) {
                try (var responseBody = response.body()) {
                    System.out.println(responseBody.string());
                }
            }
        } catch (Exception exception) {
            System.out.println("Error: " + exception.getMessage());
        }

        System.exit(0);
    }

    public static void main(String[] args) {
        new Thread(new Main()).start();
    }
}

Our examples use synchronous Realtime integration method. If you would like to use Proxy Endpoint, or asynchronous Push-Pull integration, refer to the Integration Methods section.

Output sample

{
    "results": [
        {
            "content": "window.google.ac.h([\"what is\",[[\"what is love\",0,[512,433]],[\"what is this feeling wicked\",0,[512,433,131]],[\"what is love baby dont hurt me no\",0,[512,433]],[\"what is 67\",0,[512,433,131]],[\"what is\",0,[512]],[\"what is you nba youngboy\",0,[512,433,131]],[\"what is love haddaway\",0,[512,433]],[\"what is this feeling wicked karaoke\",0,[512,433]],[\"what is love twice\",0,[512,433,131]],[\"what is you\",0,[512,433,131,650]],[\"what is sounds like\",0,[512,433]],[\"what is scientology\",0,[512]],[\"what is the big beautiful bill\",0,[512]],[\"what is a woman\",0,[512,433]]],{\"j\":\"5\",\"k\":1,\"q\":\"fxuDygqjaW7TVwu4-jEjTrWp6b8\"}])",
            "type": "raw",
            ...
}

Request parameter values

Parameter

Description

Default Value

source

Sets the scraper.

youtube_autocomplete

query

The search term for which keyword suggestions should be returned.

–

location

Search location (2-letter country code).

US

language

Search language code.

en

callback_url

URL to your callback endpoint. More info.

–

– mandatory parameter

Localization

For available location and language parameter values, consult the tables below.

Available locations for youtube_autocomplete

Parameter value

Country

Afghanistan

Albania

Algeria

American Samoa

Andorra

Angola

Anguilla

Antarctica

Antigua and Barbuda

Argentina

Armenia

Aruba

Australia

Austria

Azerbaijan

Bahamas

Bahrain

Bangladesh

Barbados

Belarus

Belgium

Belize

Benin

Bermuda

Bhutan

Bolivia

Bosnia and Herzegovina

Botswana

Bouvet Island

Brazil

British Indian Ocean Territory

Brunei Darussalam

Bulgaria

Burkina Faso

Burundi

Cambodia

Cameroon

Canada

Cape Verde

Cayman Islands

Central African Republic

Chad

Chile

China

Christmas Island

Cocos (Keeling) Islands

Colombia

Comoros

Congo

Congo, the Democratic Republic of the

Cook Islands

Costa Rica

Cote D'ivoire

Croatia

Cuba

Cyprus

Czech Republic

Denmark

Djibouti

Dominica

Dominican Republic

Ecuador

Egypt

El Salvador

Equatorial Guinea

Eritrea

Estonia

Ethiopia

Falkland Islands (Malvinas)

Faroe Islands

Fiji

Finland

France

French Guiana

French Polynesia

French Southern Territories

Gabon

Gambia

Georgia

Germany

Ghana

Gibraltar

Greece

Greenland

Grenada

Guadeloupe

Guam

Guatemala

Guinea

Guinea-Bissau

Guyana

Haiti

Heard Island and Mcdonald Islands

Holy See (Vatican City State)

Honduras

Hong Kong

Hungary

Iceland

India

Indonesia

Iran, Islamic Republic of

Iraq

Ireland

Israel

Italy

Jamaica

Japan

Jordan

Kazakhstan

Kenya

Kiribati

North Korea

South Korea

Kuwait

Kyrgyzstan

Lao People's Democratic Republic

Latvia

Lebanon

Lesotho

Liberia

Libya

Liechtenstein

Lithuania

Luxembourg

Macao

North Macedonia

Madagascar

Malawi

Malaysia

Maldives

Mali

Malta

Marshall Islands

Martinique

Mauritania

Mauritius

Mayotte

Mexico

Micronesia, Federated States of

Moldova, Republic of

Monaco

Mongolia

Montserrat

Morocco

Mozambique

Myanmar

Namibia

Nauru

Nepal

Netherlands

New Caledonia

New Zealand

Nicaragua

Niger

Nigeria

Niue

Norfolk Island

Northern Mariana Islands

Norway

Oman

Pakistan

Palau

Palestinian Territory, Occupied

Panama

Papua New Guinea

Paraguay

Peru

Philippines

Pitcairn

Poland

Portugal

Puerto Rico

Qatar

Reunion

Romania

Russian Federation

Rwanda

Saint Helena

Saint Kitts and Nevis

Saint Lucia

Saint Pierre and Miquelon

Saint Vincent and the Grenadines

Samoa

San Marino

Sao Tome and Principe

Saudi Arabia

Senegal

Serbia and Montenegro

Seychelles

Sierra Leone

Singapore

Slovakia

Slovenia

Solomon Islands

Somalia

South Africa

South Georgia and the South Sandwich Islands

Spain

Sri Lanka

Sudan

Suriname

Svalbard and Jan Mayen

Swaziland

Sweden

Switzerland

Syrian Arab Republic

Taiwan

Tajikistan

Tanzania, United Republic of

Thailand

Timor-Leste

Togo

Tokelau

Tonga

Trinidad and Tobago

Tunisia

Turkey

Turkmenistan

Turks and Caicos Islands

Tuvalu

Uganda

Ukraine

United Arab Emirates

United Kingdom

United States

United States Minor Outlying Islands

Uruguay

Uzbekistan

Vanuatu

Venezuela

Viet Nam

Virgin Islands, British

Virgin Islands, U.S.

Wallis and Futuna

Western Sahara

Yemen

Zambia

Zimbabwe

Guernsey

Jersey

Isle of Man

Montenegro

Available languages for youtube_autocomplete

Parameter value

Language

ach

Luo

Afrikaans

Akan

Amharic

Arabic

Azerbaijani

Belarusian

bem

Bemba

Bulgarian

Bihari

Bengali

Breton

Bosnian

Bhutanese

Catalan

chr

Cherokee

ckb

Kurdish (Soranî)

Corsican

crs

Seychellois Creole

Czech

Welsh

Danish

German

Ewe

Greek

English

Esperanto

Spanish

es-419

Spanish (Latin American)

Estonian

Basque

Persian

Finnish

Faroese

French

Frisian

Irish

gaa

Scots Gaelic

Galician

Guarani

Gujarati

Hausa

haw

Hawaiian

Hebrew

Hindi

Croatian

Haitian Creole

Hungarian

Armenian

Interlingua

Indonesian

Igbo

Icelandic

Italian

Hebrew

Japanese

Javanese

Georgian

Kongo

Kazakh

Greenlandic

Cambodian

Kannada

Korean

kri

Krio (Sierra Leone)

Kurdish

Kyrgyz

Latin

Luganda

Lingala

Laothian

loz

Lozi

Lithuanian

lua

Tshiluba

Latvian

mfe

Mauritian Creole

Malagasy

Maori

Macedonian

Malayalam

Mongolian

Moldavian

Marathi

Malay

Maltese

Maldives

Myanmar

Nepali

Dutch

Norwegian (Nynorsk)

Norwegian

nso

Northern Sotho

Chichewa

nyn

Runyakitara

Occitan

Oromo

Oriya

Punjabi

pcm

Nigerian Pidgin

Polish

Pashto

Portuguese

pt-br

Portuguese (Brazil)

pt-pt

Portuguese (Portugal)

Quechua

Romansh

Kirundi

Romanian

Russian

Kinyarwanda

Sindhi

Serbo-Croatian

Sinhalese

Slovak

Slovenian

Shona

Somali

Albanian

Serbian

sr-me

Montenegrin

Sesotho

Sundanese

Swedish

Swahili

Tamil

Telugu

Tajik

Thai

Tigrinya

Turkmen

Filipino

Setswana

Tonga

Turkish

Tatar

tum

Tumbuka

Twi

Uighur

Ukrainian

Urdu

Uzbek

Vietnamese

Vanuatu

Wolof

Samoa

Xhosa

Yiddish

Yoruba

zh-cn

Chinese (Simplified)

zh-tw

Chinese (Traditional)

Zulu

PreviousYouTube Channel NextGeneric Target

Last updated 1 month ago

Was this helpful?

Good morning

Request samples

Output sample

Request parameter values

Localization