scrapebadger 0.24.2 → 0.26.0

package/dist/index.mjs

@@ -131,6 +131,39 @@ var BaseClient = class _BaseClient {
     const { data } = await this.requestRaw(path, options);
     return data;
   }
+  /**
+   * POST and return the undecoded response body.
+   *
+   * For endpoints that answer with something other than JSON — currently
+   * `/v1/web/scrape` with `raw_content: true`, which returns the scraped body
+   * itself. The normal path funnels a non-JSON response into
+   * `{ detail: await response.text() }`, which both loses the result and, for
+   * a binary payload, corrupts it: `text()` decodes bytes as UTF-8.
+   *
+   * Returns the raw bytes plus the response headers.
+   */
+  async postBinary(path, options = {}) {
+    const url = new URL(path, this.config.baseUrl);
+    const { body, headers = {} } = options;
+    const response = await this.fetchWithTimeout(url.toString(), {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "X-API-Key": this.config.apiKey,
+        "User-Agent": `scrapebadger-node/${SDK_VERSION}`,
+        ...headers
+      },
+      body: body ? JSON.stringify(body) : void 0
+    });
+    if (!response.ok) {
+      await this.handleResponse(response);
+    }
+    return {
+      bytes: new Uint8Array(await response.arrayBuffer()),
+      headers: response.headers,
+      status: response.status
+    };
+  }
   /**
    * Make an HTTP request and return both data and rate limit headers.
    */
@@ -2475,11 +2508,54 @@ var WebClient = class {
     if (options.aiPrompt !== void 0) body.ai_prompt = options.aiPrompt;
     if (options.rawContent !== void 0) body.raw_content = options.rawContent;
     if (options.skipBotDetection !== void 0) body.skip_bot_detection = options.skipBotDetection;
+    if (options.rawContent) {
+      return this.scrapeRaw(body);
+    }
     return this.client.request("/v1/web/scrape", {
       method: "POST",
       body
     });
   }
