scavio 0.23.1 → 0.24.1

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 /**
- * Amazon moved to a new upstream in 2026-07 and the API now returns a
- * normalized shape instead of the old raw provider payload. Nine options went
- * with the old provider: language, currency, device, sort_by, pages,
+ * The Amazon API changed in 2026-07 and now returns a normalized shape
+ * instead of the old raw payload. Nine options were removed: language, currency, device, sort_by, pages,
  * category_id, merchant_id, zip_code and autoselect_variant. They are removed
  * rather than kept as no-ops - notably `sort_by`, which the marketplace was
  * verified to ignore entirely (every sort value returned the same unordered
@@ -57,9 +56,9 @@ declare class AmazonNamespace {
 }
 
 /**
- * Google endpoints (scrape.do engine, /api/v2/google). A faithful passthrough
- * that returns Google's full response. Every endpoint costs 1 credit. Any
- * additional scrape.do parameter can be added to the options object.
+ * Google endpoints (/api/v2/google). A faithful passthrough that returns
+ * Google's full response. Every endpoint costs 1 credit. Any additional
+ * API parameter can be added to the options object.
  * See https://scavio.dev/docs/search-api.
  */
 interface GoogleSearchOptions {
@@ -981,14 +980,17 @@ declare class TikTokShopNamespace {
 }
 
 /**
- * Instagram endpoints (/api/v1/instagram). Credit cost varies by endpoint,
- * in three tiers:
- * - 2: `userPosts`
- * - 8: `post`, `commentReplies`
- * - 10: everything else (`profile`, `userReels`, `userTagged`, `userStories`,
- *   `postComments`, `searchUsers`, `searchHashtags`, `userFollowers`,
- *   `userFollowings`)
- * See https://scavio.dev/docs/instagram-api.
+ * Instagram endpoints (/api/v1/instagram). Typical credit cost per call:
+ * - 1: `profile`, `musicPosts` (per page), `userReels` and `userTagged`
+ *   (2 the first time a username is looked up)
+ * - 2: everything else - `userPosts`, `userStories`, `post`, `postComments`,
+ *   `commentReplies`, `searchUsers`, `searchHashtags`, `userFollowers`,
+ *   `userFollowings`, `userHighlights`, `highlightStories`, `searchReels`,
+ *   `searchMusic`, `searchLocations`, `userSimilar`, `postLikers`
+ * - 8: `searchUsers` / `searchHashtags` when a `cursor` is sent
+ *
+ * A request can cost up to 10 when it needs extra work; `credits_used` in the
+ * response is the exact charge. See https://scavio.dev/docs/instagram-api.
  */
 interface InstagramProfileOptions {
     /** Instagram username (without the @). */
@@ -1062,21 +1064,80 @@ interface InstagramFollowOptions {
     cursor?: string;
     [key: string]: unknown;
 }
+interface InstagramUserRefOptions {
+    /** Instagram username (without the @). */
+    username?: string;
+    /** Instagram numeric user id. */
+    user_id?: string;
+    [key: string]: unknown;
+}
+interface InstagramHighlightStoriesOptions {
+    /** Highlight id from `userHighlights`, with or without the `highlight:` prefix. */
+    highlight_id: string;
+    [key: string]: unknown;
+}
+interface InstagramKeywordOptions {
+    /** Search keyword (1-500 characters). */
+    keyword: string;
+    [key: string]: unknown;
+}
+interface InstagramMusicPostsOptions {
+    /** Numeric audio id (the `id` field from `searchMusic`). */
+    music_id: string;
+    /** Pagination cursor (`paging_info.max_id`) from a prior response. */
+    cursor?: string;
+    [key: string]: unknown;
+}
+interface InstagramPostLikersOptions {
+    /** Instagram shortcode (from the post URL). */
+    shortcode?: string;
+    /** Full Instagram post URL. */
+    url?: string;
+    [key: string]: unknown;
+}
 declare class InstagramNamespace {
     private client;
     constructor(client: Scavio);
+    /** Get a user profile by username or user_id. 1 credit. */
     profile(options: InstagramProfileOptions): Promise<Record<string, unknown>>;
+    /** Get a user's posts, about 12 per page; page with `data.pagination_token`. 2 credits per page. */
     userPosts(options: InstagramUserFeedOptions): Promise<Record<string, unknown>>;
+    /** Get a user's Reels. 1 credit (2 the first time a username is looked up). */
     userReels(options: InstagramUserFeedOptions): Promise<Record<string, unknown>>;
+    /** Get posts a user is tagged in. 1 credit (2 the first time a username is looked up). */
     userTagged(options: InstagramUserFeedOptions): Promise<Record<string, unknown>>;
+    /** Get a user's active stories. 2 credits. */
     userStories(options: InstagramStoriesOptions): Promise<Record<string, unknown>>;
+    /** Get a single post by url, media_id or shortcode. 2 credits. */
     post(options: InstagramPostOptions): Promise<Record<string, unknown>>;
+    /** Get comments on a post; page with `next_min_id`. 2 credits per page. */
     postComments(options: InstagramPostCommentsOptions): Promise<Record<string, unknown>>;
+    /** Get replies to a comment. 2 credits. */
     commentReplies(options: InstagramCommentRepliesOptions): Promise<Record<string, unknown>>;
+    /** Search users by keyword. 2 credits; 8 when a `cursor` is sent. */
     searchUsers(options: InstagramSearchOptions): Promise<Record<string, unknown>>;
+    /** Search hashtags by keyword. 2 credits; 8 when a `cursor` is sent. */
     searchHashtags(options: InstagramSearchOptions): Promise<Record<string, unknown>>;
+    /** Get a user's followers; page with `next_max_id`. 2 credits per page. */
     userFollowers(options: InstagramFollowOptions): Promise<Record<string, unknown>>;
+    /** Get the accounts a user follows; page with `next_max_id`. 2 credits per page. */
     userFollowings(options: InstagramFollowOptions): Promise<Record<string, unknown>>;
+    /** List a user's story highlights (id, title, cover, item count). 2 credits. */
+    userHighlights(options: InstagramUserRefOptions): Promise<Record<string, unknown>>;
+    /** Get every story saved in one highlight, with media URLs. 2 credits. */
+    highlightStories(options: InstagramHighlightStoriesOptions): Promise<Record<string, unknown>>;
+    /** Search Reels by keyword; page with `pagination_token`. 2 credits per page. */
+    searchReels(options: InstagramSearchOptions): Promise<Record<string, unknown>>;
+    /** Search audio tracks by song or artist; returns the id `musicPosts` takes. 2 credits. */
+    searchMusic(options: InstagramKeywordOptions): Promise<Record<string, unknown>>;
+    /** Get the Reels that use an audio track, plus its total reel count. 1 credit per page. */
+    musicPosts(options: InstagramMusicPostsOptions): Promise<Record<string, unknown>>;
+    /** Search places by name (id, name, address, coordinates). 2 credits. */
+    searchLocations(options: InstagramKeywordOptions): Promise<Record<string, unknown>>;
+    /** Get accounts similar to a user. Most creator accounts have them; some brand accounts return none. 2 credits. */
+    userSimilar(options: InstagramUserRefOptions): Promise<Record<string, unknown>>;
+    /** Get accounts that liked a post (up to about 1,000) and its total like count. 2 credits. */
+    postLikers(options: InstagramPostLikersOptions): Promise<Record<string, unknown>>;
 }
 
 interface WalmartSearchOptions {
@@ -1665,18 +1726,18 @@ interface LinkedInPostCommentsOptions extends LinkedInPostOptions {
     /** 1-based page number. Page size varies, so page until a page comes back empty. */
     page?: number;
 }
-/** @deprecated Retired upstream; always returns HTTP 410. */
+/** @deprecated Retired; always returns HTTP 410. */
 interface LinkedInPersonContactOptions {
     username?: string;
     [key: string]: unknown;
 }
-/** @deprecated Retired upstream; always returns HTTP 410. */
+/** @deprecated Retired; always returns HTTP 410. */
 interface LinkedInCompanyRefOptions {
     company_id?: string;
     company?: string;
     [key: string]: unknown;
 }
-/** @deprecated Retired upstream; always returns HTTP 410. */
+/** @deprecated Retired; always returns HTTP 410. */
 interface LinkedInSearchPeopleOptions {
     search?: string;
     title?: string;
@@ -1685,7 +1746,7 @@ interface LinkedInSearchPeopleOptions {
     location?: string;
     [key: string]: unknown;
 }
-/** @deprecated Retired upstream; always returns HTTP 410. */
+/** @deprecated Retired; always returns HTTP 410. */
 interface LinkedInSearchPostsOptions {
     search?: string;
     [key: string]: unknown;
@@ -1718,28 +1779,28 @@ declare class LinkedInNamespace {
     /** Comments with their replies. Page size varies - keep paging until empty. */
     postComments(options: LinkedInPostCommentsOptions): Promise<Record<string, unknown>>;
     /**
-     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * @deprecated Retired. Always returns HTTP 410 and is
      * never billed.
      */
     personContact(options: LinkedInPersonContactOptions): Promise<Record<string, unknown>>;
     /**
-     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * @deprecated Retired. Always returns HTTP 410 and is
      * never billed. `company()` returns `featured_employees`, a small sample of
      * staff profiles.
      */
     companyPeople(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
     /**
-     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * @deprecated Retired. Always returns HTTP 410 and is
      * never billed. Use `searchJobs()` with the company name as the search term.
      */
     companyJobs(options: LinkedInCompanyRefOptions): Promise<Record<string, unknown>>;
     /**
-     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * @deprecated Retired. Always returns HTTP 410 and is
      * never billed.
      */
     searchPeople(options: LinkedInSearchPeopleOptions): Promise<Record<string, unknown>>;
     /**
-     * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+     * @deprecated Retired. Always returns HTTP 410 and is
      * never billed.
      */
     searchPosts(options: LinkedInSearchPostsOptions): Promise<Record<string, unknown>>;
@@ -1753,7 +1814,7 @@ interface ThreadsProfileOptions {
     user_id?: string;
     /**
      * Handle without the leading @ (1-60 characters). Costs 2 extra credits
-     * because the id has to be resolved upstream first - prefer `user_id`.
+     * because the id has to be resolved first - prefer `user_id`.
      */
     username?: string;
     [key: string]: unknown;
@@ -2184,7 +2245,7 @@ declare class TargetNamespace {
      * Paged with `page` + `count` (1-28, default 24). `seller_id` and
      * `seller_name` are null on first-party rows, which means "sold by Target".
      *
-     * Costs 1 credit. Typically ~9s - it runs through a headless browser.
+     * Costs 1 credit. Typically ~9s.
      */
     search(options: TargetSearchOptions): Promise<Record<string, unknown>>;
     /**
@@ -2559,9 +2620,8 @@ declare class RedfinNamespace {
      * houses, schools, climate risk, walkability and location scores, sun
      * exposure, monthly weather, permits, zoning, comparable sales and photos.
      *
-     * Reads the property PAGE, whose inlined request cache replaces the ~40
-     * upstream calls that page made - which is why it is the same price as
-     * search().
+     * Returns the whole property page in one call, which is why it is the same
+     * price as search().
      *
      * Costs 1 credit. Single response, no pagination.
      */
@@ -2638,7 +2698,7 @@ interface BookingSearchOptions {
     rooms?: number;
     /**
      * ISO 4217 currency, 3 letters (default "USD"). Leave it set - without a
-     * currency Booking prices off the proxy exit.
+     * currency Booking picks a currency itself.
      */
     currency?: string;
     [key: string]: unknown;
@@ -2797,7 +2857,7 @@ interface AirbnbSearchOptions {
     amenities?: string;
     /**
      * ISO 4217 currency (default "USD"). Leave it set - without a currency
-     * Airbnb prices off the proxy exit.
+     * Airbnb picks a currency itself.
      */
     currency?: string;
     /**
@@ -3053,8 +3113,7 @@ interface YelpSearchOptions {
     term?: string;
     /**
      * Where to search (1-200 characters), e.g. "Austin, TX". Effectively
-     * REQUIRED - without it Yelp geolocates off the proxy exit and the same
-     * request answers about a different metro run to run.
+     * REQUIRED - without it Yelp picks a location itself and the same request can answer about a different metro run to run.
      */
     location?: string;
     /** Result page, 1-indexed. Yelp fixes the page size at 10. */
@@ -3126,7 +3185,7 @@ declare class YelpNamespace {
      * count.
      *
      * `term` + `location` or `url` is required, and `location` is effectively
-     * mandatory - Yelp geolocates a location-less search off the proxy exit.
+     * mandatory - without it Yelp picks a location itself.
      * Paged with `page`; the page size is fixed at 10.
      *
      * Costs 2 credits.
@@ -3246,8 +3305,7 @@ declare class IndeedNamespace {
      * employment types, benefits, geocoded address, employer rating, applicant
      * count and the original ATS link.
      *
-     * Single response, no pagination. An unknown job key is a real 404 that
-     * scrape.do BILLS - take `job_id` from a search row.
+     * Single response, no pagination. An unknown job key is a real 404 and IS BILLED - take `job_id` from a search row.
      *
      * Costs 2 credits.
      */
@@ -3257,8 +3315,7 @@ declare class IndeedNamespace {
      * approval, overall and per-category ratings, reported salaries, open roles
      * and locations.
      *
-     * Single response, no pagination. An unknown company slug is a real 404
-     * that scrape.do BILLS.
+     * Single response, no pagination. An unknown company slug is a real 404 and IS BILLED.
      *
      * Costs 2 credits.
      */
@@ -3303,7 +3360,7 @@ interface GlassdoorCompanyOptions {
 interface GlassdoorReviewsOptions {
     /**
      * Glassdoor employer id as a STRING (1699, E1699 or IE1699). Either this or
-     * `url` is required. Addressing by employer_id costs two upstream fetches -
+     * `url` is required. Addressing by employer_id costs two lookups -
      * pass reviews_url from company() as `url` instead.
      */
     employer_id?: string;
@@ -3330,7 +3387,7 @@ interface GlassdoorReviewsOptions {
 interface GlassdoorSalariesOptions {
     /**
      * Glassdoor employer id as a STRING (1699, E1699 or IE1699). Either this or
-     * `url` is required. Addressing by employer_id costs two upstream fetches -
+     * `url` is required. Addressing by employer_id costs two lookups -
      * pass salaries_url from company() as `url` instead.
      */
     employer_id?: string;
@@ -3370,7 +3427,7 @@ declare class GlassdoorNamespace {
      * server-rendered reviews, AND reviews_url / salaries_url.
      *
      * THE CHAINING ENDPOINT: pass reviews_url / salaries_url back as `url` on
-     * reviews() and salaries() to halve the upstream fetches. `employer_id` or
+     * reviews() and salaries() to halve the lookups. `employer_id` or
      * `url` is required - `company` is cosmetic and does not satisfy it.
      *
      * Costs 1 credit. Single response, no pagination. Typically ~3-47s.
@@ -4031,7 +4088,7 @@ declare class SECNamespace {
      * filer had more.
      *
      * Costs 1 credit - including with `include_history`, which is the one call
-     * that can buy more than one upstream fetch.
+     * that can buy more than one lookup.
      */
     filings(options: SECFilingsOptions): Promise<Record<string, unknown>>;
     /**
@@ -5659,7 +5716,7 @@ interface ExtractOptions {
      *
      * - "normal": the standard fetch - 1 credit.
      * - "advanced": renders JavaScript, for JS-built pages - 1 credit.
-     * - "ultra": the hardest pages and bot walls - 2 credits.
+     * - "ultra": the hardest pages - 2 credits.
      */
     mode?: "normal" | "advanced" | "ultra";
     [key: string]: unknown;
@@ -5841,4 +5898,4 @@ declare class ScavioJobTimeoutError extends ScavioError {
     constructor(jobType: "crawl" | "batch", jobId: string, statusUrl: string, lastStatus: string);
 }
 
-export { type AirbnbListingOptions, AirbnbNamespace, type AirbnbReviewsOptions, type AirbnbSearchOptions, AmazonNamespace, type AmazonOffersOptions, type AmazonProductOptions, type AmazonSearchOptions, type AppStoreAppOptions, AppStoreNamespace, type AppStoreReviewsOptions, type AppStoreSearchOptions, BadRequestError, type BookingHotelOptions, BookingNamespace, type BookingReviewsOptions, type BookingSearchOptions, CapterraNamespace, type CapterraProductOptions, type CapterraReviewsOptions, type CapterraSearchOptions, type CompaniesHouseCompanyOptions, type CompaniesHouseFilingHistoryOptions, CompaniesHouseNamespace, type CompaniesHouseOfficersOptions, type CompaniesHouseSearchOptions, type CostcoAutocompleteOptions, type CostcoAvailabilityOptions, type CostcoCategoriesOptions, type CostcoCategoryOptions, type CostcoClearanceOptions, type CostcoCountry, type CostcoCouponsOptions, type CostcoDealType, type CostcoDealsOptions, type CostcoGasOptions, type CostcoListingFilters, type CostcoNaCountry, CostcoNamespace, type CostcoPriceCode, type CostcoPricesOptions, type CostcoProductOptions, type CostcoReviewsOptions, type CostcoSearchOptions, type CostcoSortBy, type CostcoWarehousesOptions, DEFAULT_MAX_REQUESTS_PER_SECOND, EbayNamespace, type EbayProductOptions, type EbaySearchOptions, type EbaySellerOptions, type Extract, type ExtractBatchOptions, type ExtractCrawlOptions, type ExtractFormat, type ExtractJobCreatedResponse, type ExtractJobRequestOptions, type ExtractJobResult, type ExtractJobState, type ExtractJobStatusQuery, type ExtractJobStatusResponse, type ExtractJobSummary, type ExtractJobSummaryResponse, type ExtractJobWaitResponse, type ExtractMapLink, type ExtractMapOptions, type ExtractMapResponse, type ExtractMode, ExtractNamespace, type ExtractOptions, type ExtractSitemapMode, G2Namespace, type G2ProductOptions, type G2ReviewsOptions, type G2SearchOptions, type GlassdoorCompaniesOptions, type GlassdoorCompanyOptions, GlassdoorNamespace, type GlassdoorReviewsOptions, type GlassdoorSalariesOptions, type GoogleAdsAdvertisersOptions, type GoogleAdsCreativeOptions, GoogleAdsNamespace, type GoogleAdsSearchOptions, type GoogleAiModeOptions, type GoogleFlightsOptions, type GoogleHotelsDetailOptions, type GoogleHotelsOptions, type GoogleMapsPlaceOptions, type GoogleMapsReviewsOptions, type GoogleMapsSearchOptions, GoogleNamespace, type GoogleNewsOptions, type GooglePlayAppOptions, GooglePlayNamespace, type GooglePlayReviewsOptions, type GooglePlaySearchOptions, type GoogleSearchOptions, type GoogleShoppingOptions, type GoogleShoppingProductOptions, type GoogleShoppingStoresOptions, type GoogleTrendingOptions, type GoogleTrendsOptions, HomeDepotNamespace, type HomeDepotProductOptions, type HomeDepotReviewsOptions, type HomeDepotSearchOptions, type IndeedCompanyOptions, type IndeedCompanyReviewsOptions, type IndeedJobOptions, IndeedNamespace, type IndeedSearchOptions, type InstagramCommentRepliesOptions, type InstagramFollowOptions, InstagramNamespace, type InstagramPostCommentsOptions, type InstagramPostOptions, type InstagramProfileOptions, type InstagramSearchOptions, type InstagramStoriesOptions, type InstagramUserFeedOptions, InsufficientCreditsError, InvalidAPIKeyError, type KuaishouCommentRepliesOptions, KuaishouNamespace, type KuaishouProfileOptions, type KuaishouSearchLiveOptions, type KuaishouSearchOptions, type KuaishouSearchUsersOptions, type KuaishouSearchVideosOptions, type KuaishouTagFeedOptions, type KuaishouTrendingOptions, type KuaishouUserLiveOptions, type KuaishouUserPostsOptions, type KuaishouUserResolveOptions, type KuaishouVideoCommentsOptions, type KuaishouVideoOptions, type KuaishouVideosBatchOptions, type LinkedInCompanyOptions, type LinkedInCompanyPostsOptions, type LinkedInCompanyPostsRequest, type LinkedInCompanyRefOptions, type LinkedInJobOptions, LinkedInNamespace, type LinkedInPersonContactOptions, type LinkedInPersonOptions, type LinkedInPersonPostsOptions, type LinkedInPersonPostsRequest, type LinkedInPersonRefOptions, type LinkedInPostCommentsOptions, type LinkedInPostOptions, type LinkedInSearchJobsOptions, type LinkedInSearchPeopleOptions, type LinkedInSearchPostsOptions, MAX_REQUESTS_PER_SECOND, type MercadoLibreBestSellersCountry, type MercadoLibreBestSellersOptions, type MercadoLibreCondition, type MercadoLibreCountry, type MercadoLibreDiscount, MercadoLibreNamespace, type MercadoLibreProductOptions, type MercadoLibreQuestionsOptions, type MercadoLibreReviewsOptions, type MercadoLibreSearchOptions, type MercadoLibreSort, type MetaAdsAdOptions, type MetaAdsAdvertiserOptions, MetaAdsNamespace, type MetaAdsSearchOptions, MissingAPIKeyError, NotFoundError, RateLimitError, type RealtorAgentOptions, type RealtorAgentsOptions, type RealtorListingStatus, type RealtorLocationsOptions, type RealtorMarketOptions, RealtorNamespace, type RealtorPropertyOptions, type RealtorPropertyType, type RealtorSearchOptions, type RealtorSort, type RedditCommentRepliesOptions, type RedditCommentSearchSort, type RedditFeedSort, RedditNamespace, type RedditPopularOptions, type RedditPostCommentsOptions, type RedditPostOptions, type RedditSearchCommentsOptions, type RedditSearchOptions, type RedditSearchSubredditsOptions, type RedditSearchSuggestionsOptions, type RedditSort, type RedditSubredditOptions, type RedditSubredditPostsOptions, type RedditUserFeedOptions, type RedditUserOptions, type RedfinMarketOptions, RedfinNamespace, type RedfinPropertyOptions, type RedfinSearchOptions, type RightmoveAgentOptions, type RightmoveAgentsOptions, type RightmoveExclude, type RightmoveFurnishing, type RightmoveLetType, type RightmoveListingStatus, type RightmoveLocationsOptions, type RightmoveMustHave, RightmoveNamespace, type RightmovePropertyOptions, type RightmovePropertyType, type RightmoveRadius, type RightmoveSearchOptions, type RightmoveSoldOptions, type RightmoveSoldPropertyOptions, type RightmoveSoldPropertyType, type RightmoveSoldSort, type RightmoveSort, type RightmoveTenure, type SECCompanyOptions, type SECConceptOptions, type SECFactsOptions, type SECFilingsOptions, type SECLookupOptions, SECNamespace, type SECSearchOptions, Scavio, ScavioAPIError, type ScavioConfig, ScavioConnectionError, ScavioError, ScavioJobTimeoutError, ScavioTimeoutError, type TargetCategoryOptions, TargetNamespace, type TargetProductOptions, type TargetReviewsOptions, type TargetSearchOptions, ThreadsNamespace, type ThreadsPostCommentsOptions, type ThreadsPostOptions, type ThreadsProfileOptions, type ThreadsSearchUsersOptions, type ThreadsUserPostsOptions, type ThreadsUserRepliesOptions, type TikTokCommentRepliesOptions, type TikTokHashtagOptions, type TikTokHashtagVideosOptions, type TikTokMusicChartOptions, type TikTokMusicOptions, type TikTokMusicVideosOptions, TikTokNamespace, type TikTokPlaylistVideosOptions, type TikTokProfileOptions, type TikTokSearchMusicOptions, type TikTokSearchSuggestionsOptions, type TikTokSearchUsersOptions, type TikTokSearchVideosOptions, type TikTokShopCategoryProductsOptions, type TikTokShopListingRegion, TikTokShopNamespace, type TikTokShopProductOptions, type TikTokShopProductReviewsOptions, type TikTokShopRegion, type TikTokShopResolveOptions, type TikTokShopReviewSort, type TikTokShopSearchOptions, type TikTokShopShopProductsOptions, type TikTokShopSuggestionsOptions, type TikTokTrendingVideosOptions, type TikTokUserFollowersOptions, type TikTokUserFollowingsOptions, type TikTokUserPlaylistsOptions, type TikTokUserPostsOptions, type TikTokUserSimilarOptions, type TikTokUsernameOptions, type TikTokVideoCommentsOptions, type TikTokVideoOptions, type TikTokVideoTranscriptOptions, type TripadvisorLocationOptions, type TripadvisorLocationsOptions, TripadvisorNamespace, type TripadvisorReviewsOptions, type TripadvisorSearchOptions, type TrustpilotBusinessAddress, type TrustpilotBusinessOptions, type TrustpilotCategoriesOptions, type TrustpilotCategoryOptions, type TrustpilotCategorySort, TrustpilotNamespace, type TrustpilotReviewOptions, type TrustpilotReviewsDateRange, type TrustpilotReviewsOptions, type TrustpilotReviewsSort, type TrustpilotSearchOptions, type TrustpilotStars, type WalmartCategoryOptions, WalmartNamespace, type WalmartOffersOptions, type WalmartProductOptions, type WalmartReviewsOptions, type WalmartSearchOptions, type WalmartSellerOptions, type WalmartSellerProductsOptions, type WalmartStore, type WalmartStoresData, type WalmartStoresOptions, type WalmartStoresResponse, type XCommunityOptions, type XCommunityTweetsOptions, XNamespace, type XSearchCommunitiesOptions, type XSearchOptions, type XTrendingOptions, type XTweetCommentsOptions, type XTweetOptions, type XTweetRetweetersOptions, type XUserFeedOptions, type XUserOptions, type YelpBusinessOptions, YelpNamespace, type YelpReviewsOptions, type YelpSearchOptions, type YouTubeChannelCommunityOptions, type YouTubeChannelOptions, type YouTubeChannelResolveOptions, type YouTubeChannelSearchOptions, type YouTubeChannelShortsOptions, type YouTubeChannelVideosOptions, type YouTubeCommentRepliesOptions, type YouTubeCommentsOptions, type YouTubeCommunityPostCommentsOptions, type YouTubeCommunityPostOptions, type YouTubeMetadataOptions, YouTubeNamespace, type YouTubeRelatedOptions, type YouTubeSearchOptions, type YouTubeShortsOptions, type YouTubeStreamsOptions, type YouTubeSuggestionsOptions, type YouTubeTranscriptOptions, type YouTubeVideoOptions, type ZillowAgentReviewsOptions, ZillowNamespace, type ZillowPropertyOptions, type ZillowSearchOptions, verifyWebhook };
+export { type AirbnbListingOptions, AirbnbNamespace, type AirbnbReviewsOptions, type AirbnbSearchOptions, AmazonNamespace, type AmazonOffersOptions, type AmazonProductOptions, type AmazonSearchOptions, type AppStoreAppOptions, AppStoreNamespace, type AppStoreReviewsOptions, type AppStoreSearchOptions, BadRequestError, type BookingHotelOptions, BookingNamespace, type BookingReviewsOptions, type BookingSearchOptions, CapterraNamespace, type CapterraProductOptions, type CapterraReviewsOptions, type CapterraSearchOptions, type CompaniesHouseCompanyOptions, type CompaniesHouseFilingHistoryOptions, CompaniesHouseNamespace, type CompaniesHouseOfficersOptions, type CompaniesHouseSearchOptions, type CostcoAutocompleteOptions, type CostcoAvailabilityOptions, type CostcoCategoriesOptions, type CostcoCategoryOptions, type CostcoClearanceOptions, type CostcoCountry, type CostcoCouponsOptions, type CostcoDealType, type CostcoDealsOptions, type CostcoGasOptions, type CostcoListingFilters, type CostcoNaCountry, CostcoNamespace, type CostcoPriceCode, type CostcoPricesOptions, type CostcoProductOptions, type CostcoReviewsOptions, type CostcoSearchOptions, type CostcoSortBy, type CostcoWarehousesOptions, DEFAULT_MAX_REQUESTS_PER_SECOND, EbayNamespace, type EbayProductOptions, type EbaySearchOptions, type EbaySellerOptions, type Extract, type ExtractBatchOptions, type ExtractCrawlOptions, type ExtractFormat, type ExtractJobCreatedResponse, type ExtractJobRequestOptions, type ExtractJobResult, type ExtractJobState, type ExtractJobStatusQuery, type ExtractJobStatusResponse, type ExtractJobSummary, type ExtractJobSummaryResponse, type ExtractJobWaitResponse, type ExtractMapLink, type ExtractMapOptions, type ExtractMapResponse, type ExtractMode, ExtractNamespace, type ExtractOptions, type ExtractSitemapMode, G2Namespace, type G2ProductOptions, type G2ReviewsOptions, type G2SearchOptions, type GlassdoorCompaniesOptions, type GlassdoorCompanyOptions, GlassdoorNamespace, type GlassdoorReviewsOptions, type GlassdoorSalariesOptions, type GoogleAdsAdvertisersOptions, type GoogleAdsCreativeOptions, GoogleAdsNamespace, type GoogleAdsSearchOptions, type GoogleAiModeOptions, type GoogleFlightsOptions, type GoogleHotelsDetailOptions, type GoogleHotelsOptions, type GoogleMapsPlaceOptions, type GoogleMapsReviewsOptions, type GoogleMapsSearchOptions, GoogleNamespace, type GoogleNewsOptions, type GooglePlayAppOptions, GooglePlayNamespace, type GooglePlayReviewsOptions, type GooglePlaySearchOptions, type GoogleSearchOptions, type GoogleShoppingOptions, type GoogleShoppingProductOptions, type GoogleShoppingStoresOptions, type GoogleTrendingOptions, type GoogleTrendsOptions, HomeDepotNamespace, type HomeDepotProductOptions, type HomeDepotReviewsOptions, type HomeDepotSearchOptions, type IndeedCompanyOptions, type IndeedCompanyReviewsOptions, type IndeedJobOptions, IndeedNamespace, type IndeedSearchOptions, type InstagramCommentRepliesOptions, type InstagramFollowOptions, type InstagramHighlightStoriesOptions, type InstagramKeywordOptions, type InstagramMusicPostsOptions, InstagramNamespace, type InstagramPostCommentsOptions, type InstagramPostLikersOptions, type InstagramPostOptions, type InstagramProfileOptions, type InstagramSearchOptions, type InstagramStoriesOptions, type InstagramUserFeedOptions, type InstagramUserRefOptions, InsufficientCreditsError, InvalidAPIKeyError, type KuaishouCommentRepliesOptions, KuaishouNamespace, type KuaishouProfileOptions, type KuaishouSearchLiveOptions, type KuaishouSearchOptions, type KuaishouSearchUsersOptions, type KuaishouSearchVideosOptions, type KuaishouTagFeedOptions, type KuaishouTrendingOptions, type KuaishouUserLiveOptions, type KuaishouUserPostsOptions, type KuaishouUserResolveOptions, type KuaishouVideoCommentsOptions, type KuaishouVideoOptions, type KuaishouVideosBatchOptions, type LinkedInCompanyOptions, type LinkedInCompanyPostsOptions, type LinkedInCompanyPostsRequest, type LinkedInCompanyRefOptions, type LinkedInJobOptions, LinkedInNamespace, type LinkedInPersonContactOptions, type LinkedInPersonOptions, type LinkedInPersonPostsOptions, type LinkedInPersonPostsRequest, type LinkedInPersonRefOptions, type LinkedInPostCommentsOptions, type LinkedInPostOptions, type LinkedInSearchJobsOptions, type LinkedInSearchPeopleOptions, type LinkedInSearchPostsOptions, MAX_REQUESTS_PER_SECOND, type MercadoLibreBestSellersCountry, type MercadoLibreBestSellersOptions, type MercadoLibreCondition, type MercadoLibreCountry, type MercadoLibreDiscount, MercadoLibreNamespace, type MercadoLibreProductOptions, type MercadoLibreQuestionsOptions, type MercadoLibreReviewsOptions, type MercadoLibreSearchOptions, type MercadoLibreSort, type MetaAdsAdOptions, type MetaAdsAdvertiserOptions, MetaAdsNamespace, type MetaAdsSearchOptions, MissingAPIKeyError, NotFoundError, RateLimitError, type RealtorAgentOptions, type RealtorAgentsOptions, type RealtorListingStatus, type RealtorLocationsOptions, type RealtorMarketOptions, RealtorNamespace, type RealtorPropertyOptions, type RealtorPropertyType, type RealtorSearchOptions, type RealtorSort, type RedditCommentRepliesOptions, type RedditCommentSearchSort, type RedditFeedSort, RedditNamespace, type RedditPopularOptions, type RedditPostCommentsOptions, type RedditPostOptions, type RedditSearchCommentsOptions, type RedditSearchOptions, type RedditSearchSubredditsOptions, type RedditSearchSuggestionsOptions, type RedditSort, type RedditSubredditOptions, type RedditSubredditPostsOptions, type RedditUserFeedOptions, type RedditUserOptions, type RedfinMarketOptions, RedfinNamespace, type RedfinPropertyOptions, type RedfinSearchOptions, type RightmoveAgentOptions, type RightmoveAgentsOptions, type RightmoveExclude, type RightmoveFurnishing, type RightmoveLetType, type RightmoveListingStatus, type RightmoveLocationsOptions, type RightmoveMustHave, RightmoveNamespace, type RightmovePropertyOptions, type RightmovePropertyType, type RightmoveRadius, type RightmoveSearchOptions, type RightmoveSoldOptions, type RightmoveSoldPropertyOptions, type RightmoveSoldPropertyType, type RightmoveSoldSort, type RightmoveSort, type RightmoveTenure, type SECCompanyOptions, type SECConceptOptions, type SECFactsOptions, type SECFilingsOptions, type SECLookupOptions, SECNamespace, type SECSearchOptions, Scavio, ScavioAPIError, type ScavioConfig, ScavioConnectionError, ScavioError, ScavioJobTimeoutError, ScavioTimeoutError, type TargetCategoryOptions, TargetNamespace, type TargetProductOptions, type TargetReviewsOptions, type TargetSearchOptions, ThreadsNamespace, type ThreadsPostCommentsOptions, type ThreadsPostOptions, type ThreadsProfileOptions, type ThreadsSearchUsersOptions, type ThreadsUserPostsOptions, type ThreadsUserRepliesOptions, type TikTokCommentRepliesOptions, type TikTokHashtagOptions, type TikTokHashtagVideosOptions, type TikTokMusicChartOptions, type TikTokMusicOptions, type TikTokMusicVideosOptions, TikTokNamespace, type TikTokPlaylistVideosOptions, type TikTokProfileOptions, type TikTokSearchMusicOptions, type TikTokSearchSuggestionsOptions, type TikTokSearchUsersOptions, type TikTokSearchVideosOptions, type TikTokShopCategoryProductsOptions, type TikTokShopListingRegion, TikTokShopNamespace, type TikTokShopProductOptions, type TikTokShopProductReviewsOptions, type TikTokShopRegion, type TikTokShopResolveOptions, type TikTokShopReviewSort, type TikTokShopSearchOptions, type TikTokShopShopProductsOptions, type TikTokShopSuggestionsOptions, type TikTokTrendingVideosOptions, type TikTokUserFollowersOptions, type TikTokUserFollowingsOptions, type TikTokUserPlaylistsOptions, type TikTokUserPostsOptions, type TikTokUserSimilarOptions, type TikTokUsernameOptions, type TikTokVideoCommentsOptions, type TikTokVideoOptions, type TikTokVideoTranscriptOptions, type TripadvisorLocationOptions, type TripadvisorLocationsOptions, TripadvisorNamespace, type TripadvisorReviewsOptions, type TripadvisorSearchOptions, type TrustpilotBusinessAddress, type TrustpilotBusinessOptions, type TrustpilotCategoriesOptions, type TrustpilotCategoryOptions, type TrustpilotCategorySort, TrustpilotNamespace, type TrustpilotReviewOptions, type TrustpilotReviewsDateRange, type TrustpilotReviewsOptions, type TrustpilotReviewsSort, type TrustpilotSearchOptions, type TrustpilotStars, type WalmartCategoryOptions, WalmartNamespace, type WalmartOffersOptions, type WalmartProductOptions, type WalmartReviewsOptions, type WalmartSearchOptions, type WalmartSellerOptions, type WalmartSellerProductsOptions, type WalmartStore, type WalmartStoresData, type WalmartStoresOptions, type WalmartStoresResponse, type XCommunityOptions, type XCommunityTweetsOptions, XNamespace, type XSearchCommunitiesOptions, type XSearchOptions, type XTrendingOptions, type XTweetCommentsOptions, type XTweetOptions, type XTweetRetweetersOptions, type XUserFeedOptions, type XUserOptions, type YelpBusinessOptions, YelpNamespace, type YelpReviewsOptions, type YelpSearchOptions, type YouTubeChannelCommunityOptions, type YouTubeChannelOptions, type YouTubeChannelResolveOptions, type YouTubeChannelSearchOptions, type YouTubeChannelShortsOptions, type YouTubeChannelVideosOptions, type YouTubeCommentRepliesOptions, type YouTubeCommentsOptions, type YouTubeCommunityPostCommentsOptions, type YouTubeCommunityPostOptions, type YouTubeMetadataOptions, YouTubeNamespace, type YouTubeRelatedOptions, type YouTubeSearchOptions, type YouTubeShortsOptions, type YouTubeStreamsOptions, type YouTubeSuggestionsOptions, type YouTubeTranscriptOptions, type YouTubeVideoOptions, type ZillowAgentReviewsOptions, ZillowNamespace, type ZillowPropertyOptions, type ZillowSearchOptions, verifyWebhook };

package/dist/index.js

@@ -145,7 +145,7 @@ function parseRetryAfter(header) {
 var BASE_URL = "https://api.scavio.dev";
 var DEFAULT_TIMEOUT = 3e4;
 var DEFAULT_MAX_RETRIES = 2;
-var SDK_VERSION = true ? "0.23.1" : "0.0.0";
+var SDK_VERSION = true ? "0.24.1" : "0.0.0";
 var USER_AGENT = `scavio-js/${SDK_VERSION}`;
 function isServerRuntime() {
   const g = globalThis;
@@ -725,42 +725,86 @@ var InstagramNamespace = class {
     this.client = client;
   }
   client;
+  /** Get a user profile by username or user_id. 1 credit. */
   async profile(options) {
     return this.client._post("/api/v1/instagram/profile", options);
   }
+  /** Get a user's posts, about 12 per page; page with `data.pagination_token`. 2 credits per page. */
   async userPosts(options) {
     return this.client._post("/api/v1/instagram/user/posts", options);
   }
+  /** Get a user's Reels. 1 credit (2 the first time a username is looked up). */
   async userReels(options) {
     return this.client._post("/api/v1/instagram/user/reels", options);
   }
+  /** Get posts a user is tagged in. 1 credit (2 the first time a username is looked up). */
   async userTagged(options) {
     return this.client._post("/api/v1/instagram/user/tagged", options);
   }
+  /** Get a user's active stories. 2 credits. */
   async userStories(options) {
     return this.client._post("/api/v1/instagram/user/stories", options);
   }
+  /** Get a single post by url, media_id or shortcode. 2 credits. */
   async post(options) {
     return this.client._post("/api/v1/instagram/post", options);
   }
+  /** Get comments on a post; page with `next_min_id`. 2 credits per page. */
   async postComments(options) {
     return this.client._post("/api/v1/instagram/post/comments", options);
   }
+  /** Get replies to a comment. 2 credits. */
   async commentReplies(options) {
     return this.client._post("/api/v1/instagram/post/comments/replies", options);
   }
+  /** Search users by keyword. 2 credits; 8 when a `cursor` is sent. */
   async searchUsers(options) {
     return this.client._post("/api/v1/instagram/search/users", options);
   }
+  /** Search hashtags by keyword. 2 credits; 8 when a `cursor` is sent. */
   async searchHashtags(options) {
     return this.client._post("/api/v1/instagram/search/hashtags", options);
   }
+  /** Get a user's followers; page with `next_max_id`. 2 credits per page. */
   async userFollowers(options) {
     return this.client._post("/api/v1/instagram/user/followers", options);
   }
+  /** Get the accounts a user follows; page with `next_max_id`. 2 credits per page. */
   async userFollowings(options) {
     return this.client._post("/api/v1/instagram/user/followings", options);
   }
+  /** List a user's story highlights (id, title, cover, item count). 2 credits. */
+  async userHighlights(options) {
+    return this.client._post("/api/v1/instagram/user/highlights", options);
+  }
+  /** Get every story saved in one highlight, with media URLs. 2 credits. */
+  async highlightStories(options) {
+    return this.client._post("/api/v1/instagram/highlight/stories", options);
+  }
+  /** Search Reels by keyword; page with `pagination_token`. 2 credits per page. */
+  async searchReels(options) {
+    return this.client._post("/api/v1/instagram/search/reels", options);
+  }
+  /** Search audio tracks by song or artist; returns the id `musicPosts` takes. 2 credits. */
+  async searchMusic(options) {
+    return this.client._post("/api/v1/instagram/search/music", options);
+  }
+  /** Get the Reels that use an audio track, plus its total reel count. 1 credit per page. */
+  async musicPosts(options) {
+    return this.client._post("/api/v1/instagram/music/posts", options);
+  }
+  /** Search places by name (id, name, address, coordinates). 2 credits. */
+  async searchLocations(options) {
+    return this.client._post("/api/v1/instagram/search/locations", options);
+  }
+  /** Get accounts similar to a user. Most creator accounts have them; some brand accounts return none. 2 credits. */
+  async userSimilar(options) {
+    return this.client._post("/api/v1/instagram/user/similar", options);
+  }
+  /** Get accounts that liked a post (up to about 1,000) and its total like count. 2 credits. */
+  async postLikers(options) {
+    return this.client._post("/api/v1/instagram/post/likers", options);
+  }
 };
 
 // src/namespaces/walmart.ts
@@ -1061,14 +1105,14 @@ var LinkedInNamespace = class {
     return this.client._post("/api/v1/linkedin/post/comments", options);
   }
   /**
-   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * @deprecated Retired. Always returns HTTP 410 and is
    * never billed.
    */
   async personContact(options) {
     return this.client._post("/api/v1/linkedin/person/contact", options);
   }
   /**
-   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * @deprecated Retired. Always returns HTTP 410 and is
    * never billed. `company()` returns `featured_employees`, a small sample of
    * staff profiles.
    */
@@ -1076,21 +1120,21 @@ var LinkedInNamespace = class {
     return this.client._post("/api/v1/linkedin/company/people", options);
   }
   /**
-   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * @deprecated Retired. Always returns HTTP 410 and is
    * never billed. Use `searchJobs()` with the company name as the search term.
    */
   async companyJobs(options) {
     return this.client._post("/api/v1/linkedin/company/jobs", options);
   }
   /**
-   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * @deprecated Retired. Always returns HTTP 410 and is
    * never billed.
    */
   async searchPeople(options) {
     return this.client._post("/api/v1/linkedin/search/people", options);
   }
   /**
-   * @deprecated Retired by the upstream provider. Always returns HTTP 410 and is
+   * @deprecated Retired. Always returns HTTP 410 and is
    * never billed.
    */
   async searchPosts(options) {
@@ -1350,7 +1394,7 @@ var TargetNamespace = class {
    * Paged with `page` + `count` (1-28, default 24). `seller_id` and
    * `seller_name` are null on first-party rows, which means "sold by Target".
    *
-   * Costs 1 credit. Typically ~9s - it runs through a headless browser.
+   * Costs 1 credit. Typically ~9s.
    */
   async search(options) {
     return this.client._post("/api/v1/target/search", options);
@@ -1516,9 +1560,8 @@ var RedfinNamespace = class {
    * houses, schools, climate risk, walkability and location scores, sun
    * exposure, monthly weather, permits, zoning, comparable sales and photos.
    *
-   * Reads the property PAGE, whose inlined request cache replaces the ~40
-   * upstream calls that page made - which is why it is the same price as
-   * search().
+   * Returns the whole property page in one call, which is why it is the same
+   * price as search().
    *
    * Costs 1 credit. Single response, no pagination.
    */
@@ -1748,7 +1791,7 @@ var YelpNamespace = class {
    * count.
    *
    * `term` + `location` or `url` is required, and `location` is effectively
-   * mandatory - Yelp geolocates a location-less search off the proxy exit.
+   * mandatory - without it Yelp picks a location itself.
    * Paged with `page`; the page size is fixed at 10.
    *
    * Costs 2 credits.
@@ -1820,8 +1863,7 @@ var IndeedNamespace = class {
    * employment types, benefits, geocoded address, employer rating, applicant
    * count and the original ATS link.
    *
-   * Single response, no pagination. An unknown job key is a real 404 that
-   * scrape.do BILLS - take `job_id` from a search row.
+   * Single response, no pagination. An unknown job key is a real 404 and IS BILLED - take `job_id` from a search row.
    *
    * Costs 2 credits.
    */
@@ -1833,8 +1875,7 @@ var IndeedNamespace = class {
    * approval, overall and per-category ratings, reported salaries, open roles
    * and locations.
    *
-   * Single response, no pagination. An unknown company slug is a real 404
-   * that scrape.do BILLS.
+   * Single response, no pagination. An unknown company slug is a real 404 and IS BILLED.
    *
    * Costs 2 credits.
    */
@@ -1882,7 +1923,7 @@ var GlassdoorNamespace = class {
    * server-rendered reviews, AND reviews_url / salaries_url.
    *
    * THE CHAINING ENDPOINT: pass reviews_url / salaries_url back as `url` on
-   * reviews() and salaries() to halve the upstream fetches. `employer_id` or
+   * reviews() and salaries() to halve the lookups. `employer_id` or
    * `url` is required - `company` is cosmetic and does not satisfy it.
    *
    * Costs 1 credit. Single response, no pagination. Typically ~3-47s.
@@ -2206,7 +2247,7 @@ var SECNamespace = class {
    * filer had more.
    *
    * Costs 1 credit - including with `include_history`, which is the one call
-   * that can buy more than one upstream fetch.
+   * that can buy more than one lookup.
    */
   async filings(options) {
     return this.client._post("/api/v1/sec/filings", options);