# Search YouTube



<MethodPage method="GET" path="/v1/search" credits={1}>
  <MethodSignature name="search" args={[{ name: "query" }, { name: "options", optional: true }]} returns="SearchResponse" />

  Search videos, channels, playlists, or movies. Does not consume YouTube Data API quota.

  <Security permission="transcripts:read" />

  <SchemaGroup title="Parameters">
    <SchemaField name="q" type="string" location="query">
      Search keyword or phrase.
    </SchemaField>

    <SchemaField name="limit" type="number" optional location="query">
      Max results to return, from 1 to 50. Default `20`.
    </SchemaField>

    <SchemaField name="type" type="string" optional location="query">
      `video`, `channel`, `playlist`, or `movie`. Default `video`.
    </SchemaField>

    <SchemaField name="upload_date" type="string" optional location="query">
      `hour`, `today`, `week`, `month`, or `year`.
    </SchemaField>

    <SchemaField name="sort_by" type="string" optional location="query">
      `relevance`, `date`, `view_count`, or `rating`. Default `relevance`.
    </SchemaField>
  </SchemaGroup>

  <SchemaGroup title="Returns" id="returns">
    <SchemaField name="query" type="string">
      Echoed search string.
    </SchemaField>

    <SchemaField name="total_results" type="number">
      Number of items in this response.
    </SchemaField>

    <SchemaField name="results" type="SearchResult[]">
      Hits with `id`, `type`, `title`, channel fields, duration, views, and thumbnail.
    </SchemaField>
  </SchemaGroup>

  <MethodSamples>
    <LanguageSample language="TypeScript">
      ```ts
      const params = new URLSearchParams({
        q: "AI Agents",
        type: "video",
        upload_date: "month",
        limit: "10",
      });

      const response = await fetch(`https://api.ytapi.dev/v1/search?${params}`, {
        headers: {
          Authorization: `Bearer ${process.env.YT_API_KEY}`,
        },
      });

      const data = await response.json();
      console.log(data.results.map((item: { title: string }) => item.title));
      ```
    </LanguageSample>

    <LanguageSample language="Python">
      ```python
      import os
      import requests

      response = requests.get(
          "https://api.ytapi.dev/v1/search",
          headers={"Authorization": f"Bearer {os.environ['YT_API_KEY']}"},
          params={
              "q": "AI Agents",
              "type": "video",
              "upload_date": "month",
              "limit": 10,
          },
      )

      print(response.json())
      ```
    </LanguageSample>

    <LanguageSample language="cURL">
      ```bash
      curl -X GET "https://api.ytapi.dev/v1/search?q=AI+Agents&type=video&upload_date=month&limit=10" \
        -H "Authorization: Bearer $YT_API_KEY"
      ```
    </LanguageSample>

    <LanguageSample language="Go">
      ```go
      package main

      import (
      	"fmt"
      	"net/http"
      	"os"
      )

      func main() {
      	url := "https://api.ytapi.dev/v1/search?q=AI+Agents&type=video&upload_date=month&limit=10"
      	req, _ := http.NewRequest("GET", url, nil)
      	req.Header.Set("Authorization", "Bearer "+os.Getenv("YT_API_KEY"))

      	resp, err := http.DefaultClient.Do(req)
      	if err != nil {
      		panic(err)
      	}
      	defer resp.Body.Close()
      	fmt.Println(resp.Status)
      }
      ```
    </LanguageSample>

    <ResponseExample status={200}>
      ```json
      {
        "query": "AI Agents",
        "total_results": 10,
        "results": [
          {
            "id": "abc123xyz89",
            "type": "video",
            "title": "Building Autonomous AI Coding Agents from Scratch",
            "channel_title": "AI Engineering Hub",
            "channel_id": "UC1234567890",
            "duration_seconds": 1240,
            "view_count": 89420,
            "upload_date": "2024-03-10",
            "thumbnail_url": "https://i.ytimg.com/vi/abc123xyz89/mqdefault.jpg"
          }
        ]
      }
      ```
    </ResponseExample>
  </MethodSamples>
</MethodPage>