Get suggestions

getSuggestions(query, options?): SuggestionsResponse

GET

https://api.ytapi.dev/v1/search/suggestions

Free

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

Security

API Key

All requests require a valid API key from the developer dashboard.

Headers: Authorization: Bearer YOUR_API_KEYorX-API-Key: YOUR_API_KEY

See Authentication for headers and rate limits.

Query Parameters

Parameter	Type	Required	Description
`q`query	`string`	Yes	Partial query string.
`hl`query	`string`	No	Interface language for the suggestions, for example `es` or `ko`.
`gl`query	`string`	No	Country whose searches the suggestions reflect, as a two-letter code, for example `MX` or `KR`.

Response (HTTP 200)

{
  "query": string,               // Echoed input query string
  "suggestions": string[]        // Ranked autocomplete suggestions
}

Completely free

Search suggestions consume 0 credits.

Get suggestions

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);

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())

curl -X GET "https://api.ytapi.dev/v1/search/suggestions?q=nextjs+1" \
  -H "Authorization: Bearer $YT_API_KEY"

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