+  /**
+   * Run a `rawContent` scrape, whose response is not JSON.
+   *
+   * The normal path funnels a non-JSON response into `{ detail: text }`, so a
+   * raw scrape returned a result with no content — and for a binary target,
+   * `response.text()` decoded the bytes as UTF-8 and destroyed them. Read the
+   * body as bytes and rebuild the metadata from the `X-Scrape-*` headers the
+   * server sends in this mode.
+   */
+  async scrapeRaw(body) {
+    const { bytes, headers, status } = await this.client.postBinary("/v1/web/scrape", {
+      body
+    });
+    const int = (name) => {
+      const parsed = Number.parseInt(headers.get(name) ?? "", 10);
+      return Number.isNaN(parsed) ? 0 : parsed;
+    };
+    const mediaType = ((headers.get("content-type") ?? "").split(";")[0] ?? "").trim().toLowerCase();
+    const isText = mediaType.startsWith("text/") || ["application/json", "application/xml", "image/svg+xml"].includes(mediaType);
+    return {
+      success: headers.get("x-scrape-success") !== "0",
+      url: headers.get("x-scrape-url") ?? (typeof body.url === "string" ? body.url : ""),
+      status_code: int("x-scrape-status-code") || status,
+      content: isText ? new TextDecoder().decode(bytes) : null,
+      content_bytes: bytes,
+      content_base64: null,
+      is_binary: !isText,
+      content_type: mediaType || null,
+      format: headers.get("x-scrape-format") ?? "html",
+      engine_used: headers.get("x-scrape-engine") ?? "",
+      credits_used: int("x-credits-used"),
+      duration_ms: int("x-scrape-duration-ms"),
+      retries_used: int("x-scrape-retries"),
+      content_length: int("x-scrape-content-length") || bytes.length,
+      screenshot_url: null,
+      video_url: null,
+      headers: {},
+      blocking_detected: false
+    };
+  }
   /**
    * Extract structured data from a web page using AI.
    *
@@ -6744,6 +6820,150 @@ var LinkedInClient = class {
   }
 };
 
+// src/chatgpt/ask.ts
+var AskClient = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Ask ChatGPT a question and get the answer with its sources.
+   *
+   * Costs 20 credits. Typical latency is 20-25s ungrounded, 30-70s with web search.
+   *
+   * @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.chatgpt.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/chatgpt/ask", {
+      params: {
+        prompt: params.prompt,
+        country: params.country,
+        web_search: params.web_search
+      }
+    });
+  }
+};
+
+// src/chatgpt/brand.ts
+var BrandClient = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Analyse how a brand shows up in ChatGPT's answer to a prompt.
+   *
+   * Costs 25 credits.
+   *
+   * @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.chatgpt.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/chatgpt/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/chatgpt/reference.ts
+var ReferenceClient11 = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get the models chatgpt.com currently offers.
+   *
+   * Costs 1 credit.
+   *
+   * @param params - Optional parameters.
+   * @param params.country - ISO-3166 alpha-2 egress country (default: "US").
+   * @returns The available models.
+   *
+   * @example
+   * ```typescript
+   * const result = await client.chatgpt.reference.models({ country: "GB" });
+   * console.log(`${result.count} models`);
+   * for (const model of result.models) {
+   *   console.log(`${model.slug}: ${model.max_tokens} tokens`);
+   * }
+   * ```
+   */
+  async models(params = {}) {
+    return this.client.request("/v1/chatgpt/models", {
+      params: { country: params.country }
+    });
+  }
+};
+
+// src/chatgpt/client.ts
+var ChatGPTClient = class {
+  /** Client for asking ChatGPT a question */
+  ask;
+  /** Client for AEO/GEO brand-visibility analysis */
+  brand;
+  /** Client for reference data (available models) */
+  reference;
+  /**
+   * Create a new ChatGPT client.
+   *
+   * @param client - The base HTTP client for making requests.
+   */
+  constructor(client) {
+    this.ask = new AskClient(client);
+    this.brand = new BrandClient(client);
+    this.reference = new ReferenceClient11(client);
+  }
+};
+
 // src/client.ts
 var ScrapeBadger = class {
   baseClient;
@@ -6783,6 +7003,8 @@ var ScrapeBadger = class {
   depop;
   /** LinkedIn scraper API client — 11 no-auth endpoints (jobs, company, school, profile, post, article, learning, geo) */
   linkedin;
+  /** ChatGPT scraper API client — ask, brand visibility, models (the real chatgpt.com, anonymous) */
+  chatgpt;
   /**
    * Create a new ScrapeBadger client.
    *
@@ -6835,9 +7057,10 @@ var ScrapeBadger = class {
     this.loopnet = new LoopNetClient(this.baseClient);
     this.depop = new DepopClient(this.baseClient);
     this.linkedin = new LinkedInClient(this.baseClient);
+    this.chatgpt = new ChatGPTClient(this.baseClient);
   }
 };
 
-export { AccountRestrictedError, AmazonClient, ListingsClient as AmazonListingsClient, ProductsClient2 as AmazonProductsClient, ReferenceClient2 as AmazonReferenceClient, SearchClient4 as AmazonSearchClient, SellersClient as AmazonSellersClient, AuthenticationError, CommunitiesClient, ConflictError, DepopClient, CategoriesClient as EbayCategoriesClient, EbayClient, ItemsClient2 as EbayItemsClient, ReferenceClient5 as EbayReferenceClient, SearchClient7 as EbaySearchClient, SellersClient2 as EbaySellersClient, GeoClient, AiModeClient as GoogleAiModeClient, AutocompleteClient as GoogleAutocompleteClient, GoogleClient, FinanceClient as GoogleFinanceClient, FlightsClient as GoogleFlightsClient, HotelsClient as GoogleHotelsClient, ImagesClient as GoogleImagesClient, JobsClient as GoogleJobsClient, LensClient as GoogleLensClient, MapsClient as GoogleMapsClient, NewsClient as GoogleNewsClient, PatentsClient as GooglePatentsClient, ProductsClient as GoogleProductsClient, ScholarClient as GoogleScholarClient, SearchClient2 as GoogleSearchClient, ShoppingClient as GoogleShoppingClient, ShortsClient as GoogleShortsClient, TrendsClient2 as GoogleTrendsClient, VideosClient as GoogleVideosClient, ImmobiliareClient, InsufficientCreditsError, AdsClient2 as LeboncoinAdsClient, LeboncoinClient, ReferenceClient8 as LeboncoinReferenceClient, SearchClient10 as LeboncoinSearchClient, SellersClient3 as LeboncoinSellersClient, LinkedInClient, ListsClient, BrokersClient as LoopNetBrokersClient, LoopNetClient, ListingsClient2 as LoopNetListingsClient, ReferenceClient10 as LoopNetReferenceClient, SearchClient12 as LoopNetSearchClient, NotFoundError, RateLimitError, RealtorClient, PropertiesClient as RealtorPropertiesClient, ReferenceClient7 as RealtorReferenceClient, SearchClient9 as RealtorSearchClient, RedditClient, PostsClient as RedditPostsClient, SearchClient3 as RedditSearchClient, SubredditsClient as RedditSubredditsClient, UsersClient3 as RedditUsersClient, RedfinClient, ScrapeBadger, ScrapeBadgerError, ServerError, ShopeeClient, ProductsClient3 as ShopeeProductsClient, ReferenceClient3 as ShopeeReferenceClient, ReviewsClient as ShopeeReviewsClient, SearchClient5 as ShopeeSearchClient, SpacesClient, StreamClient, AdsClient as TikTokAdsClient, TikTokClient, HashtagsClient as TikTokHashtagsClient, MusicClient as TikTokMusicClient, ReferenceClient4 as TikTokReferenceClient, SearchClient6 as TikTokSearchClient, TrendingClient as TikTokTrendingClient, UsersClient4 as TikTokUsersClient, VideosClient2 as TikTokVideosClient, TimeoutError, TrendsClient, TweetsClient, TwitterClient, UsersClient, ValidationError, VintedClient, ItemsClient as VintedItemsClient, ReferenceClient as VintedReferenceClient, SearchClient as VintedSearchClient, UsersClient2 as VintedUsersClient, WebClient, WebSocketStreamError, ChannelsClient as YoutubeChannelsClient, YoutubeClient, CommunityClient as YoutubeCommunityClient, MusicClient2 as YoutubeMusicClient, PlaylistsClient as YoutubePlaylistsClient, ReferenceClient6 as YoutubeReferenceClient, SearchClient8 as YoutubeSearchClient, ShortsClient2 as YoutubeShortsClient, TrendingClient2 as YoutubeTrendingClient, VideosClient3 as YoutubeVideosClient, AgentClient as ZillowAgentClient, ZillowClient, PropertiesClient2 as ZillowPropertiesClient, ReferenceClient9 as ZillowReferenceClient, SearchClient11 as ZillowSearchClient, collectAll, verifyWebhookSignature };
+export { AccountRestrictedError, AmazonClient, ListingsClient as AmazonListingsClient, ProductsClient2 as AmazonProductsClient, ReferenceClient2 as AmazonReferenceClient, SearchClient4 as AmazonSearchClient, SellersClient as AmazonSellersClient, AuthenticationError, AskClient as ChatGPTAskClient, BrandClient as ChatGPTBrandClient, ChatGPTClient, ReferenceClient11 as ChatGPTReferenceClient, CommunitiesClient, ConflictError, DepopClient, CategoriesClient as EbayCategoriesClient, EbayClient, ItemsClient2 as EbayItemsClient, ReferenceClient5 as EbayReferenceClient, SearchClient7 as EbaySearchClient, SellersClient2 as EbaySellersClient, GeoClient, AiModeClient as GoogleAiModeClient, AutocompleteClient as GoogleAutocompleteClient, GoogleClient, FinanceClient as GoogleFinanceClient, FlightsClient as GoogleFlightsClient, HotelsClient as GoogleHotelsClient, ImagesClient as GoogleImagesClient, JobsClient as GoogleJobsClient, LensClient as GoogleLensClient, MapsClient as GoogleMapsClient, NewsClient as GoogleNewsClient, PatentsClient as GooglePatentsClient, ProductsClient as GoogleProductsClient, ScholarClient as GoogleScholarClient, SearchClient2 as GoogleSearchClient, ShoppingClient as GoogleShoppingClient, ShortsClient as GoogleShortsClient, TrendsClient2 as GoogleTrendsClient, VideosClient as GoogleVideosClient, ImmobiliareClient, InsufficientCreditsError, AdsClient2 as LeboncoinAdsClient, LeboncoinClient, ReferenceClient8 as LeboncoinReferenceClient, SearchClient10 as LeboncoinSearchClient, SellersClient3 as LeboncoinSellersClient, LinkedInClient, ListsClient, BrokersClient as LoopNetBrokersClient, LoopNetClient, ListingsClient2 as LoopNetListingsClient, ReferenceClient10 as LoopNetReferenceClient, SearchClient12 as LoopNetSearchClient, NotFoundError, RateLimitError, RealtorClient, PropertiesClient as RealtorPropertiesClient, ReferenceClient7 as RealtorReferenceClient, SearchClient9 as RealtorSearchClient, RedditClient, PostsClient as RedditPostsClient, SearchClient3 as RedditSearchClient, SubredditsClient as RedditSubredditsClient, UsersClient3 as RedditUsersClient, RedfinClient, ScrapeBadger, ScrapeBadgerError, ServerError, ShopeeClient, ProductsClient3 as ShopeeProductsClient, ReferenceClient3 as ShopeeReferenceClient, ReviewsClient as ShopeeReviewsClient, SearchClient5 as ShopeeSearchClient, SpacesClient, StreamClient, AdsClient as TikTokAdsClient, TikTokClient, HashtagsClient as TikTokHashtagsClient, MusicClient as TikTokMusicClient, ReferenceClient4 as TikTokReferenceClient, SearchClient6 as TikTokSearchClient, TrendingClient as TikTokTrendingClient, UsersClient4 as TikTokUsersClient, VideosClient2 as TikTokVideosClient, TimeoutError, TrendsClient, TweetsClient, TwitterClient, UsersClient, ValidationError, VintedClient, ItemsClient as VintedItemsClient, ReferenceClient as VintedReferenceClient, SearchClient as VintedSearchClient, UsersClient2 as VintedUsersClient, WebClient, WebSocketStreamError, ChannelsClient as YoutubeChannelsClient, YoutubeClient, CommunityClient as YoutubeCommunityClient, MusicClient2 as YoutubeMusicClient, PlaylistsClient as YoutubePlaylistsClient, ReferenceClient6 as YoutubeReferenceClient, SearchClient8 as YoutubeSearchClient, ShortsClient2 as YoutubeShortsClient, TrendingClient2 as YoutubeTrendingClient, VideosClient3 as YoutubeVideosClient, AgentClient as ZillowAgentClient, ZillowClient, PropertiesClient2 as ZillowPropertiesClient, ReferenceClient9 as ZillowReferenceClient, SearchClient11 as ZillowSearchClient, collectAll, verifyWebhookSignature };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map