scrapebadger 0.15.0 → 0.15.2

package/dist/index.js

@@ -5054,6 +5054,612 @@ var EbayClient = class {
   }
 };
 
+// src/youtube/search.ts
+var SearchClient8 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Search YouTube videos / channels / playlists with the full filter matrix.
+   *
+   * @param params - Search parameters including query, filters, and continuation.
+   * @returns A page of search results with chips, refinements, and a continuation token.
+   * @throws AuthenticationError - If the API key is invalid.
+   * @throws ValidationError - If the parameters are invalid.
+   */
+  async search(params) {
+    return this.client.request("/v1/youtube/search", {
+      params: {
+        query: params.query,
+        type: params.type,
+        sort_by: params.sort_by,
+        upload_date: params.upload_date,
+        duration: params.duration,
+        features: params.features,
+        gl: params.gl,
+        hl: params.hl,
+        continuation: params.continuation
+      }
+    });
+  }
+  /**
+   * Get YouTube keyword autocomplete suggestions.
+   *
+   * @param query - Partial search query prefix.
+   * @param options - Optional region parameters (gl, hl).
+   * @returns Autocomplete suggestions.
+   */
+  async autocomplete(query, options = {}) {
+    return this.client.request("/v1/youtube/autocomplete", {
+      params: { query, gl: options.gl, hl: options.hl }
+    });
+  }
+};
+
+// src/youtube/videos.ts
+var VideosClient3 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get a single video's full detail (merged `player` + `next`).
+   *
+   * @param videoId - The YouTube video id.
+   * @param options - Optional region parameters (gl, hl).
+   * @returns Full video detail including engagement, channel, chapters, and heatmap.
+   * @throws NotFoundError - If the video doesn't exist or is unavailable.
+   */
+  async get(videoId, options = {}) {
+    return this.client.request(`/v1/youtube/videos/${videoId}`, {
+      params: { gl: options.gl, hl: options.hl }
+    });
+  }
+  /**
+   * Get related / recommended videos for a video.
+   *
+   * @param videoId - The YouTube video id.
+   * @param options - Optional region parameters and a continuation token.
+   * @returns Related results with a continuation token.
+   */
+  async related(videoId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/videos/${videoId}/related`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a page of top-level comments for a video.
+   *
+   * @param videoId - The YouTube video id.
+   * @param options - Optional sort order, continuation token, and region.
+   * @returns A page of comments with sorting tokens and a continuation token.
+   */
+  async comments(videoId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/videos/${videoId}/comments`,
+      {
+        params: {
+          sort_by: options.sort_by,
+          continuation: options.continuation,
+          gl: options.gl,
+          hl: options.hl
+        }
+      }
+    );
+  }
+  /**
+   * Get a page of replies to a single comment.
+   *
+   * @param videoId - The YouTube video id.
+   * @param commentId - The comment id whose replies to fetch.
+   * @param options - The required replies continuation token plus region.
+   * @returns A page of replies with a continuation token.
+   */
+  async replies(videoId, commentId, options) {
+    return this.client.request(
+      `/v1/youtube/videos/${videoId}/comments/${commentId}/replies`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a video's transcript in the selected language.
+   *
+   * @param videoId - The YouTube video id.
+   * @param options - Optional language and region parameters.
+   * @returns The transcript with timed segments and full text.
+   */
+  async transcript(videoId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/videos/${videoId}/transcript`,
+      { params: { language: options.language, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * List a video's available caption tracks.
+   *
+   * @param videoId - The YouTube video id.
+   * @param options - Optional region parameters.
+   * @returns The available caption tracks and translation languages.
+   */
+  async captions(videoId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/videos/${videoId}/captions`,
+      { params: { gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a video's stream / format metadata (best-effort; URLs may be PO-token gated).
+   *
+   * @param videoId - The YouTube video id.
+   * @param options - Optional content region and player client.
+   * @returns Streaming metadata with muxed and adaptive formats.
+   */
+  async streams(videoId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/videos/${videoId}/streams`,
+      { params: { gl: options.gl, client: options.client } }
+    );
+  }
+  /**
+   * Get a page of live-chat (or chat-replay) messages for a video.
+   *
+   * @param videoId - The YouTube video id.
+   * @param options - Optional continuation token, replay flag, and region.
+   * @returns A page of live-chat messages with a continuation token.
+   */
+  async liveChat(videoId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/videos/${videoId}/live_chat`,
+      {
+        params: {
+          continuation: options.continuation,
+          replay: options.replay,
+          gl: options.gl,
+          hl: options.hl
+        }
+      }
+    );
+  }
+  /**
+   * Fetch detail for up to 50 videos concurrently.
+   *
+   * @param params - The video ids (≤50) plus optional region parameters.
+   * @returns Successfully fetched videos plus per-id errors.
+   */
+  async batch(params) {
+    return this.client.request("/v1/youtube/videos/batch", {
+      method: "POST",
+      body: { video_ids: params.video_ids, gl: params.gl, hl: params.hl }
+    });
+  }
+  async oembed(arg) {
+    const url = typeof arg === "string" ? arg : arg.url;
+    return this.client.request("/v1/youtube/oembed", { params: { url } });
+  }
+};
+
+// src/youtube/channels.ts
+var ChannelsClient = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get full channel detail (accepts a UC id, @handle, or custom URL).
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - Optional region parameters.
+   * @returns Full channel detail.
+   * @throws NotFoundError - If the channel doesn't exist.
+   */
+  async get(channelId, options = {}) {
+    return this.client.request(`/v1/youtube/channels/${channelId}`, {
+      params: { gl: options.gl, hl: options.hl }
+    });
+  }
+  /**
+   * Get a page of a channel's long-form videos.
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - Optional continuation token and region.
+   * @returns A page of video cards with a continuation token.
+   */
+  async videos(channelId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/channels/${channelId}/videos`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a page of a channel's Shorts.
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - Optional continuation token and region.
+   * @returns A page of Shorts cards with a continuation token.
+   */
+  async shorts(channelId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/channels/${channelId}/shorts`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a page of a channel's live streams.
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - Optional continuation token and region.
+   * @returns A page of stream cards with a continuation token.
+   */
+  async streams(channelId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/channels/${channelId}/streams`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a page of a channel's playlists.
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - Optional continuation token and region.
+   * @returns A page of playlist cards with a continuation token.
+   */
+  async playlists(channelId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/channels/${channelId}/playlists`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a page of a channel's community posts.
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - Optional continuation token and region.
+   * @returns A page of community posts with a continuation token.
+   */
+  async community(channelId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/channels/${channelId}/community`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a channel's lightweight about payload.
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - Optional region parameters.
+   * @returns The channel about payload.
+   */
+  async about(channelId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/channels/${channelId}/about`,
+      { params: { gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Get a channel's subscriber count (fast).
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - Optional region parameters.
+   * @returns The subscriber count.
+   */
+  async subscriberCount(channelId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/channels/${channelId}/subscriber_count`,
+      { params: { gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Search within a single channel.
+   *
+   * @param channelId - The channel id, @handle, or custom URL.
+   * @param options - The required query plus optional continuation and region.
+   * @returns A page of search results scoped to the channel.
+   */
+  async search(channelId, options) {
+    return this.client.request(
+      `/v1/youtube/channels/${channelId}/search`,
+      {
+        params: {
+          query: options.query,
+          continuation: options.continuation,
+          gl: options.gl,
+          hl: options.hl
+        }
+      }
+    );
+  }
+  /**
+   * Resolve a @handle or URL to canonical YouTube ids.
+   *
+   * @param options - A `handle` or `url` (one is required) plus optional region.
+   * @returns The resolved channel / video / playlist ids.
+   */
+  async resolve(options = {}) {
+    return this.client.request("/v1/youtube/channels/resolve", {
+      params: { handle: options.handle, url: options.url, gl: options.gl, hl: options.hl }
+    });
+  }
+};
+
+// src/youtube/playlists.ts
+var PlaylistsClient = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get full playlist detail plus the first page of items.
+   *
+   * @param playlistId - The playlist id.
+   * @param options - Optional region parameters.
+   * @returns Full playlist detail with a continuation token.
+   * @throws NotFoundError - If the playlist doesn't exist.
+   */
+  async get(playlistId, options = {}) {
+    return this.client.request(`/v1/youtube/playlists/${playlistId}`, {
+      params: { gl: options.gl, hl: options.hl }
+    });
+  }
+  /**
+   * Get a continuation page of a playlist's items.
+   *
+   * @param playlistId - The playlist id.
+   * @param options - Optional continuation token and region.
+   * @returns A page of playlist items with a continuation token.
+   */
+  async items(playlistId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/playlists/${playlistId}/items`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+  /**
+   * Resolve an auto-generated mix / radio (RD…) queue.
+   *
+   * @param mixId - The mix / radio playlist id.
+   * @param options - Optional region parameters.
+   * @returns The mix as a playlist queue.
+   */
+  async mix(mixId, options = {}) {
+    return this.client.request(`/v1/youtube/mixes/${mixId}`, {
+      params: { gl: options.gl, hl: options.hl }
+    });
+  }
+};
+
+// src/youtube/community.ts
+var CommunityClient = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get a single community post's detail.
+   *
+   * @param postId - The community post id.
+   * @param options - Optional region parameters.
+   * @returns The community post.
+   * @throws NotFoundError - If the post doesn't exist.
+   */
+  async get(postId, options = {}) {
+    return this.client.request(`/v1/youtube/posts/${postId}`, {
+      params: { gl: options.gl, hl: options.hl }
+    });
+  }
+  /**
+   * Get a page of comments on a community post.
+   *
+   * @param postId - The community post id.
+   * @param options - Optional continuation token and region.
+   * @returns A page of comments with a continuation token.
+   */
+  async comments(postId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/posts/${postId}/comments`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+};
+
+// src/youtube/shorts.ts
+var ShortsClient2 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get a single Short's detail.
+   *
+   * @param videoId - The Short's video id.
+   * @param options - Optional region parameters.
+   * @returns The Short detail.
+   * @throws NotFoundError - If the Short doesn't exist or is unavailable.
+   */
+  async get(videoId, options = {}) {
+    return this.client.request(`/v1/youtube/shorts/${videoId}`, {
+      params: { gl: options.gl, hl: options.hl }
+    });
+  }
+  /**
+   * Get a page of Shorts attributed to a given sound / music id (best-effort).
+   *
+   * @param soundId - The sound / music id.
+   * @param options - Optional continuation token and region.
+   * @returns A page of Shorts cards with a continuation token.
+   */
+  async bySound(soundId, options = {}) {
+    return this.client.request(
+      `/v1/youtube/shorts/by_sound/${soundId}`,
+      { params: { continuation: options.continuation, gl: options.gl, hl: options.hl } }
+    );
+  }
+};
+
+// src/youtube/trending.ts
+var TrendingClient2 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get a page of the trending feed.
+   *
+   * @param options - Optional feed type, continuation token, and region.
+   * @returns A page of trending items with a continuation token.
+   */
+  async get(options = {}) {
+    return this.client.request("/v1/youtube/trending", {
+      params: {
+        type: options.type,
+        continuation: options.continuation,
+        gl: options.gl,
+        hl: options.hl
+      }
+    });
+  }
+  /**
+   * Get a page of trending Shorts.
+   *
+   * @param options - Optional continuation token and region.
+   * @returns A page of trending Shorts with a continuation token.
+   */
+  async shorts(options = {}) {
+    return this.client.request("/v1/youtube/trending/shorts", {
+      params: { continuation: options.continuation, gl: options.gl, hl: options.hl }
+    });
+  }
+  /**
+   * Get a page of videos under a hashtag.
+   *
+   * @param tag - The hashtag (with or without a leading `#`).
+   * @param options - Optional continuation token and region.
+   * @returns A page of hashtag results with a continuation token.
+   */
+  async hashtag(tag, options = {}) {
+    return this.client.request(`/v1/youtube/hashtags/${tag}`, {
+      params: { continuation: options.continuation, gl: options.gl, hl: options.hl }
+    });
+  }
+  /**
+   * Get a page of the guest home / recommendations feed (best-effort).
+   *
+   * @param options - Optional continuation token and region.
+   * @returns A page of home-feed results with a continuation token.
+   */
+  async home(options = {}) {
+    return this.client.request("/v1/youtube/home", {
+      params: { continuation: options.continuation, gl: options.gl, hl: options.hl }
+    });
+  }
+};
+
+// src/youtube/music.ts
+var MusicClient2 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Search YouTube Music (songs / albums / artists / playlists).
+   *
+   * @param params - The required query plus optional continuation and region.
+   * @returns A page of search results with a continuation token.
+   */
+  async search(params) {
+    return this.client.request("/v1/youtube/music/search", {
+      params: {
+        query: params.query,
+        continuation: params.continuation,
+        gl: params.gl,
+        hl: params.hl
+      }
+    });
+  }
+};
+
+// src/youtube/reference.ts
+var ReferenceClient6 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * List YouTube video categories (Data-API parity).
+   *
+   * @param options - Optional content region (default: "US").
+   * @returns The categories for the region.
+   */
+  async categories(options = {}) {
+    return this.client.request("/v1/youtube/categories", {
+      params: { gl: options.gl }
+    });
+  }
+  /**
+   * List supported UI languages (hl codes).
+   *
+   * @returns The supported UI languages.
+   */
+  async languages() {
+    return this.client.request("/v1/youtube/languages");
+  }
+  /**
+   * List supported content regions (gl codes).
+   *
+   * @returns The supported content regions.
+   */
+  async regions() {
+    return this.client.request("/v1/youtube/regions");
+  }
+  /**
+   * List the regions the scraper explicitly geo-targets (proxy-pinned).
+   *
+   * @returns The supported scraper markets.
+   */
+  async markets() {
+    return this.client.request("/v1/youtube/markets");
+  }
+};
+
+// src/youtube/client.ts
+var YoutubeClient = class {
+  /** Client for full-matrix search and keyword autocomplete */
+  search;
+  /** Client for video detail, comments, transcript, captions, streams, live chat, batch, and oEmbed */
+  videos;
+  /** Client for channel detail, tab feeds, about, subscriber count, search, and resolve */
+  channels;
+  /** Client for playlist detail, items pagination, and mixes */
+  playlists;
+  /** Client for community post detail and post comments */
+  community;
+  /** Client for single-Short detail and Shorts by sound */
+  shorts;
+  /** Client for the trending feed, trending shorts, hashtag feed, and home feed */
+  trending;
+  /** Client for YouTube Music search */
+  music;
+  /** Client for reference data (categories, languages, regions, markets) */
+  reference;
+  /**
+   * Create a new YouTube client.
+   *
+   * @param client - The base HTTP client for making requests.
+   */
+  constructor(client) {
+    this.search = new SearchClient8(client);
+    this.videos = new VideosClient3(client);
+    this.channels = new ChannelsClient(client);
+    this.playlists = new PlaylistsClient(client);
+    this.community = new CommunityClient(client);
+    this.shorts = new ShortsClient2(client);
+    this.trending = new TrendingClient2(client);
+    this.music = new MusicClient2(client);
+    this.reference = new ReferenceClient6(client);
+  }
+};
+
 // src/client.ts
 var ScrapeBadger = class {
   baseClient;
@@ -5075,6 +5681,8 @@ var ScrapeBadger = class {
   tiktok;
   /** eBay scraper API client — 12 endpoints across 18 markets */
   ebay;
+  /** YouTube scraper API client — 39 endpoints */
+  youtube;
   /**
    * Create a new ScrapeBadger client.
    *
@@ -5118,6 +5726,7 @@ var ScrapeBadger = class {
     this.shopee = new ShopeeClient(this.baseClient);
     this.tiktok = new TikTokClient(this.baseClient);
     this.ebay = new EbayClient(this.baseClient);
+    this.youtube = new YoutubeClient(this.baseClient);
   }
 };
 
@@ -5198,6 +5807,16 @@ exports.VintedSearchClient = SearchClient;
 exports.VintedUsersClient = UsersClient2;
 exports.WebClient = WebClient;
 exports.WebSocketStreamError = WebSocketStreamError;
+exports.YoutubeChannelsClient = ChannelsClient;
+exports.YoutubeClient = YoutubeClient;
+exports.YoutubeCommunityClient = CommunityClient;
+exports.YoutubeMusicClient = MusicClient2;
+exports.YoutubePlaylistsClient = PlaylistsClient;
+exports.YoutubeReferenceClient = ReferenceClient6;
+exports.YoutubeSearchClient = SearchClient8;
+exports.YoutubeShortsClient = ShortsClient2;
+exports.YoutubeTrendingClient = TrendingClient2;
+exports.YoutubeVideosClient = VideosClient3;
 exports.collectAll = collectAll;
 exports.verifyWebhookSignature = verifyWebhookSignature;
 //# sourceMappingURL=index.js.map