# Search

You can search YouTube for videos, channels, playlists or movies by providing a search **query** to the `youtube_search` or `youtube_search_max` source. &#x20;

{% hint style="info" %}
&#x20;The`youtube_search` source allows retrieving up to **20** search results, while the `youtube_search_max` source can return up to **700** results in a single response.&#x20;
{% endhint %}

This source can also be combined with `youtube_autocomplete` source to include suggestions and target relevant keywords and  search terms.

The following examples demonstrate how to utilize `youtube_search` source to retrieve YouTube videos based on a search **query.**&#x20;

{% tabs %}
{% tab title="cURL" %}

```bash
curl 'https://realtime.oxylabs.io/v1/queries' \
--user 'USERNAME:PASSWORD' \
-H 'Content-Type: application/json' \
-d '{
        "source": "youtube_search",
        "query": "how to make a website"
    }'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
from pprint import pprint

# Structure payload.
payload = {
    'source': 'youtube_search',
    'query': 'how to make a website'
}

# Get response.
response = requests.request(
    'POST',
    'https://realtime.oxylabs.io/v1/queries',
    auth=('user', 'pass1'),
    json=payload,
)

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

{% endtab %}

{% tab title="Node.js" %}

```javascript
const https = require("https");

const username = "USERNAME";
const password = "PASSWORD";
const body = {
  source: "youtube_search",
  query: "how to make a website"
};
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();
```

{% endtab %}

{% tab title="HTTP" %}

```http
https://realtime.oxylabs.io/v1/queries?source=youtube_search&query=how to make a website&access_token=12345abcde
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$params = array(
    'source' => 'youtube_search',
    'query' => 'how to make a website'
);
   
$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);
```

{% endtab %}

{% tab title="Golang" %}

```go
package main

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

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

	// Define the payload with the new youtube_metadata query.
	payload := map[string]interface{}{
		"source": "youtube_search",
		"query":  "how to make a website
	}

	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))
}
```

{% endtab %}

{% tab title="C#" %}

```csharp
using System;
using System.Collections.Generic;
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_search",
                query = "how to make a website",
                context = new[]
                {
                    new { key = "language_code", value = "en" },
                    new { key = "transcript_origin", value = "uploader_provided" }
                }
            };

            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}");
            }
        }
    }
}
```

{% endtab %}

{% tab title="Java" %}

```java
package org.example;

import okhttp3.*;
import org.json.JSONArray;
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 for youtube_metadata request
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("source", "youtube_search");
        jsonObject.put("query", "how to make a website");

        JSONArray contextArray = new JSONArray();
        contextArray.put(new JSONObject().put("key", "language_code").put("value", "en"));
        contextArray.put(new JSONObject().put("key", "transcript_origin").put("value", "uploader_provided"));

        jsonObject.put("context", contextArray);

        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();
    }
}
```

{% endtab %}

{% tab title="JSON" %}

```json
{
    "source": "youtube_search",
    "query": "how to make a website"
}
```

{% endtab %}
{% endtabs %}

We use the synchronous [**Realtime**](https://developers.oxylabs.io/scraper-apis/web-scraper-api/integration-methods/realtime) integration method in our examples. If you would like to use the [**Push-Pull**](https://developers.oxylabs.io/scraping-solutions/web-scraper-api/integration-methods/push-pull) integration, refer to the [**Integration Methods**](https://developers.oxylabs.io/scraping-solutions/web-scraper-api/integration-methods) section.

{% file src="<https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2F7GTNyA0zE4JV2fsmCXPo%2Fyoutube%20search%20output%20sample.json?alt=media&token=976a5214-f966-48e6-bd51-698d7da36b11>" %}

## Query parameters

<table><thead><tr><th width="178">Parameter</th><th width="162.33333333333331">Description</th><th width="176">Default Value</th><th>Type</th></tr></thead><tbody><tr><td><mark style="background-color:green;"><strong>source</strong></mark></td><td>Sets the scraper.</td><td><code>youtube_search</code> or <code>youtube_search_max</code></td><td>String</td></tr><tr><td> <mark style="background-color:green;"><strong>query</strong></mark> </td><td>Search term.</td><td>-</td><td>String</td></tr></tbody></table>

&#x20;    \- required parameter

### Filters

You can customize your search by using all the filters available via YouTube GUI.

<div align="left" data-full-width="false"><figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FL0MqnUQCEbPe29thTjom%2Fimage.png?alt=media&#x26;token=84eab990-f080-434f-8041-d4d473a434cd" alt=""><figcaption></figcaption></figure></div>

#### **Filters query parameters**

<table><thead><tr><th width="165">Parameter</th><th width="364.3333333333333">Description</th><th width="129">Default Value</th><th>Type</th></tr></thead><tbody><tr><td><code>upload_date</code></td><td>Filters videos by the upload date. Available values are: <code>today</code>, <code>last_hour</code>, <code>this_week</code>, <code>this_month</code>, <code>this_year</code>.</td><td>-</td><td>String</td></tr><tr><td><code>type</code></td><td>Returns results by content type. Available values are: <code>video</code>, <code>channel</code>, <code>playlist</code>, <code>movie</code>.</td><td>-</td><td>String</td></tr><tr><td><code>duration</code></td><td>Content duration in minutes. Available values are: <code>&#x3C;4</code>,  <code>4-20</code>, <code>>20</code>. </td><td>-</td><td>String</td></tr><tr><td><code>sort_by</code></td><td>Determines how search results are ordered. Available values are <code>rating</code>, <code>relevance</code>, <code>view_count</code>,<code>upload_date</code>.</td><td><code>relevance</code></td><td>String </td></tr><tr><td><code>360</code></td><td>Returns 360-degree videos in search results.</td><td>-</td><td>Boolean</td></tr><tr><td><code>3d</code></td><td>Returns 3D videos in search results.</td><td>-</td><td>Boolean</td></tr><tr><td><code>4k</code></td><td>Returns 4K resolution videos in search results.</td><td>-</td><td>Boolean</td></tr><tr><td><code>creative_commons</code></td><td>Returns only videos with Creative Commons licenses.</td><td>-</td><td>Boolean</td></tr><tr><td><code>hd</code></td><td>Returns high-definition videos in search results.</td><td>-</td><td>Boolean</td></tr><tr><td><code>hdr</code></td><td>Returns HDR (High Dynamic Range) videos in search results.</td><td>-</td><td>Boolean</td></tr><tr><td><code>live</code></td><td>Returns live streams in search results.</td><td>-</td><td>Boolean</td></tr><tr><td><code>location</code></td><td>Returns videos with location information.</td><td>-</td><td>Boolean</td></tr><tr><td><code>purchased</code></td><td>Returns purchased content in search results.</td><td>-</td><td>Boolean</td></tr><tr><td><code>subtitles</code></td><td>Returns videos with subtitles or closed captions.</td><td>-</td><td>Boolean </td></tr><tr><td><code>vr180</code></td><td>Returns VR180 format videos in search results.</td><td>-</td><td>Boolean </td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.oxylabs.io/scraping-solutions/web-scraper-api/targets/youtube/youtube-search.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
