# Get suggestions



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

  Returns autocomplete strings for a partial query. Use this for search-as-you-type UIs. This endpoint is free.

  <Security permission="transcripts:read" />

  <SchemaGroup title="Query Parameters">
    <SchemaField name="q" type="string" location="query" required>
      Partial query string.
    </SchemaField>

    <SchemaField name="hl" type="string" optional location="query">
      Interface language for the suggestions, for example `es` or `ko`.
    </SchemaField>

    <SchemaField name="gl" type="string" optional location="query">
      Country whose searches the suggestions reflect, as a two-letter code, for example `MX` or `KR`.
    </SchemaField>
  </SchemaGroup>

  <div id="returns" className="mt-8">
    Response (HTTP 200) [#response-http-200]

    ```jsonc
    {
      "query": string,               // Echoed input query string
      "suggestions": string[]        // Ranked autocomplete suggestions
    }
    ```
  </div>

  <Callout type="success" title="Completely free">
    Search suggestions consume **0 credits**.
  </Callout>

  <MethodSamples>
    <LanguageSample language="TypeScript">
      ```ts
      const q = encodeURIComponent("nextjs 1");
      const response = await fetch(
        `https://api.ytapi.dev/v1/search/suggestions?q=${q}`,
        {
          headers: {
            Authorization: `Bearer ${process.env.YT_API_KEY}`,
          },
        },
      );

      const data = await response.json();
      console.log(data.suggestions);
      ```
    </LanguageSample>

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

      response = requests.get(
          "https://api.ytapi.dev/v1/search/suggestions",
          headers={"Authorization": f"Bearer {os.environ['YT_API_KEY']}"},
          params={"q": "nextjs 1"},
      )

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

    <LanguageSample language="cURL">
      ```bash
      curl -X GET "https://api.ytapi.dev/v1/search/suggestions?q=nextjs+1" \
        -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/suggestions?q=nextjs+1"
      	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>
  </MethodSamples>
</MethodPage>