scavio 0.23.1 → 0.24.1

package/README.md

@@ -785,13 +785,16 @@ await client.tiktokShop.resolve({ url: "https://vt.tiktok.com/ZT2AHoGsE/" });
 
 ### Instagram
 
-Credit cost varies by endpoint, in three tiers:
+20 endpoints. Typical credit cost per call:
 
 | Credits | Methods |
 |---|---|
-| 2 | `userPosts` |
-| 8 | `post`, `commentReplies` |
-| 10 | `profile`, `userReels`, `userTagged`, `userStories`, `postComments`, `searchUsers`, `searchHashtags`, `userFollowers`, `userFollowings` |
+| 1 | `profile`, `musicPosts` (per page), `userReels`, `userTagged` (2 the first time a username is looked up) |
+| 2 | `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.
 
 ```typescript
 // User profile
@@ -802,23 +805,33 @@ await client.instagram.userPosts({ username: "instagram", count: 12 });
 await client.instagram.userReels({ username: "instagram" });
 await client.instagram.userTagged({ username: "instagram" });
 
-// User stories
+// User stories, highlights and the stories saved in one highlight
 await client.instagram.userStories({ username: "instagram" });
+await client.instagram.userHighlights({ username: "natgeo" });
+await client.instagram.highlightStories({ highlight_id: "highlight:18149897764550869" });
 
-// Post detail (by url, media_id, or shortcode)
+// Post detail (by url, media_id, or shortcode) and who liked it
 await client.instagram.post({ shortcode: "DUajw4YkorV" });
+await client.instagram.postLikers({ shortcode: "DUajw4YkorV" });
 
 // Post comments and replies
 await client.instagram.postComments({ shortcode: "DUajw4YkorV", sort_order: "newest" });
 await client.instagram.commentReplies({ media_id: "123", comment_id: "456" });
 
-// Search
+// Search users, hashtags, Reels and places
 await client.instagram.searchUsers({ keyword: "justin" });
 await client.instagram.searchHashtags({ keyword: "fashion" });
+await client.instagram.searchReels({ keyword: "latte art" });
+await client.instagram.searchLocations({ keyword: "central park" });
+
+// Audio: find a track, then the Reels that use it
+await client.instagram.searchMusic({ keyword: "espresso" });
+await client.instagram.musicPosts({ music_id: "1747512212697470" });
 
-// Followers / followings
+// Followers / followings / similar accounts
 await client.instagram.userFollowers({ username: "instagram", count: 50 });
 await client.instagram.userFollowings({ username: "instagram" });
+await client.instagram.userSimilar({ username: "mrbeast" });
 ```
 
 ### Threads

package/dist/index.cjs

@@ -232,7 +232,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;
@@ -812,42 +812,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
@@ -1148,14 +1192,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.
    */
@@ -1163,21 +1207,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) {
@@ -1437,7 +1481,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);
@@ -1603,9 +1647,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.
    */
@@ -1835,7 +1878,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.
@@ -1907,8 +1950,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.
    */
@@ -1920,8 +1962,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.
    */
@@ -1969,7 +2010,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.
@@ -2293,7 +2334,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);