scrapebadger 0.33.1 → 0.35.0

package/dist/index.js

@@ -6291,8 +6291,160 @@ var BaiduClient = class {
   }
 };
 
-// src/yandex/search.ts
+// src/yahoo/search.ts
 var SearchClient12 = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Search yahoo.com — the web SERP.
+   *
+   * Yahoo serves 7 organic results per page, so `offset` moves in steps of 7
+   * (page 2 is `offset: 7`). There is no page-size parameter.
+   *
+   * @param query - Search keywords, e.g. `"coffee machine"`.
+   * @param params - Optional market, offset and safe-search filter.
+   * @returns A page of organic results, ads and related searches.
+   */
+  async search(query, params = {}) {
+    return this.client.request("/v1/yahoo/search", {
+      params: {
+        query,
+        market: params.market,
+        offset: params.offset,
+        safe_search: params.safe_search
+      }
+    });
+  }
+  /**
+   * Yahoo search-box suggestions — the cheapest call in this API.
+   *
+   * @param query - Partial search term, e.g. `"coff"`.
+   * @param params - Optional market.
+   */
+  async autocomplete(query, params = {}) {
+    return this.client.request("/v1/yahoo/autocomplete", {
+      params: {
+        query,
+        market: params.market
+      }
+    });
+  }
+};
+
+// src/yahoo/media.ts
+var MediaClient4 = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Search Yahoo images.
+   *
+   * Yahoo renders ~60 tiles server-side with no native page-size parameter,
+   * so `count` trims the list rather than paginating.
+   *
+   * @param query - Search keywords, e.g. `"cats"`.
+   * @param params - Optional market and count.
+   * @returns Full-size image URLs, thumbnails, pixel dimensions and the
+   *   source page each image came from.
+   */
+  async images(query, params = {}) {
+    return this.client.request("/v1/yahoo/images", {
+      params: {
+        query,
+        market: params.market,
+        count: params.count
+      }
+    });
+  }
+  /**
+   * Search Yahoo videos.
+   *
+   * Like images, Yahoo has no native page-size parameter here, so `count`
+   * trims the returned list.
+   *
+   * @param query - Search keywords, e.g. `"cats"`.
+   * @param params - Optional market and count.
+   * @returns Video URLs, thumbnails, duration, host platform and view counts.
+   */
+  async videos(query, params = {}) {
+    return this.client.request("/v1/yahoo/videos", {
+      params: {
+        query,
+        market: params.market,
+        count: params.count
+      }
+    });
+  }
+};
+
+// src/yahoo/news.ts
+var NewsClient3 = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Search the Yahoo news vertical.
+   *
+   * @param query - Search keywords, e.g. `"artificial intelligence"`.
+   * @param params - Optional market.
+   * @returns Articles carrying publisher, syndication source and real URLs.
+   *   `published` is a relative age string (`"26 minutes ago"`) — Yahoo
+   *   renders no absolute date.
+   */
+  async news(query, params = {}) {
+    return this.client.request("/v1/yahoo/news", {
+      params: {
+        query,
+        market: params.market
+      }
+    });
+  }
+};
+
+// src/yahoo/reference.ts
+var ReferenceClient9 = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get the supported Yahoo markets.
+   *
+   * Yahoo Japan (`search.yahoo.co.jp`) is a separate engine and is not
+   * covered by this API.
+   *
+   * @returns Every Yahoo market code, name, country and regional search host.
+   */
+  async markets() {
+    return this.client.request("/v1/yahoo/markets");
+  }
+};
+
+// src/yahoo/client.ts
+var YahooClient = class {
+  /** Client for web search and search-box autocomplete */
+  search;
+  /** Client for image search and video search */
+  media;
+  /** Client for the news vertical */
+  news;
+  /** Client for reference data (markets) */
+  reference;
+  /**
+   * Create a new Yahoo client.
+   *
+   * @param client - The base HTTP client for making requests.
+   */
+  constructor(client) {
+    this.search = new SearchClient12(client);
+    this.media = new MediaClient4(client);
+    this.news = new NewsClient3(client);
+    this.reference = new ReferenceClient9(client);
+  }
+};
+
+// src/yandex/search.ts
+var SearchClient13 = class {
   constructor(client) {
     this.client = client;
   }
@@ -6353,7 +6505,7 @@ var ImagesClient2 = class {
 };
 
 // src/yandex/reference.ts
-var ReferenceClient9 = class {
+var ReferenceClient10 = class {
   constructor(client) {
     this.client = client;
   }
@@ -6379,14 +6531,14 @@ var YandexClient = class {
    * @param client - The base HTTP client for making requests.
    */
   constructor(client) {
-    this.search = new SearchClient12(client);
+    this.search = new SearchClient13(client);
     this.images = new ImagesClient2(client);
-    this.reference = new ReferenceClient9(client);
+    this.reference = new ReferenceClient10(client);
   }
 };
 
 // src/youtube/search.ts
-var SearchClient13 = class {
+var SearchClient14 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -6911,7 +7063,7 @@ var MusicClient2 = class {
 };
 
 // src/youtube/reference.ts
-var ReferenceClient10 = class {
+var ReferenceClient11 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -6979,7 +7131,7 @@ var YoutubeClient = class {
    * @param client - The base HTTP client for making requests.
    */
   constructor(client) {
-    this.search = new SearchClient13(client);
+    this.search = new SearchClient14(client);
     this.videos = new VideosClient3(client);
     this.channels = new ChannelsClient(client);
     this.playlists = new PlaylistsClient(client);
@@ -6987,12 +7139,12 @@ var YoutubeClient = class {
     this.shorts = new ShortsClient2(client);
     this.trending = new TrendingClient2(client);
     this.music = new MusicClient2(client);
-    this.reference = new ReferenceClient10(client);
+    this.reference = new ReferenceClient11(client);
   }
 };
 
 // src/realtor/search.ts
-var SearchClient14 = class {
+var SearchClient15 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -7066,7 +7218,7 @@ var PropertiesClient = class {
 };
 
 // src/realtor/reference.ts
-var ReferenceClient11 = class {
+var ReferenceClient12 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -7095,14 +7247,14 @@ var RealtorClient = class {
    * @param client - The base HTTP client for making requests.
    */
   constructor(client) {
-    this.search = new SearchClient14(client);
+    this.search = new SearchClient15(client);
     this.properties = new PropertiesClient(client);
-    this.reference = new ReferenceClient11(client);
+    this.reference = new ReferenceClient12(client);
   }
 };
 
 // src/leboncoin/search.ts
-var SearchClient15 = class {
+var SearchClient16 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -7204,7 +7356,7 @@ var SellersClient4 = class {
 };
 
 // src/leboncoin/reference.ts
-var ReferenceClient12 = class {
+var ReferenceClient13 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -7275,15 +7427,15 @@ var LeboncoinClient = class {
    * @param client - The base HTTP client for making requests.
    */
   constructor(client) {
-    this.search = new SearchClient15(client);
+    this.search = new SearchClient16(client);
     this.ads = new AdsClient2(client);
     this.sellers = new SellersClient4(client);
-    this.reference = new ReferenceClient12(client);
+    this.reference = new ReferenceClient13(client);
   }
 };
 
 // src/zillow/search.ts
-var SearchClient16 = class {
+var SearchClient17 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -7387,7 +7539,7 @@ var AgentClient = class {
 };
 
 // src/zillow/reference.ts
-var ReferenceClient13 = class {
+var ReferenceClient14 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -7418,10 +7570,10 @@ var ZillowClient = class {
    * @param client - The base HTTP client for making requests.
    */
   constructor(client) {
-    this.search = new SearchClient16(client);
+    this.search = new SearchClient17(client);
     this.properties = new PropertiesClient2(client);
     this.agent = new AgentClient(client);
-    this.reference = new ReferenceClient13(client);
+    this.reference = new ReferenceClient14(client);
   }
 };
 
@@ -7556,7 +7708,7 @@ var ImmobiliareClient = class {
 };
 
 // src/loopnet/search.ts
-var SearchClient17 = class {
+var SearchClient18 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -7637,7 +7789,7 @@ var BrokersClient = class {
 };
 
 // src/loopnet/reference.ts
-var ReferenceClient14 = class {
+var ReferenceClient15 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -7680,10 +7832,10 @@ var LoopNetClient = class {
    * @param client - The base HTTP client for making requests.
    */
   constructor(client) {
-    this.search = new SearchClient17(client);
+    this.search = new SearchClient18(client);
     this.listings = new ListingsClient2(client);
     this.brokers = new BrokersClient(client);
-    this.reference = new ReferenceClient14(client);
+    this.reference = new ReferenceClient15(client);
   }
 };
 
@@ -8044,7 +8196,7 @@ var BrandClient = class {
 };
 
 // src/chatgpt/reference.ts
-var ReferenceClient15 = class {
+var ReferenceClient16 = class {
   client;
   constructor(client) {
     this.client = client;
@@ -8090,7 +8242,113 @@ var ChatGPTClient = class {
   constructor(client) {
     this.ask = new AskClient(client);
     this.brand = new BrandClient(client);
-    this.reference = new ReferenceClient15(client);
+    this.reference = new ReferenceClient16(client);
+  }
+};
+
+// src/gemini/ask.ts
+var AskClient2 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Ask Gemini a question and get the answer with its sources.
+   *
+   * @param params - Ask parameters.
+   * @param params.prompt - The prompt to send (max 4096 characters).
+   * @param params.country - ISO-3166 alpha-2 egress country (default: "US").
+   * @param params.web_search - "auto", "force", or "off" (default: "auto").
+   * @returns The answer, its citations, and the full retrieved search set.
+   *
+   * @example
+   * ```typescript
+   * const result = await client.gemini.ask.ask({
+   *   prompt: "what is the best CRM for a 10-person startup?",
+   *   country: "GB",
+   *   web_search: "force",
+   * });
+   * console.log(result.web_search_triggered, result.model);
+   * for (const source of result.search_results) {
+   *   console.log(`${source.cited ? "*" : " "} ${source.url}`);
+   * }
+   * ```
+   */
+  async ask(params) {
+    return this.client.request("/v1/gemini/ask", {
+      params: {
+        prompt: params.prompt,
+        country: params.country,
+        web_search: params.web_search
+      }
+    });
+  }
+};
+
+// src/gemini/brand.ts
+var BrandClient2 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Analyse how a brand shows up in Gemini's answer to a prompt.
+   *
+   * @param params - Brand-visibility parameters.
+   * @param params.prompt - The prompt to send (max 4096 characters).
+   * @param params.brand - The brand name to look for in the answer.
+   * @param params.domain - The brand's domain, used to detect brand citations.
+   * @param params.aliases - Other spellings that should count as mentions.
+   * @param params.competitors - Competitors to measure share of voice against.
+   * @param params.country - ISO-3166 alpha-2 egress country (default: "US").
+   * @param params.web_search - "auto", "force", or "off" (default: "force").
+   * @returns The brand analysis plus the answer and its citations.
+   *
+   * @example
+   * ```typescript
+   * const result = await client.gemini.brand.visibility({
+   *   prompt: "which proxy provider should I use?",
+   *   brand: "ScrapeBadger",
+   *   domain: "scrapebadger.com",
+   *   aliases: ["Scrape Badger"],
+   *   competitors: ["Bright Data", "Oxylabs"],
+   *   country: "DE",
+   * });
+   * console.log(`position score: ${result.position_score}`);
+   * for (const competitor of result.competitors) {
+   *   console.log(`${competitor.name}: ${competitor.mention_count}`);
+   * }
+   * ```
+   */
+  async visibility(params) {
+    return this.client.request("/v1/gemini/brand-visibility", {
+      params: {
+        prompt: params.prompt,
+        brand: params.brand,
+        domain: params.domain,
+        aliases: params.aliases?.length ? params.aliases.join(",") : void 0,
+        competitors: params.competitors?.length ? params.competitors.join(",") : void 0,
+        country: params.country,
+        web_search: params.web_search
+      }
+    });
+  }
+};
+
+// src/gemini/client.ts
+var GeminiClient = class {
+  /** Client for asking Gemini a question */
+  ask;
+  /** Client for AEO/GEO brand-visibility analysis */
+  brand;
+  /**
+   * Create a new Gemini client.
+   *
+   * @param client - The base HTTP client for making requests.
+   */
+  constructor(client) {
+    this.ask = new AskClient2(client);
+    this.brand = new BrandClient2(client);
   }
 };
 
@@ -8129,6 +8387,8 @@ var ScrapeBadger = class {
   bing;
   /** Baidu scraper API client — search, news, images, autocomplete (baidu.com, China's #1 search engine) */
   baidu;
+  /** Yahoo scraper API client — 6 endpoints (search, images, videos, news, autocomplete, markets) across 35 markets */
+  yahoo;
   /** Yandex scraper API client — web search, image search, reverse-image (CBIR), markets (tr/com/ru/by/kz/uz) */
   yandex;
   /** YouTube scraper API client — 39 endpoints */
@@ -8149,6 +8409,8 @@ var ScrapeBadger = class {
   linkedin;
   /** ChatGPT scraper API client — ask, brand visibility, models (the real chatgpt.com, anonymous) */
   chatgpt;
+  /** Gemini scraper API client — ask, brand visibility (the real gemini.google.com, anonymous) */
+  gemini;
   /**
    * Create a new ScrapeBadger client.
    *
@@ -8199,6 +8461,7 @@ var ScrapeBadger = class {
     this.duckduckgo = new DuckDuckGoClient(this.baseClient);
     this.bing = new BingClient(this.baseClient);
     this.baidu = new BaiduClient(this.baseClient);
+    this.yahoo = new YahooClient(this.baseClient);
     this.yandex = new YandexClient(this.baseClient);
     this.youtube = new YoutubeClient(this.baseClient);
     this.realtor = new RealtorClient(this.baseClient);
@@ -8209,6 +8472,7 @@ var ScrapeBadger = class {
     this.depop = new DepopClient(this.baseClient);
     this.linkedin = new LinkedInClient(this.baseClient);
     this.chatgpt = new ChatGPTClient(this.baseClient);
+    this.gemini = new GeminiClient(this.baseClient);
   }
 };
 
@@ -8230,7 +8494,7 @@ exports.BingSearchClient = SearchClient11;
 exports.ChatGPTAskClient = AskClient;
 exports.ChatGPTBrandClient = BrandClient;
 exports.ChatGPTClient = ChatGPTClient;
-exports.ChatGPTReferenceClient = ReferenceClient15;
+exports.ChatGPTReferenceClient = ReferenceClient16;
 exports.CommunitiesClient = CommunitiesClient;
 exports.ConflictError = ConflictError;
 exports.DepopClient = DepopClient;
@@ -8244,6 +8508,9 @@ exports.EbayItemsClient = ItemsClient2;
 exports.EbayReferenceClient = ReferenceClient5;
 exports.EbaySearchClient = SearchClient8;
 exports.EbaySellersClient = SellersClient2;
+exports.GeminiAskClient = AskClient2;
+exports.GeminiBrandClient = BrandClient2;
+exports.GeminiClient = GeminiClient;
 exports.GeoClient = GeoClient;
 exports.GoogleAiModeClient = AiModeClient;
 exports.GoogleAutocompleteClient = AutocompleteClient;
@@ -8275,22 +8542,22 @@ exports.InstagramUsersClient = UsersClient4;
 exports.InsufficientCreditsError = InsufficientCreditsError;
 exports.LeboncoinAdsClient = AdsClient2;
 exports.LeboncoinClient = LeboncoinClient;
-exports.LeboncoinReferenceClient = ReferenceClient12;
-exports.LeboncoinSearchClient = SearchClient15;
+exports.LeboncoinReferenceClient = ReferenceClient13;
+exports.LeboncoinSearchClient = SearchClient16;
 exports.LeboncoinSellersClient = SellersClient4;
 exports.LinkedInClient = LinkedInClient;
 exports.ListsClient = ListsClient;
 exports.LoopNetBrokersClient = BrokersClient;
 exports.LoopNetClient = LoopNetClient;
 exports.LoopNetListingsClient = ListingsClient2;
-exports.LoopNetReferenceClient = ReferenceClient14;
-exports.LoopNetSearchClient = SearchClient17;
+exports.LoopNetReferenceClient = ReferenceClient15;
+exports.LoopNetSearchClient = SearchClient18;
 exports.NotFoundError = NotFoundError;
 exports.RateLimitError = RateLimitError;
 exports.RealtorClient = RealtorClient;
 exports.RealtorPropertiesClient = PropertiesClient;
-exports.RealtorReferenceClient = ReferenceClient11;
-exports.RealtorSearchClient = SearchClient14;
+exports.RealtorReferenceClient = ReferenceClient12;
+exports.RealtorSearchClient = SearchClient15;
 exports.RedditClient = RedditClient;
 exports.RedditPostsClient = PostsClient;
 exports.RedditSearchClient = SearchClient3;
@@ -8335,25 +8602,30 @@ exports.WalmartSellersClient = SellersClient3;
 exports.WalmartStoresClient = StoresClient;
 exports.WebClient = WebClient;
 exports.WebSocketStreamError = WebSocketStreamError;
+exports.YahooClient = YahooClient;
+exports.YahooMediaClient = MediaClient4;
+exports.YahooNewsClient = NewsClient3;
+exports.YahooReferenceClient = ReferenceClient9;
+exports.YahooSearchClient = SearchClient12;
 exports.YandexClient = YandexClient;
 exports.YandexImagesClient = ImagesClient2;
-exports.YandexReferenceClient = ReferenceClient9;
-exports.YandexSearchClient = SearchClient12;
+exports.YandexReferenceClient = ReferenceClient10;
+exports.YandexSearchClient = SearchClient13;
 exports.YoutubeChannelsClient = ChannelsClient;
 exports.YoutubeClient = YoutubeClient;
 exports.YoutubeCommunityClient = CommunityClient;
 exports.YoutubeMusicClient = MusicClient2;
 exports.YoutubePlaylistsClient = PlaylistsClient;
-exports.YoutubeReferenceClient = ReferenceClient10;
-exports.YoutubeSearchClient = SearchClient13;
+exports.YoutubeReferenceClient = ReferenceClient11;
+exports.YoutubeSearchClient = SearchClient14;
 exports.YoutubeShortsClient = ShortsClient2;
 exports.YoutubeTrendingClient = TrendingClient2;
 exports.YoutubeVideosClient = VideosClient3;
 exports.ZillowAgentClient = AgentClient;
 exports.ZillowClient = ZillowClient;
 exports.ZillowPropertiesClient = PropertiesClient2;
-exports.ZillowReferenceClient = ReferenceClient13;
-exports.ZillowSearchClient = SearchClient16;
+exports.ZillowReferenceClient = ReferenceClient14;
+exports.ZillowSearchClient = SearchClient17;
 exports.collectAll = collectAll;
 exports.verifyWebhookSignature = verifyWebhookSignature;
 //# sourceMappingURL=index.js.map