ytsearch.js

🔎 A powerful yet lightweight YouTube search wrapper for Node.js. Fetch videos, channels, playlists, movies, and live streams effortlessly without using the official API. Supports advanced playlist pagination with customizable user page limits, detailed video metadata fetching, sortable search results, combined multi-type search (via any), and comprehensive error handling — all via a clean, developer-friendly API.

---

🚀 Installation

npm install ytsearch.js

Requires Node.js v14+ (ESM supported).

---

📦 Usage

CommonJS

const { searchYouTube } = require("ytsearch.js");

(async () => {
  const results = await searchYouTube("Black Panther", {
    type: "video",
    limit: 10,
  });
  results.videos.forEach((item) => console.log(item.type, item.title));
})();

ES Modules

import { searchYouTube } from "ytsearch.js";

const results = await searchYouTube("Black Panther", {
  type: "channel",
  limit: 10,
});
results.channels.forEach((item) => console.log(item.type, item.title));

---

📑 Documentation

Full API documentation, examples, and error handling are available on the GitHub Wiki.

---

📑 API

searchYouTube

searchYouTube(query: string, options?: SearchOptions): Promise<SearchResult>;

Search Options

interface SearchOptions {
  type?: "video" | "channel" | "playlist" | "movie" | "live" | "any";
  sort?: "relevance" | "upload_date" | "view_count" | "rating";
  limit?: number; // 10–50 (default: 20)
}

Result

interface SearchResult {
  videos: VideoResult[];
  channels: ChannelResult[];
  playlists: PlaylistResult[];
  movies: VideoResult[];
  lives: VideoResult[];
  metadata: SearchMetadata;
  nextPage: () => Promise<SearchResult | null>;
}

• If type is specific (video, channel, etc.), only that array will be filled.
• If type is any, results include videos, channels, and playlists. (movies and lives are grouped under videos).

✅ Page size is limited to 10–50 to prevent excessive YouTube requests. Requests are buffered intelligently — YouTube is queried only when needed.

---

getPlaylistItems

Fetch a playlist with videos and pagination support.

getPlaylistItems(playlistId: string, options?: PlaylistOptions): Promise<PlaylistDetailsResult>;

Playlist Options

interface PlaylistOptions {
  limit?: number; // 10–100 (default: 50)
}

PlaylistDetailsResult Object

interface PlaylistDetailsResult {
  playlist: PlaylistInfo;
  videos: PlaylistVideo[];
  metadata: PlaylistMetadata;
  nextPage: () => Promise<PlaylistDetailsResult | null>;
}

Metadata includes YouTube page tracking, user page size, and total video count.

---

getVideoDetails

Fetch detailed metadata for a specific video by video ID.

getVideoDetails(videoID: string): Promise<VideoDetailsResult>;

---

🤝 Contributing

1. Fork this repo
2. Create a feature branch (git checkout -b feature/awesome)
3. Commit changes (git commit -m 'Add awesome feature')
4. Push branch (git push origin feature/awesome)
5. Create a Pull Request 🚀

---

📜 License

MIT © 2025 RJRYT

---