@xquik/tweetclaw 1.3.0 → 1.4.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.
package/README.md CHANGED
@@ -2,7 +2,44 @@
2
2
 
3
3
  Post tweets, reply, like, retweet, follow, DM & more - directly from your chat. Full X/Twitter automation for [OpenClaw](https://github.com/openclaw/openclaw).
4
4
 
5
- Powered by [Xquik](https://xquik.com), the all-in-one X automation platform.
5
+ Powered by [Xquik](https://xquik.com), the all-in-one X automation platform. **Reads from $0.00015/call - 66x cheaper than the official X API.**
6
+
7
+ ## Pricing
8
+
9
+ TweetClaw uses Xquik's credit-based pricing. 1 credit = $0.00015.
10
+
11
+ ### vs Official X API
12
+
13
+ | | Xquik (via TweetClaw) | X API Basic | X API Pro |
14
+ |---|---|---|---|
15
+ | **Monthly cost** | **$20** | $100 | $5,000 |
16
+ | **Cost per tweet read** | **$0.00015** | ~$0.01 | ~$0.005 |
17
+ | **Cost per user lookup** | **$0.00015** | ~$0.01 | ~$0.005 |
18
+ | **Write actions** | **$0.0003** | Limited | Limited |
19
+ | **Bulk extraction** | **$0.00015/result** | Not available | Not available |
20
+ | **Monitoring + webhooks** | **Free** | Not available | Not available |
21
+ | **Giveaway draws** | **$0.00015/entry** | Not available | Not available |
22
+
23
+ ### Per-Operation Costs
24
+
25
+ | Operation | Credits | Cost |
26
+ |-----------|---------|------|
27
+ | Read (tweet, user, search, timeline, bookmarks, etc.) | 1 | $0.00015 |
28
+ | Follow check, article | 7 | $0.00105 |
29
+ | Write (tweet, like, retweet, follow, DM, etc.) | 2 | $0.0003 |
30
+ | Extraction / draw | 1/result | $0.00015/result |
31
+ | Monitors, webhooks, radar, compose, drafts, integrations | 0 | **Free** |
32
+
33
+ ### Pay-Per-Use (No Subscription)
34
+
35
+ Two options:
36
+
37
+ - **Credits (Stripe)**: Top up credits via the API ($10 minimum). 1 credit = $0.00015. Works with all 99 endpoints.
38
+ - **MPP (USDC)**: 8 read-only X-API endpoints accept anonymous payments via Machine Payments Protocol. No account needed. SDK: `npm i mppx`.
39
+
40
+ ### Free Operations
41
+
42
+ Tweet composition, style analysis, drafts, curated radar (7 sources), account management, integrations, automations, support tickets - all free, no credits consumed.
6
43
 
7
44
  ## Install
8
45
 
@@ -12,15 +49,19 @@ openclaw plugins install @xquik/tweetclaw
12
49
 
13
50
  ## Configure
14
51
 
15
- ### Option A: API key (full access, 97 endpoints)
52
+ ### Option A: API key (full access, 99 endpoints)
16
53
 
17
54
  ```bash
18
55
  openclaw config set plugins.entries.tweetclaw.config.apiKey 'xq_YOUR_KEY'
19
56
  ```
20
57
 
21
- Get a key at [dashboard.xquik.com/en/account?tab=x-accounts](https://dashboard.xquik.com/en/account?tab=x-accounts).
58
+ Get a key at [dashboard.xquik.com](https://dashboard.xquik.com/).
59
+
60
+ ### Option B: Credits (pay-per-use via Stripe, no subscription)
22
61
 
23
- ### Option B: MPP pay-per-use (no account needed, 7 read-only endpoints)
62
+ Top up credits from the Xquik dashboard or via `POST /credits/topup`. All 99 endpoints available. 1 credit = $0.00015.
63
+
64
+ ### Option C: MPP pay-per-use (no account needed, 8 read-only endpoints)
24
65
 
25
66
  ```bash
26
67
  npm i mppx viem
@@ -29,7 +70,7 @@ openclaw config set plugins.entries.tweetclaw.config.tempoPrivateKey '0xYOUR_TEM
29
70
 
30
71
  MPP (Machine Payments Protocol) lets agents pay per API call via Tempo (USDC). No account, no API key, no subscription. Get a Tempo wallet at [tempo.xyz](https://tempo.xyz).
31
72
 
32
- MPP-eligible endpoints: tweet lookup ($0.0003), tweet search ($0.0003/tweet), user lookup ($0.00036), follower check ($0.002), article lookup ($0.002), media download ($0.0003/media), trends ($0.0009).
73
+ MPP-eligible endpoints: tweet lookup ($0.00015), tweet search ($0.00015/tweet), user lookup ($0.00015), user tweets ($0.00015/tweet), follower check ($0.00105), article lookup ($0.00105), media download ($0.00015/media), trends ($0.00015).
33
74
 
34
75
  ### Optional settings
35
76
 
@@ -78,7 +119,7 @@ Instant responses, no LLM needed:
78
119
 
79
120
  | Command | Description |
80
121
  |---------|-------------|
81
- | `/xstatus` | Account info, subscription status, usage |
122
+ | `/xstatus` | Account info, subscription status, usage, credit balance |
82
123
  | `/xtrends` | Trending topics from curated sources |
83
124
  | `/xtrends tech` | Trending topics filtered by category |
84
125
 
@@ -97,45 +138,22 @@ You: "Monitor @elonmusk for new tweets and follower changes"
97
138
 
98
139
  ## API Coverage
99
140
 
100
- 97 endpoints across these categories:
101
-
102
- | Category | Examples |
103
- |----------|---------|
104
- | **Write Actions** | Post tweets, reply, like, retweet, follow, unfollow, DM, update profile & avatar |
105
- | **Media** | Upload media via URL, download tweet media, get gallery links |
106
- | **Twitter** | Search tweets, look up users, check follow relationships, get articles |
107
- | **Composition** | Compose, refine, score tweets; manage drafts; analyze writing styles |
108
- | **Extraction** | Run extraction jobs (reply-extractor, community-explorer, etc.) |
109
- | **Draws** | Run giveaway draws on tweets, export results |
110
- | **Monitoring** | Create monitors, view events, manage webhooks |
111
- | **Automations** | Create flows, add steps, test runs, inbound webhooks |
112
- | **Account** | Manage API keys, subscription, connected X accounts |
113
- | **Trends** | X trending topics, curated radar from multiple sources |
114
- | **Support** | Create tickets, reply, track status |
115
-
116
- ## Pricing
117
-
118
- **MPP pay-per-use** (no account needed):
119
- - 7 read-only X-API endpoints via Tempo (USDC)
120
- - Tweet/user/article lookup, search, follower check, media download, trends
121
-
122
- **Free tier** (API key, no subscription needed):
123
- - Tweet composition, style analysis, drafts
124
- - Curated trending radar
125
- - Account management, API keys
126
- - Integrations management
127
- - Flow automations (create, test, inbound webhooks)
128
- - Support tickets
129
-
130
- **Subscription ($20/month)** for full access:
131
- - Write actions (post, reply, like, retweet, follow, DM, update profile)
132
- - Tweet search, user lookup, article lookup, media download
133
- - Extractions, giveaway draws
134
- - Account monitors, events, webhooks
135
- - X trending topics
136
- - Flow activation (free: 2 flows, subscriber: 10)
137
-
138
- When a paid endpoint returns 402, TweetClaw provides a checkout URL (API key mode) or auto-pays via Tempo (MPP mode).
141
+ 99 endpoints across 12 categories:
142
+
143
+ | Category | Examples | Cost |
144
+ |----------|---------|------|
145
+ | **Write Actions** | Post tweets, reply, like, retweet, follow, unfollow, DM, update profile, avatar, banner | 2 credits |
146
+ | **Media** | Upload media via URL, download tweet media, get gallery links | 1-2 credits |
147
+ | **Twitter** | Search tweets, look up users, user tweets/likes/media, favoriters, mutual followers, check follows, articles, bookmarks, notifications, timeline, DM history | 1-7 credits |
148
+ | **Composition** | Compose, refine, score tweets; manage drafts; analyze writing styles | Free |
149
+ | **Extraction** | Run extraction jobs (20 tool types: replies, followers, communities, etc.) | 1 credit/result |
150
+ | **Draws** | Run giveaway draws on tweets, export results | 1 credit/entry |
151
+ | **Monitoring** | Create monitors, view events, manage webhooks | Free |
152
+ | **Automations** | Create flows, add steps, test runs, inbound webhooks | Free |
153
+ | **Account** | Manage API keys, subscription, connected X accounts | Free |
154
+ | **Credits** | Check balance, top up credits | Free |
155
+ | **Trends** | X trending topics, curated radar from 7 sources | 1 credit / Free |
156
+ | **Support** | Create tickets, reply, track status | Free |
139
157
 
140
158
  ## License
141
159
 
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "id": "tweetclaw",
3
3
  "name": "TweetClaw",
4
- "version": "1.3.0",
5
- "description": "Post tweets, reply, like, retweet, follow, DM from your chat - full X/Twitter automation powered by Xquik",
4
+ "version": "1.4.0",
5
+ "description": "Post tweets, reply, like, retweet, follow, DM from your chat - full X/Twitter automation powered by Xquik. 99 endpoints, reads from $0.00015/call.",
6
6
  "configSchema": {
7
7
  "type": "object",
8
8
  "additionalProperties": false,
9
9
  "properties": {
10
- "apiKey": { "type": "string", "minLength": 1, "description": "Xquik API key (get one at dashboard.xquik.com/en/account?tab=x-accounts). Required for full access." },
11
- "tempoPrivateKey": { "type": "string", "minLength": 1, "description": "Tempo wallet private key for MPP pay-per-use mode. No account needed. Only 7 read-only X-API endpoints." },
10
+ "apiKey": { "type": "string", "minLength": 1, "description": "Xquik API key (get one at dashboard.xquik.com). Required for full access to all 99 endpoints." },
11
+ "tempoPrivateKey": { "type": "string", "minLength": 1, "description": "Tempo wallet private key for MPP pay-per-use mode. No account needed. 8 read-only X-API endpoints." },
12
12
  "baseUrl": { "type": "string", "default": "https://xquik.com" },
13
13
  "pollingInterval": { "type": "number", "default": 60, "description": "Event polling interval in seconds" },
14
14
  "pollingEnabled": { "type": "boolean", "default": true }
@@ -19,8 +19,8 @@
19
19
  ]
20
20
  },
21
21
  "uiHints": {
22
- "apiKey": { "label": "Xquik API Key", "sensitive": true, "placeholder": "xq_...", "help": "Full access to all 97 endpoints. Generate at dashboard.xquik.com/en/account?tab=x-accounts." },
23
- "tempoPrivateKey": { "label": "Tempo Private Key (MPP)", "sensitive": true, "placeholder": "0x...", "help": "Pay-per-use mode via Machine Payments Protocol. No account needed. 7 read-only X-API endpoints only. Requires mppx and viem packages." },
22
+ "apiKey": { "label": "Xquik API Key", "sensitive": true, "placeholder": "xq_...", "help": "Full access to all 99 endpoints. Generate at dashboard.xquik.com." },
23
+ "tempoPrivateKey": { "label": "Tempo Private Key (MPP)", "sensitive": true, "placeholder": "0x...", "help": "Pay-per-use mode via Machine Payments Protocol. No account needed. 8 read-only X-API endpoints only. Requires mppx and viem packages." },
24
24
  "baseUrl": { "label": "API Base URL", "placeholder": "https://xquik.com", "advanced": true, "help": "Only change if using a self-hosted Xquik instance." },
25
25
  "pollingInterval": { "label": "Event Poll Interval (seconds)", "advanced": true, "help": "How often to check for new monitor events. Default: 60 seconds." },
26
26
  "pollingEnabled": { "label": "Enable Event Notifications", "advanced": true, "help": "Deliver monitor alerts and extraction completions to your chat." }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@xquik/tweetclaw",
3
- "version": "1.3.0",
4
- "description": "Post tweets, reply, like, retweet, follow, DM & more from OpenClaw - full X/Twitter automation via Xquik",
3
+ "version": "1.4.0",
4
+ "description": "Post tweets, reply, like, retweet, follow, DM & more from OpenClaw - full X/Twitter automation via Xquik. 99 endpoints, reads from $0.00015/call.",
5
5
  "license": "MIT",
6
6
  "type": "module",
7
7
  "repository": {
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: tweetclaw
3
- description: "OpenClaw plugin for X/Twitter automation. Post tweets, reply, like, retweet, follow, DM, search, extract data, run giveaways, monitor accounts, automate flows via Xquik. 97 endpoints, 2 tools (explore + tweetclaw), 2 commands (/xstatus, /xtrends), background event poller."
3
+ description: "OpenClaw plugin for X/Twitter automation. Post tweets, reply, like, retweet, follow, DM, search, extract data, run giveaways, monitor accounts, automate flows via Xquik. 99 endpoints, 2 tools (explore + tweetclaw), 2 commands (/xstatus, /xtrends), background event poller. Reads from $0.00015/call - 66x cheaper than the official X API."
4
4
  homepage: https://xquik.com
5
5
  read_when:
6
6
  - Posting, replying, liking, retweeting, or following on X/Twitter
@@ -11,17 +11,50 @@ read_when:
11
11
  - Extracting bulk data from X/Twitter (followers, replies, communities)
12
12
  - Downloading tweet media or uploading images
13
13
  - Sending DMs or updating X/Twitter profile
14
- metadata: {"openclaw":{"emoji":"🐦","primaryEnv":"XQUIK_API_KEY","requires":{"env":["XQUIK_API_KEY"]},"tags":["twitter","x","automation","social-media","tweets","scraping","giveaway","monitoring","rest-api"]}}
14
+ - Checking credit balance or topping up credits
15
+ - Browsing bookmarks, notifications, timeline, or DM history
16
+ metadata: {"openclaw":{"emoji":"🐦","primaryEnv":"XQUIK_API_KEY","requires":{"env":["XQUIK_API_KEY"]},"tags":["twitter","x","automation","social-media","tweets","scraping","giveaway","monitoring","rest-api","cheap-api"]}}
15
17
  ---
16
18
 
17
19
  # TweetClaw
18
20
 
19
- OpenClaw plugin for X/Twitter automation powered by Xquik. Install via:
21
+ OpenClaw plugin for X/Twitter automation powered by Xquik. **Reads from $0.00015/call - 66x cheaper than the official X API.**
20
22
 
21
23
  ```bash
22
24
  openclaw plugins install @xquik/tweetclaw
23
25
  ```
24
26
 
27
+ ## Pricing
28
+
29
+ TweetClaw uses Xquik's credit-based pricing. 1 credit = $0.00015.
30
+
31
+ ### Per-Operation Costs
32
+
33
+ | Operation | Credits | Cost |
34
+ |-----------|---------|------|
35
+ | Read (tweet, user, search, timeline, bookmarks, etc.) | 1 | $0.00015 |
36
+ | Follow check, article | 7 | $0.00105 |
37
+ | Write (tweet, like, retweet, follow, DM, etc.) | 2 | $0.0003 |
38
+ | Extraction / draw | 1/result | $0.00015/result |
39
+ | Monitors, webhooks, radar, compose, drafts, integrations | 0 | **Free** |
40
+
41
+ ### vs Official X API
42
+
43
+ | | Xquik | X API Basic | X API Pro |
44
+ |---|---|---|---|
45
+ | **Monthly cost** | **$20** | $100 | $5,000 |
46
+ | **Cost per tweet read** | **$0.00015** | ~$0.01 | ~$0.005 |
47
+ | **Cost per user lookup** | **$0.00015** | ~$0.01 | ~$0.005 |
48
+ | **Write actions** | **$0.0003** | Limited | Limited |
49
+ | **Bulk extraction** | **$0.00015/result** | Not available | Not available |
50
+
51
+ ### Pay-Per-Use (No Subscription)
52
+
53
+ - **Credits (Stripe)**: Top up via `POST /api/v1/credits/topup` ($10 minimum). Works with all 99 endpoints.
54
+ - **MPP (USDC)**: 8 read-only endpoints accept anonymous Tempo payments. No account needed. SDK: `npm i mppx`.
55
+
56
+ MPP pricing: tweet lookup ($0.00015), tweet search ($0.00015/tweet), user lookup ($0.00015), user tweets ($0.00015/tweet), follower check ($0.00105), article ($0.00105), media download ($0.00015/media), trends ($0.00015).
57
+
25
58
  ## When to Use
26
59
 
27
60
  Use TweetClaw when the user wants to:
@@ -32,6 +65,9 @@ Use TweetClaw when the user wants to:
32
65
  - Update their X profile, avatar, or banner
33
66
  - Upload media and tweet with images
34
67
  - Search tweets or look up user profiles
68
+ - Get user's recent tweets, liked tweets, or media tweets
69
+ - See who liked a tweet (favoriters) or mutual followers
70
+ - Browse bookmarks, notifications, timeline, or DM history
35
71
  - Extract bulk data (followers, replies, communities, spaces)
36
72
  - Run giveaway draws from tweet replies
37
73
  - Monitor X accounts for new activity
@@ -41,6 +77,7 @@ Use TweetClaw when the user wants to:
41
77
  - Download tweet media (images, videos, GIFs)
42
78
  - Set up Telegram alerts for monitor events
43
79
  - Create and manage automation flows (triggers, steps, test runs)
80
+ - Check credit balance or top up credits
44
81
  - Open and manage support tickets
45
82
  - Read X Articles (long-form posts)
46
83
 
@@ -54,7 +91,7 @@ Do NOT use TweetClaw for browsing X in a browser, analytics dashboards, scheduli
54
91
  openclaw config set plugins.entries.tweetclaw.config.apiKey 'xq_YOUR_KEY'
55
92
  ```
56
93
 
57
- Get a key at [dashboard.xquik.com/en/account?tab=x-accounts](https://dashboard.xquik.com/en/account?tab=x-accounts).
94
+ Get a key at [dashboard.xquik.com](https://dashboard.xquik.com/).
58
95
 
59
96
  ### MPP mode (no account, pay-per-use via Tempo/USDC)
60
97
 
@@ -63,11 +100,11 @@ npm i mppx viem
63
100
  openclaw config set plugins.entries.tweetclaw.config.tempoPrivateKey '0xYOUR_KEY'
64
101
  ```
65
102
 
66
- MPP gives agents access to 7 read-only X-API endpoints without any account or subscription. The mppx SDK handles HTTP 402 payment challenges automatically.
103
+ MPP gives agents access to 8 read-only X-API endpoints without any account or subscription. The mppx SDK handles HTTP 402 payment challenges automatically.
67
104
 
68
105
  ## Tools
69
106
 
70
- TweetClaw registers 2 tools that cover the entire Xquik API (97 endpoints):
107
+ TweetClaw registers 2 tools that cover the entire Xquik API (99 endpoints):
71
108
 
72
109
  ### `explore` (free, no network)
73
110
 
@@ -101,7 +138,7 @@ async () => {
101
138
 
102
139
  | Command | Description |
103
140
  |---------|-------------|
104
- | `/xstatus` | Account info, subscription status, usage |
141
+ | `/xstatus` | Account info, subscription status, usage, credit balance |
105
142
  | `/xtrends` | Trending topics from curated sources |
106
143
  | `/xtrends tech` | Trending topics filtered by category |
107
144
 
@@ -163,6 +200,27 @@ You: "Search tweets about AI agents"
163
200
  Agent uses tweetclaw -> calls search endpoint with query
164
201
  ```
165
202
 
203
+ ### Get user activity
204
+
205
+ ```
206
+ You: "Show me @elonmusk's recent tweets"
207
+ Agent uses tweetclaw -> GET /api/v1/x/users/{id}/tweets
208
+ ```
209
+
210
+ ### Check who liked a tweet
211
+
212
+ ```
213
+ You: "Who liked this tweet?"
214
+ Agent uses tweetclaw -> GET /api/v1/x/tweets/{id}/favoriters
215
+ ```
216
+
217
+ ### Browse bookmarks and timeline
218
+
219
+ ```
220
+ You: "Show my bookmarks" or "What's on my timeline?"
221
+ Agent uses tweetclaw -> GET /api/v1/x/bookmarks or GET /api/v1/x/timeline
222
+ ```
223
+
166
224
  ### Run a giveaway draw
167
225
 
168
226
  ```
@@ -212,6 +270,13 @@ You: "What's trending on X right now?"
212
270
  Agent uses tweetclaw -> returns curated trending topics from 7 sources
213
271
  ```
214
272
 
273
+ ### Check credits and top up
274
+
275
+ ```
276
+ You: "How many credits do I have?" or "Top up my credits"
277
+ Agent uses tweetclaw -> GET /api/v1/credits or POST /api/v1/credits/topup
278
+ ```
279
+
215
280
  ### Create an automation flow (free)
216
281
 
217
282
  ```
@@ -235,30 +300,21 @@ Agent uses tweetclaw -> creates ticket with subject and description
235
300
 
236
301
  ## API Categories
237
302
 
238
- | Category | Examples | Free |
303
+ | Category | Examples | Cost |
239
304
  |----------|---------|------|
240
- | Write Actions | Post tweets, reply, like, retweet, follow, DM, update profile | No |
241
- | Media | Upload media, download tweet media | No |
242
- | Twitter | Search tweets, look up users, check follows | No |
243
- | Composition | Compose, refine, score tweets; manage drafts | Yes |
305
+ | Write Actions | Post tweets, reply, like, retweet, follow, DM, update profile, avatar, banner | 2 credits |
306
+ | Media | Upload media, download tweet media | 1-2 credits |
307
+ | Twitter | Search tweets, look up users, user tweets/likes/media, favoriters, mutual followers, bookmarks, notifications, timeline, DM history | 1-7 credits |
308
+ | Composition | Compose, refine, score tweets; manage drafts | Free |
244
309
  | Styles | Analyze tweet styles, compare, performance | Mixed |
245
- | Extraction | Reply/follower/community extraction (20 tools) | No |
246
- | Draws | Giveaway draws, export results | No |
247
- | Monitoring | Create monitors, view events, webhooks | No |
248
- | Automations | Create flows, add steps, test runs, inbound webhooks | Yes |
249
- | Account | API keys, subscription, connected X accounts | Yes |
250
- | Trends | X trending topics, curated radar from 7 sources | Mixed |
251
- | Support | Create tickets, reply, track status | Yes |
252
-
253
- ## Pricing
254
-
255
- MPP pay-per-use (no account): 7 read-only X-API endpoints via Tempo (USDC) - tweet lookup ($0.0003), tweet search ($0.0003/tweet), user lookup ($0.00036), follower check ($0.002), article ($0.002), media download ($0.0003/media), trends ($0.0009).
256
-
257
- Free tier (API key, no subscription): tweet composition, style analysis, drafts, curated radar, account management, integrations, automations (create/test), support tickets.
258
-
259
- Subscription ($20/month): write actions, search, article lookup, media, extractions, draws, monitors, X trending, flow activation (2 free, 10 subscriber).
260
-
261
- When a paid endpoint returns 402, TweetClaw provides a checkout URL.
310
+ | Extraction | Reply/follower/community extraction (20 tools) | 1 credit/result |
311
+ | Draws | Giveaway draws, export results | 1 credit/entry |
312
+ | Monitoring | Create monitors, view events, webhooks | Free |
313
+ | Automations | Create flows, add steps, test runs, inbound webhooks | Free |
314
+ | Account | API keys, subscription, connected X accounts | Free |
315
+ | Credits | Check balance, top up | Free |
316
+ | Trends | X trending topics, curated radar from 7 sources | 1 credit / Free |
317
+ | Support | Create tickets, reply, track status | Free |
262
318
 
263
319
  ## Tips
264
320
 
@@ -268,5 +324,6 @@ When a paid endpoint returns 402, TweetClaw provides a checkout URL.
268
324
  - For write actions (post, like, follow, DM), always pass the `account` parameter with the X username
269
325
  - Follow/unfollow/DM require a numeric user ID - look up the user first via `/api/v1/x/users/:username`
270
326
  - On 402 errors, call `POST /api/v1/subscribe` to get a checkout URL instead of giving up
271
- - Use `/xstatus` to quickly check subscription and usage without invoking the AI agent
327
+ - Use `/xstatus` to quickly check subscription, usage, and credit balance without invoking the AI agent
272
328
  - The compose workflow (compose/refine/score) is free and helps draft high-engagement tweets
329
+ - Top up credits via `POST /api/v1/credits/topup` for pay-per-use without a subscription