Search Keywords

Search for keywords by their name.

tmdb.search.keyword(options: {
  query: string;
  page?: number;
}): Promise<PaginatedResponse<SearchKeywordItem>>

Parameters

NameTypeRequiredDescription
querystring✅Search query text
pagenumber❌Page number (default: 1)

Reference

TMDB - Search Keyword

Example

const results = await tmdb.search.keyword({ query: "rage" });

Response

{
  "page": 1,
  "results": [
    {
      "id": 14837,
      "name": "rage"
    },
    {
      "id": 287516,
      "name": "female rage"
    },
    {
      "id": 3927,
      "name": "rage and hate"
    },
    {
      "id": 189262,
      "name": "righteous rage"
    },
    {
      "id": 159931,
      "name": "road rage"
    },
    {
      "id": 319869,
      "name": "oedipal rage"
    },
    {
      "id": 350471,
      "name": "rageone"
    }
  ],
  "total_pages": 1,
  "total_results": 7
}

Types

export type SearchKeywordItem = {
    id: number;
    name: string;
};

type PaginatedResponse<T> = {
    page: number;
    total_pages: number;
    total_results: number;
    results: T[];
};