composio-scavio 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +54 -7
  2. package/dist/index.cjs +630 -27
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +5 -2
  5. package/dist/index.d.ts +5 -2
  6. package/dist/index.js +630 -27
  7. package/dist/index.js.map +1 -1
  8. package/package.json +11 -5
package/README.md CHANGED
@@ -2,7 +2,13 @@
2
2
 
3
3
  [Scavio](https://scavio.dev) real-time search tools for [Composio](https://composio.dev) (TypeScript).
4
4
 
5
- Scavio is a single Search API over Google, YouTube, Amazon, Walmart, Reddit, TikTok, TikTok Shop, Instagram, X and LinkedIn. This package exposes the Google, YouTube, Amazon, Walmart, Reddit, TikTok and Instagram endpoints as a Composio custom toolkit so your agents can pull structured, up-to-date results across any Composio-supported framework.
5
+ Scavio is a single Search API over Google, YouTube, Amazon, Walmart, Reddit, TikTok, TikTok Shop, Instagram, X and LinkedIn. This package exposes **all ten platforms -- 97 tools, one per live endpoint** -- as a Composio custom toolkit so your agents can pull structured, up-to-date results across any Composio-supported framework.
6
+
7
+ > **Google is v2 only.** `/api/v1/google` was retired on 2026-08-04 and returns
8
+ > 410, so none of its vocabulary survives here. The tools take the v2 params
9
+ > natively: `gl`, `hl`, `google_domain`, `device` and `start`. **`start` is a
10
+ > result offset, not a page number** (0 is page 1, 10 is page 2), and there is no
11
+ > `page` argument mapped onto it -- a silent remap fetches the wrong page.
6
12
 
7
13
  > **Amazon changed (breaking).** The upstream provider moved in 2026-07:
8
14
  > `domain` is replaced by `country`, a two-letter marketplace code (`us`, `gb`
@@ -15,8 +21,9 @@ Scavio is a single Search API over Google, YouTube, Amazon, Walmart, Reddit, Tik
15
21
  > **Reddit search has no filters.** `/reddit/search` accepts only `query` and
16
22
  > `cursor`; the API strips anything else, so the old `type` and `sort` args
17
23
  > narrowed nothing and are removed. It returns `data.results` with `next_cursor`
18
- > and `has_more`. `REDDIT_POST` returns the post itself only -- comments are not
19
- > included.
24
+ > and `has_more`. `REDDIT_POST` returns a flat post object only -- comments come
25
+ > from `REDDIT_POST_COMMENTS`. The subreddit and user feeds do return
26
+ > `data.posts`.
20
27
 
21
28
  ## Install
22
29
 
@@ -24,7 +31,7 @@ Scavio is a single Search API over Google, YouTube, Amazon, Walmart, Reddit, Tik
24
31
  npm install composio-scavio
25
32
  ```
26
33
 
27
- `@composio/core` and `zod` are dependencies. Get a Scavio API key from the [Scavio Dashboard](https://dashboard.scavio.dev) (50 one-time signup credits, no credit card; the free plan does not refill monthly).
34
+ `@composio/core`, `scavio` (>= 0.14.0) and `zod` are dependencies. Get a Scavio API key from the [Scavio Dashboard](https://dashboard.scavio.dev) (50 one-time signup credits, no credit card; the free plan does not refill monthly).
28
35
 
29
36
  ## Usage
30
37
 
@@ -50,7 +57,7 @@ const session = await composio.create("user_1", {
50
57
  const tools = await session.tools();
51
58
  const out = await session.execute("LOCAL_SCAVIO_GOOGLE_SEARCH", {
52
59
  query: "best search API for AI agents",
53
- countryCode: "us",
60
+ gl: "us",
54
61
  });
55
62
  console.log(out);
56
63
  ```
@@ -59,11 +66,51 @@ Pass `all: true` to register every tool regardless of the individual flags.
59
66
 
60
67
  ## Tools
61
68
 
62
- All tools are grouped under the `SCAVIO` custom toolkit; agent-facing slugs are prefixed `LOCAL_SCAVIO_` (Composio convention for custom tools). Providers: Google, Amazon (search, product, offers), Walmart (search, product), YouTube (16 tools: search, shorts, suggestions, video, metadata, comments, comment replies, transcript, related, channel search, channel, channel videos, channel shorts, channel community, channel resolve, streams), Reddit (search, post), TikTok (11 tools), Instagram (12 tools). 47 tools total.
69
+ All tools are grouped under the `SCAVIO` custom toolkit; agent-facing slugs are prefixed `LOCAL_SCAVIO_` (Composio convention for custom tools). Every provider is gated by its own flag.
70
+
71
+ | Platform | Flag | Tools | Endpoints |
72
+ |---|---|---|---|
73
+ | Google | `enableGoogle` | 14 | search, ai mode, maps search, maps place, maps reviews, shopping, shopping product, shopping stores, flights, hotels, hotels detail, news, trends, trending |
74
+ | Amazon | `enableAmazon` | 3 | search, product, offers |
75
+ | Walmart | `enableWalmart` | 2 | search, product |
76
+ | YouTube | `enableYoutube` | 15 | search, shorts, suggestions, video, comments, comment replies, transcript, related, channel search, channel, channel videos, channel shorts, channel community, channel resolve, streams |
77
+ | Reddit | `enableReddit` | 12 | search, search suggestions, post, post comments, comment replies, subreddit, subreddit posts, user, user posts, user comments, popular, trending |
78
+ | TikTok | `enableTiktok` | 11 | profile, user posts, video, video comments, comment replies, search videos, search users, hashtag, hashtag videos, user followers, user followings |
79
+ | TikTok Shop | `enableTiktokShop` | 8 | search, search suggestions, product, product reviews, categories, category products, shop products, resolve |
80
+ | Instagram | `enableInstagram` | 12 | profile, user posts, user reels, user tagged, user stories, post, post comments, comment replies, search users, search hashtags, user followers, user followings |
81
+ | X (Twitter) | `enableX` | 11 | search, tweet, tweet comments, tweet retweeters, user, user tweets, user replies, user media, user followers, user followings, trending |
82
+ | LinkedIn | `enableLinkedin` | 9 | person, person about, person posts, company, company posts, search jobs, job, post, post comments |
83
+ | **Total** | | **97** | |
84
+
85
+ Two endpoints are deliberately not exposed:
86
+
87
+ - `/youtube/metadata` is a deprecated alias of `/youtube/video`; only `YOUTUBE_VIDEO` is registered.
88
+ - The five retired LinkedIn endpoints (`person/contact`, `company/people`, `company/jobs`, `search/people`, `search/posts`) return 410 unbilled. `LINKEDIN_COMPANY` returns `featured_employees`, a 4-6 person sample, in place of the retired employee directory, and `LINKEDIN_SEARCH_JOBS` with the company name replaces `company/jobs`.
63
89
 
64
90
  ## Credits
65
91
 
66
- Most endpoints cost 1 credit, including Google (`/api/v2/google`), Reddit, TikTok, Amazon and Walmart. Instagram costs 10 credits per call, except post and comment replies (8) and user posts (2). YouTube search and shorts cost 2, YouTube streams 3, and YouTube transcript 8. See [scavio.dev/docs](https://scavio.dev/docs).
92
+ Every tool states its cost in its description. Most endpoints cost 1 credit.
93
+
94
+ | Platform | Credits |
95
+ |---|---|
96
+ | Google (all 14 v2 endpoints) | 1 |
97
+ | Amazon, Walmart | 1 |
98
+ | Reddit (all 12) | 1 |
99
+ | TikTok (all 11), TikTok Shop (all 8) | 1 |
100
+ | X (all 11) | 1 |
101
+ | YouTube | 1, except search 2, shorts 2, streams 3, transcript 8 |
102
+ | Instagram | 10, except post 8, comment replies 8, user posts 2 |
103
+ | LinkedIn | 1 for person, person about, company, post; 10 for person posts, company posts, search jobs, post comments; **30 for job** (the most expensive endpoint in the API) |
104
+
105
+ See [scavio.dev/docs](https://scavio.dev/docs).
106
+
107
+ ## Development
108
+
109
+ ```bash
110
+ npm run build # tsup, CJS + ESM + d.ts
111
+ npm run typecheck # tsc --noEmit
112
+ npm test # vitest run
113
+ ```
67
114
 
68
115
  ## Links
69
116