> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/api-targets/pt-br/video-and-social-media/youtube/youtube-search.md).

# Pesquisa

Faça scraping dos resultados de pesquisa do YouTube para vídeos, canais, playlists e filmes, com filtros para data de envio, duração, tipo de conteúdo, resolução, transmissões ao vivo, legendas e muito mais.

Você pode pesquisar vídeos, canais, playlists ou filmes no YouTube fornecendo uma **consulta** para a `youtube_search` ou `youtube_search_max` fonte.

{% hint style="info" %}
A `youtube_search` fonte permite recuperar até **20** resultados de busca, enquanto a `youtube_search_max` fonte pode retornar até **700** resultados em uma única resposta.
{% endhint %}

Esta fonte também pode ser usada junto com `youtube_autocomplete` para encontrar termos de busca primeiro: envie um termo inicial para `youtube_autocomplete`, depois passe uma das sugestões retornadas como valor de query para `youtube_search`. Cada fonte é chamada separadamente: autocomplete retorna as sugestões, search retorna os vídeos do termo que você escolher.

### Exemplos de requisição

Os exemplos a seguir demonstram como utilizar a `youtube_search` fonte para recuperar vídeos do YouTube com base em uma **consulta de busca.**

{% 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

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

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

# Imprima a resposta JSON com o resultado.
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",
    Autorização:
      "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="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 o payload com a nova consulta youtube_metadata.
	payload := map[string]interface{}{
		"source": "youtube_search",
		"query":  "how to make a website
	}

	jsonValue, err := json.Marshal(payload)
	if err != nil {
		fmt.Println("Erro ao serializar 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("Erro ao criar a requisição:", err)
		return
	}

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

	response, err := client.Do(request)
	if err != nil {
		fmt.Println("Erro ao fazer a requisição:", err)
		return
	}
	defer response.Body.Close()

	responseText, err := ioutil.ReadAll(response.Body)
	if err != nil {
		fmt.Println("Erro ao ler a resposta:", err)
		return
	}

	fmt.Println(string(responseText))
}
```

{% endtab %}

{% tab title="C#" %}

```csharp
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_search",
                query = "how to make a website"
            };

            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($"Erro na requisição: {e.Message}");
            }
        }
    }
}
```

{% endtab %}

{% tab title="Java" %}

```java
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() {
        // Construa o payload JSON para a requisição youtube_search
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("source", "youtube_search");
        jsonObject.put("query", "how to make a website");

        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("Erro: " + 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 %}

Usamos o método de integração síncrono [**Realtime**](/products/pt-br/web-scraper-api/integration-methods/realtime.md) em nossos exemplos. Se você quiser usar a integração [**Push-Pull**](/products/pt-br/web-scraper-api/integration-methods/push-pull.md) , consulte a seção de [**métodos de integração**](/products/pt-br/web-scraper-api/integration-methods.md) .

{% file src="/files/4e0f581bd7befe9bab832607aae12aa5e1118bdb" %}

## Parâmetros da consulta

<table><thead><tr><th width="178">Parâmetro</th><th width="264.1302083333333">Descrição</th><th width="196.3046875">Valor padrão</th><th>Tipo</th></tr></thead><tbody><tr><td><mark style="background-color:green;"><strong><code>source</code></strong></mark></td><td>Define o scraper.</td><td><code>youtube_search</code> ou <code>youtube_search_max</code></td><td>String</td></tr><tr><td><mark style="background-color:green;"><strong><code>consulta</code></strong></mark></td><td>Termo de busca.</td><td>-</td><td>String</td></tr><tr><td><strong><code>geo_location</code></strong></td><td>Especifica um país de onde rotear a requisição. <a href="/products/pt-br/web-scraper-api/features/localization/proxy-location.md">Mais informações</a>.</td><td>-</td><td>String</td></tr></tbody></table>

\- parâmetro obrigatório

### Filtros

Você pode personalizar sua busca usando todos os filtros disponíveis via a interface do YouTube.

<div align="left" data-full-width="false"><figure><img src="https://3537372600-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBaJCXoqO1zdFnaMnCKrg%2Fuploads%2Fgit-blob-781b9ad5e24b793898b0d77e6d96d7893e591912%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure></div>

#### **Parâmetros de consulta dos filtros**

<table><thead><tr><th width="165">Parâmetro</th><th width="364.3333333333333">Descrição</th><th width="129">Valor padrão</th><th>Tipo</th></tr></thead><tbody><tr><td><code>upload_date</code></td><td>Filtra vídeos pela data de upload. Os valores disponíveis são: <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>Retorna resultados por tipo de conteúdo. Os valores disponíveis são: <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>Duração do conteúdo em minutos. Os valores disponíveis são: <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>Determina como os resultados da busca são ordenados. Os valores disponíveis são <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>Retorna vídeos em 360 graus nos resultados da busca.</td><td>-</td><td>Booleano</td></tr><tr><td><code>3d</code></td><td>Retorna vídeos em 3D nos resultados da busca.</td><td>-</td><td>Booleano</td></tr><tr><td><code>4k</code></td><td>Retorna vídeos em resolução 4K nos resultados da busca.</td><td>-</td><td>Booleano</td></tr><tr><td><code>creative_commons</code></td><td>Retorna apenas vídeos com licenças Creative Commons.</td><td>-</td><td>Booleano</td></tr><tr><td><code>hd</code></td><td>Retorna vídeos em alta definição nos resultados da busca.</td><td>-</td><td>Booleano</td></tr><tr><td><code>hdr</code></td><td>Retorna vídeos HDR (High Dynamic Range) nos resultados da busca.</td><td>-</td><td>Booleano</td></tr><tr><td><code>live</code></td><td>Retorna transmissões ao vivo nos resultados da busca.</td><td>-</td><td>Booleano</td></tr><tr><td><code>location</code></td><td>Retorna apenas vídeos que têm uma tag de localização.</td><td>-</td><td>Booleano</td></tr><tr><td><code>purchased</code></td><td>Retorna conteúdo comprado nos resultados da busca.</td><td>-</td><td>Booleano</td></tr><tr><td><code>subtitles</code></td><td>Retorna vídeos com legendas ou closed captions.</td><td>-</td><td>Booleano</td></tr><tr><td><code>vr180</code></td><td>Retorna vídeos no formato VR180 nos resultados da busca.</td><td>-</td><td>Booleano</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://developers.oxylabs.io/api-targets/pt-br/video-and-social-media/youtube/youtube-search.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
