twitterapi-io-mcp 1.0.14 → 1.0.16

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 (4) hide show
  1. package/README.md +132 -214
  2. package/data/docs.json +62 -6
  3. package/index.js +1 -1
  4. package/package.json +7 -2
package/README.md CHANGED
@@ -1,60 +1,77 @@
1
1
  # twitterapi-io-mcp
2
2
 
3
- **npm packages**
4
- - `twitterapi-io-mcp` (recommended, canonical)
5
- - `twitterapi-docs-mcp` (deprecated compatibility wrapper → delegates to `twitterapi-io-mcp`)
3
+ > **TL;DR**: Offline TwitterAPI.io documentation for Claude and AI assistants via MCP. No API key needed.
4
+
5
+ ```bash
6
+ # Quick Install (Claude Code)
7
+ claude mcp add twitterapi-io -- npx -y twitterapi-io-mcp
8
+ ```
6
9
 
7
10
  [![npm version](https://img.shields.io/npm/v/twitterapi-io-mcp.svg)](https://www.npmjs.com/package/twitterapi-io-mcp)
8
11
  [![npm downloads](https://img.shields.io/npm/dm/twitterapi-io-mcp.svg)](https://www.npmjs.com/package/twitterapi-io-mcp)
9
- [![npm version (legacy)](https://img.shields.io/npm/v/twitterapi-docs-mcp.svg)](https://www.npmjs.com/package/twitterapi-docs-mcp)
10
12
  [![MCP Registry](https://img.shields.io/badge/MCP-Registry-blue?logo=anthropic)](https://registry.modelcontextprotocol.io)
11
13
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
12
14
  [![Node.js](https://img.shields.io/badge/node-%3E%3D18.18.0-brightgreen.svg)](https://nodejs.org/)
13
15
 
14
- MCP (Model Context Protocol) server providing **offline access** to [TwitterAPI.io](https://twitterapi.io) documentation for Claude and other AI assistants.
16
+ ---
15
17
 
16
- > **Disclaimer**: This is an unofficial community project. Not affiliated with, endorsed by, or sponsored by TwitterAPI.io. TwitterAPI.io is a trademark of its respective owner.
18
+ ## What is this?
17
19
 
18
- **Links**
19
- - GitHub: https://github.com/dorukardahan/twitterapi-io-mcp
20
- - npm (recommended): https://www.npmjs.com/package/twitterapi-io-mcp
21
- - npm (legacy): https://www.npmjs.com/package/twitterapi-docs-mcp
22
- - Context7 (canonical): https://context7.com/dorukardahan/twitterapi-io-mcp
23
- - Context7 (legacy slugs): https://context7.com/dorukardahan/twitterapi-docs-mcp, https://context7.com/dorukardahan/twitterapi.io-mcp
20
+ An MCP (Model Context Protocol) server that gives Claude and other AI assistants **instant, offline access** to [TwitterAPI.io](https://twitterapi.io) documentation.
24
21
 
25
- ## Why I Built This
22
+ **What's included:**
23
+ - **59 API endpoints** with full documentation
24
+ - **19 guide pages** (pricing, authentication, rate limits, etc.)
25
+ - **21 blog posts** with tutorials and guides
26
+
27
+ > **Disclaimer**: Unofficial community project. Not affiliated with TwitterAPI.io.
28
+
29
+ ---
26
30
 
27
- I'm an independent developer who uses [TwitterAPI.io](https://twitterapi.io) for my projects. I found myself constantly switching between my code editor and the documentation website, searching for endpoint details, checking rate limits, and looking up authentication requirements.
31
+ ## For AI Assistants
28
32
 
29
- So I built this MCP server to have **instant access to the entire documentation** right inside Claude. No more tab-switching, no more searching — just ask Claude and get the answer.
33
+ If you're an AI assistant using this MCP server, here's how to help users:
30
34
 
31
- I'm sharing this with the community because if it helped me, it might help you too. 🚀
35
+ | User wants... | Use this tool | Example |
36
+ |---------------|---------------|---------|
37
+ | Find an endpoint | `search_twitterapi_docs` | `query: "advanced search"` |
38
+ | Endpoint details | `get_twitterapi_endpoint` | `endpoint_name: "tweet_advanced_search"` |
39
+ | List all endpoints | `list_twitterapi_endpoints` | `category: "user"` (optional) |
40
+ | Pricing info | `get_twitterapi_pricing` | - |
41
+ | Auth guide | `get_twitterapi_auth` | - |
42
+ | Any guide/page | `get_twitterapi_guide` | `guide_name: "qps_limits"` |
43
+ | Fetch by URL | `get_twitterapi_url` | `url: "pricing"` |
32
44
 
33
- ## Features
45
+ **Tips:**
46
+ - Search is fuzzy/typo-tolerant: `"twet object"` still works
47
+ - Use `max_results: 5` for focused results
48
+ - Check `deprecation_notice` field for legacy endpoints
34
49
 
35
- - **54 API endpoints** documented
36
- - **Site + docs pages** via sitemap + internal link crawl (pricing, QPS limits, privacy, contact, terms, acceptable use, dashboard, etc.)
37
- - **Blog posts** via blog index crawl (and internal discovery)
38
- - **Offline-first** - Works without network access
39
- - **Fast search** with fuzzy matching and camelCase support
40
- - **Hybrid caching** for optimal performance
50
+ ---
41
51
 
42
52
  ## Installation
43
53
 
44
- **Prerequisites**
45
- - Node.js `>=18.18.0` (required to run the MCP server)
46
- - Claude Code users: the `claude` CLI installed (for `claude mcp add`)
54
+ **Prerequisites:** Node.js `>=18.18.0`
47
55
 
48
- Note: This MCP server serves an **offline docs snapshot**. You do **not** need a TwitterAPI.io key just to use the docs tools.
56
+ ### Claude Code (Recommended)
49
57
 
50
- ### Claude Desktop
58
+ ```bash
59
+ # Add globally (all projects)
60
+ claude mcp add --scope user twitterapi-io -- npx -y twitterapi-io-mcp
51
61
 
52
- Requires Node.js `>=18.18.0` (because this runs via `npx`).
62
+ # Or project-only
63
+ claude mcp add twitterapi-io -- npx -y twitterapi-io-mcp
53
64
 
54
- Add to your Claude Desktop configuration file:
65
+ # Verify
66
+ claude mcp list
67
+ ```
68
+
69
+ ### Claude Desktop
55
70
 
56
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
57
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
71
+ Add to your config file:
72
+
73
+ - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
74
+ - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
58
75
 
59
76
  ```json
60
77
  {
@@ -67,237 +84,138 @@ Add to your Claude Desktop configuration file:
67
84
  }
68
85
  ```
69
86
 
70
- ### Claude Code
71
-
72
- Requires Node.js `>=18.18.0` (because this runs via `npx`).
73
-
74
- ```bash
75
- # Add globally (all projects)
76
- claude mcp add --scope user twitterapi-io -- npx -y twitterapi-io-mcp
77
-
78
- # Or add to current project only
79
- claude mcp add twitterapi-io -- npx -y twitterapi-io-mcp
80
-
81
- # Legacy name (still works, but deprecated)
82
- claude mcp add --scope user twitterapi-docs -- npx -y twitterapi-docs-mcp
83
- ```
87
+ ### Other MCP Clients
84
88
 
85
- Verify installation:
86
89
  ```bash
87
- claude mcp list
90
+ npx -y twitterapi-io-mcp
88
91
  ```
89
92
 
90
- Troubleshooting:
91
- - `claude: command not found` → install Claude Code / the `claude` CLI first
92
- - `npx` fails or shows syntax errors → upgrade Node.js to `>=18.18.0`
93
- - Corporate networks → ensure npm can reach the registry (or configure your proxy/registry)
94
- - Quick preflight: `node -v` and `claude --version` should both work before running `claude mcp add`
95
-
96
- ## Optional Configuration
97
-
98
- - `TWITTERAPI_MCP_DISK_CACHE=0` disables disk cache across sessions (default: on). TTL cleanup runs hourly.
93
+ ---
99
94
 
100
95
  ## Available Tools
101
96
 
102
97
  | Tool | Description |
103
98
  |------|-------------|
104
- | `search_twitterapi_docs` | Full-text search across all docs (endpoints, guides, blogs) |
105
- | `get_twitterapi_endpoint` | Get detailed info for a specific API endpoint |
106
- | `list_twitterapi_endpoints` | List all endpoints with optional category filter |
107
- | `get_twitterapi_guide` | Get a page by key (guides + other site/docs pages) |
108
- | `get_twitterapi_url` | Fetch by URL, bare path (`pricing`), or page key (`qps_limits`) (snapshot, optional live fetch) |
109
- | `get_twitterapi_pricing` | Quick access to pricing information |
110
- | `get_twitterapi_auth` | Quick access to authentication guide |
111
-
112
- ## Available Resources
113
-
114
- Note: resources are optional. The canonical guide fetch is `get_twitterapi_guide` (e.g., `guide_name: "changelog"`).
115
-
116
- | Resource URI | Description |
117
- |--------------|-------------|
118
- | `twitterapi://guides/pricing` | Pricing guide |
119
- | `twitterapi://guides/qps-limits` | QPS limits and rate limiting |
120
- | `twitterapi://guides/filter-rules` | Tweet filter rules syntax |
121
- | `twitterapi://guides/introduction` | Introduction to TwitterAPI.io |
122
- | `twitterapi://guides/authentication` | Authentication guide |
123
- | `twitterapi://endpoints/list` | Full endpoint listing |
124
- | `twitterapi://status/freshness` | Data freshness status |
125
-
126
- ## MCP Tool Recipes
127
-
128
- If you’re evaluating this MCP via Context7 or want copy/pasteable “tool chaining” patterns, see `CONTEXT7.md`.
129
-
130
- Focused, single-purpose recipes are in `recipes/` (e.g. `recipes/01-auth-summary.md`, `recipes/07-rate-limits.md`).
131
-
132
- Common workflows:
133
- - **Rate limits**: `search_twitterapi_docs` (`"rate limit qps"`) → `get_twitterapi_guide` (`"qps_limits"`)
134
- - **Typos are OK**: `search_twitterapi_docs` is fuzzy/typo-tolerant (e.g., `"twet object"`)
135
- - **Tweets Lookup**: `get_twitterapi_endpoint` (`"get_tweet_by_ids"`)
136
-
137
- ## Context7 Quick Recipes (copy/paste)
138
-
139
- ### Search → refine → endpoint details (Q2)
140
-
141
- ```json
142
- { "tool": "search_twitterapi_docs", "arguments": { "query": "advanced search", "max_results": 10 } }
143
- ```
144
-
145
- Filter to `type: "endpoint"` results. If none, retry with a narrower query like `"advanced search endpoint"`.
146
- Then fetch details using the returned `name`:
147
-
148
- ```json
149
- { "tool": "get_twitterapi_endpoint", "arguments": { "endpoint_name": "tweet_advanced_search" } }
150
- ```
151
-
152
- Ambiguity handling (if multiple endpoints are close in score):
153
-
154
- ```json
155
- { "tool": "search_twitterapi_docs", "arguments": { "query": "advanced search GET /twitter/tweet/advanced_search", "max_results": 10 } }
156
- ```
157
-
158
- Then pick the top `type: "endpoint"` result and call `get_twitterapi_endpoint` with its `name`.
99
+ | `search_twitterapi_docs` | Full-text search across all docs (fuzzy matching) |
100
+ | `get_twitterapi_endpoint` | Get detailed endpoint documentation |
101
+ | `list_twitterapi_endpoints` | List endpoints by category |
102
+ | `get_twitterapi_guide` | Get guide pages (pricing, auth, limits, etc.) |
103
+ | `get_twitterapi_url` | Fetch content by URL or page key |
104
+ | `get_twitterapi_pricing` | Quick pricing information |
105
+ | `get_twitterapi_auth` | Quick authentication guide |
159
106
 
160
- Routing tips (dynamic refinement):
161
- - If a result includes `next`, you can directly call `next.tool` with `next.arguments`.
162
- - If you get only `page`/`blog` results, route to `get_twitterapi_guide` or `get_twitterapi_url` instead of `get_twitterapi_endpoint`.
107
+ ---
163
108
 
164
- ### Changelogs via `get_twitterapi_guide` (Q7)
109
+ ## API Endpoint Categories
165
110
 
166
- ```json
167
- { "tool": "get_twitterapi_guide", "arguments": { "guide_name": "changelog" } }
168
- ```
111
+ | Category | Count | Examples |
112
+ |----------|-------|----------|
113
+ | **User** | 12 | get_user_by_username, get_user_followers, batch_get_user_by_userids |
114
+ | **Tweet** | 8 | tweet_advanced_search, get_tweet_by_ids, get_tweet_replies_v2 |
115
+ | **Community** | 9 | create_community_v2, get_community_by_id, join_community_v2 |
116
+ | **Profile** | 3 | update_avatar_v2, update_banner_v2, update_profile_v2 |
117
+ | **Webhook** | 4 | add_webhook_rule, get_webhook_rules, update_webhook_rule |
118
+ | **Stream** | 3 | add_user_to_monitor_tweet, get_user_to_monitor_tweet |
119
+ | **Action** | 14 | create_tweet_v2, like_tweet_v2, retweet_tweet_v2, upload_media_v2 |
120
+ | **DM** | 2 | send_dm_v2, get_dm_history_by_user_id |
121
+ | **List** | 2 | get_list_followers, get_list_members |
122
+ | **Other** | 2 | get_trends, get_space_detail |
169
123
 
170
- Do **not** use `resources/read` for this question; the canonical tool is `get_twitterapi_guide`.
124
+ **Total: 59 endpoints**
171
125
 
172
- ### Tweets Lookup endpoint details (Q9)
126
+ ---
173
127
 
174
- Tweets Lookup maps to `endpoint_name: "get_tweet_by_ids"`.
128
+ ## Usage Examples
175
129
 
176
- ```json
177
- { "tool": "get_twitterapi_endpoint", "arguments": { "endpoint_name": "get_tweet_by_ids" } }
178
- ```
130
+ Ask Claude:
179
131
 
180
- ### Auth metadata (Q1)
132
+ - *"What are the rate limits for TwitterAPI.io?"*
133
+ - *"Show me the tweet advanced search endpoint"*
134
+ - *"How do I authenticate with the API?"*
135
+ - *"What's the pricing?"*
136
+ - *"How do webhook filter rules work?"*
181
137
 
182
- ```json
183
- { "tool": "get_twitterapi_auth", "arguments": {} }
184
- ```
138
+ ---
185
139
 
186
- Endpoint details also include an `auth` block (header/base URL). For per-endpoint extras, scan `description`/`parameters` for `login_cookie` or `proxy`.
140
+ ## Configuration
187
141
 
188
- ### Authentication page snapshot (Q6)
142
+ | Environment Variable | Default | Description |
143
+ |---------------------|---------|-------------|
144
+ | `TWITTERAPI_MCP_DISK_CACHE` | `1` (on) | Set to `0` to disable disk caching |
189
145
 
190
- ```json
191
- { "tool": "get_twitterapi_url", "arguments": { "url": "/documentation/authentication" } }
192
- ```
146
+ ---
193
147
 
194
- Fallback if the snapshot is missing:
148
+ ## How It Works
195
149
 
196
- ```json
197
- { "tool": "get_twitterapi_guide", "arguments": { "guide_name": "authentication" } }
198
150
  ```
199
-
200
- ### Pagination search (Q5)
201
-
202
- ```json
203
- { "tool": "search_twitterapi_docs", "arguments": { "query": "pagination cursor next_cursor", "max_results": 10 } }
151
+ ┌─────────────┐ MCP Protocol ┌──────────────────┐
152
+ │ Claude │ ◄──────────────────► │ twitterapi-io-mcp│
153
+ │ (or any AI) │ │ │
154
+ └─────────────┘ │ Local docs.json │
155
+ │ (59 endpoints) │
156
+ └──────────────────┘
204
157
  ```
205
158
 
206
- ## Usage Examples
207
-
208
- Once installed, you can ask Claude questions like:
159
+ 1. AI assistant calls MCP tools (search, get endpoint, etc.)
160
+ 2. Server searches local documentation snapshot
161
+ 3. Results returned instantly (no network needed)
209
162
 
210
- - "What are the QPS limits for TwitterAPI.io?"
211
- - "Show me the advanced search endpoint"
212
- - "How do webhook filter rules work?"
213
- - "How do I get user followers?"
214
- - "What's the pricing structure?"
215
- - "How do I authenticate with the API?"
163
+ ---
216
164
 
217
- ## API Endpoint Categories
218
-
219
- | Category | Count | Examples |
220
- |----------|-------|----------|
221
- | **User** | 11 | get_user_by_username, get_user_followers, batch_get_user_by_userids |
222
- | **Tweet** | 7 | tweet_advanced_search, get_tweet_by_ids, get_tweet_quote |
223
- | **Community** | 9 | create_community_v2, get_community_by_id, join_community_v2 |
224
- | **Webhook** | 4 | add_webhook_rule, get_webhook_rules |
225
- | **Stream** | 2 | add_user_to_monitor_tweet, remove_user_to_monitor_tweet |
226
- | **Action** | 15 | create_tweet_v2, like_tweet_v2, upload_media_v2 |
227
- | **DM** | 2 | send_dm_v2, get_dm_history_by_user_id |
228
- | **List** | 2 | get_list_followers, get_list_members |
229
- | **Trend** | 1 | get_trends |
230
- | **Other** | 1 | get_space_detail |
231
-
232
- ## How It Works
233
-
234
- This MCP server bundles a snapshot of TwitterAPI.io documentation (scraped with permission patterns). When Claude or another MCP-compatible AI assistant needs information about TwitterAPI.io:
235
-
236
- 1. The assistant calls one of the available tools
237
- 2. The server searches/retrieves from the local documentation cache
238
- 3. Results are returned instantly without network latency
239
-
240
- The documentation includes:
241
- - Complete API reference with request/response examples
242
- - Authentication guides
243
- - Rate limiting information
244
- - Pricing details
245
- - Best practices
246
-
247
- ## Updating Documentation
248
-
249
- If TwitterAPI.io updates their documentation, clone the repo and run the scraper:
165
+ ## Development
250
166
 
251
167
  ```bash
252
168
  git clone https://github.com/dorukardahan/twitterapi-io-mcp.git
253
169
  cd twitterapi-io-mcp
254
170
  npm install
255
- node scrape-all.cjs
171
+ npm test # Run tests
172
+ npm start # Start server
173
+ npm run scrape # Update docs snapshot
256
174
  ```
257
175
 
258
- Note: The scraper is included in the repository but not in the npm package.
176
+ ---
259
177
 
260
- ## Development
178
+ ## Technical Details
261
179
 
262
- ```bash
263
- # Clone repository
264
- git clone https://github.com/dorukardahan/twitterapi-io-mcp.git
265
- cd twitterapi-io-mcp
180
+ | Property | Value |
181
+ |----------|-------|
182
+ | Runtime | Node.js 18.18.0+ |
183
+ | Module System | ES Modules (no build step) |
184
+ | Protocol | MCP via stdio |
185
+ | Caching | Hybrid (memory + disk), 24h TTL |
186
+ | Search | N-gram fuzzy matching |
266
187
 
267
- # Install dependencies
268
- npm install
188
+ ---
269
189
 
270
- # Run tests
271
- npm test
190
+ ## Links
272
191
 
273
- # Start server locally
274
- npm start
275
- ```
192
+ - **npm**: https://www.npmjs.com/package/twitterapi-io-mcp
193
+ - **GitHub**: https://github.com/dorukardahan/twitterapi-io-mcp
194
+ - **MCP Registry**: https://registry.modelcontextprotocol.io
195
+ - **TwitterAPI.io**: https://twitterapi.io
276
196
 
277
- ## Technical Details
197
+ ---
198
+
199
+ ## Why I Built This
200
+
201
+ I use [TwitterAPI.io](https://twitterapi.io) for my projects and got tired of switching between my editor and docs. Now I just ask Claude. If it helps me, maybe it helps you too.
278
202
 
279
- - **Runtime**: Node.js 18.18.0+
280
- - **Module System**: ES Modules (no build step)
281
- - **Protocol**: MCP (Model Context Protocol) via stdio
282
- - **Caching**: Hybrid (memory + disk) with 24-hour TTL
283
- - **Search**: Advanced tokenization with n-gram fuzzy matching
203
+ ---
284
204
 
285
205
  ## Contributing
286
206
 
287
- Contributions are welcome! Please feel free to submit a Pull Request.
207
+ PRs welcome! Fork → branch → commit → PR.
288
208
 
289
- 1. Fork the repository
290
- 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
291
- 3. Commit your changes (`git commit -m 'Add amazing feature'`)
292
- 4. Push to the branch (`git push origin feature/amazing-feature`)
293
- 5. Open a Pull Request
209
+ ---
294
210
 
295
211
  ## License
296
212
 
297
- [MIT](LICENSE) - see LICENSE file for details.
213
+ [MIT](LICENSE)
214
+
215
+ ---
298
216
 
299
217
  ## Acknowledgments
300
218
 
301
- - [TwitterAPI.io](https://twitterapi.io) for providing excellent Twitter/X API access
302
- - [Anthropic](https://anthropic.com) for the Model Context Protocol
303
- - [MCP SDK](https://github.com/modelcontextprotocol/typescript-sdk) for the server framework
219
+ - [TwitterAPI.io](https://twitterapi.io) for the API service
220
+ - [Anthropic](https://anthropic.com) for MCP
221
+ - [MCP SDK](https://github.com/modelcontextprotocol/typescript-sdk)
package/data/docs.json CHANGED
@@ -133,7 +133,8 @@
133
133
  "{\n \"status\": \"<string>\",\n \"msg\": \"<string>\",\n \"data\": {\n \"create_tweet\": {\n \"tweet_result\": {\n \"result\": {\n \"rest_id\": \"<string>\"\n }\n }\n }\n }\n}"
134
134
  ],
135
135
  "curl_example": "curl --request POST \\\n --url https://api.twitterapi.io/twitter/create_tweet \\\n --header 'Content-Type: application/json' \\\n --header 'X-API-Key: <api-key>' \\\n --data '\n{\n \"auth_session\": \"<string>\",\n \"tweet_text\": \"<string>\",\n \"proxy\": \"<string>\",\n \"quote_tweet_id\": \"<string>\",\n \"in_reply_to_tweet_id\": \"<string>\",\n \"media_id\": \"<string>\"\n}\n'",
136
- "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Tweet Action Endpoint--deprecated Post/reply/quote a tweet Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/create_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_text\": \"<string>\", \"proxy\": \"<string>\", \"quote_tweet_id\": \"<string>\", \"in_reply_to_tweet_id\": \"<string>\", \"media_id\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"data\" : { \"create_tweet\" : { \"tweet_result\" : { \"result\" : { \"rest_id\" : \"<string>\" } } } } } Tweet Action Endpoint--deprecated Post/reply/quote a tweet Create a tweet.Need to login first.Trial operation price: $0.001 per call. POST / twitter / create_tweet Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/create_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_text\": \"<string>\", \"proxy\": \"<string>\", \"quote_tweet_id\": \"<string>\", \"in_reply_to_tweet_id\": \"<string>\", \"media_id\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"data\" : { \"create_tweet\" : { \"tweet_result\" : { \"result\" : { \"rest_id\" : \"<string>\" } } } } } Authorizations ​ X-API-Key string header required Body application/json ​ auth_session string required The session of the login. It's returned by /twitter/login_by_2fa ​ tweet_text string required The text of the tweet. ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port.You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 ​ quote_tweet_id string The id of the tweet to quote.Optional ​ in_reply_to_tweet_id string The id of the tweet to reply to.Optional ​ media_id string The id of the media to attach.Optional Response 200 application/json Create tweet response ​ status string Status of the request.success or error ​ msg string Message of the request.error message ​ data object The data of the tweet Show child attributes Upload Image Like a tweet ⌘ I telegram Powered by Mintlify"
136
+ "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Tweet Action Endpoint--deprecated Post/reply/quote a tweet Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/create_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_text\": \"<string>\", \"proxy\": \"<string>\", \"quote_tweet_id\": \"<string>\", \"in_reply_to_tweet_id\": \"<string>\", \"media_id\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"data\" : { \"create_tweet\" : { \"tweet_result\" : { \"result\" : { \"rest_id\" : \"<string>\" } } } } } Tweet Action Endpoint--deprecated Post/reply/quote a tweet Create a tweet.Need to login first.Trial operation price: $0.001 per call. POST / twitter / create_tweet Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/create_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_text\": \"<string>\", \"proxy\": \"<string>\", \"quote_tweet_id\": \"<string>\", \"in_reply_to_tweet_id\": \"<string>\", \"media_id\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"data\" : { \"create_tweet\" : { \"tweet_result\" : { \"result\" : { \"rest_id\" : \"<string>\" } } } } } Authorizations ​ X-API-Key string header required Body application/json ​ auth_session string required The session of the login. It's returned by /twitter/login_by_2fa ​ tweet_text string required The text of the tweet. ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port.You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 ​ quote_tweet_id string The id of the tweet to quote.Optional ​ in_reply_to_tweet_id string The id of the tweet to reply to.Optional ​ media_id string The id of the media to attach.Optional Response 200 application/json Create tweet response ​ status string Status of the request.success or error ​ msg string Message of the request.error message ​ data object The data of the tweet Show child attributes Upload Image Like a tweet ⌘ I telegram Powered by Mintlify",
137
+ "deprecation_notice": "ℹ️ LEGACY VERSION: This v1 endpoint uses auth_session from the legacy login flow. For the newer authentication using login_cookies, see create_tweet_v2."
137
138
  },
138
139
  "create_tweet_v2": {
139
140
  "name": "create_tweet_v2",
@@ -694,7 +695,8 @@
694
695
  "{\n \"status\": \"<string>\",\n \"msg\": \"<string>\"\n}"
695
696
  ],
696
697
  "curl_example": "curl --request POST \\\n --url https://api.twitterapi.io/twitter/like_tweet \\\n --header 'Content-Type: application/json' \\\n --header 'X-API-Key: <api-key>' \\\n --data '\n{\n \"auth_session\": \"<string>\",\n \"tweet_id\": \"<string>\",\n \"proxy\": \"<string>\"\n}\n'",
697
- "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Tweet Action Endpoint--deprecated Like a tweet Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/like_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_id\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Tweet Action Endpoint--deprecated Like a tweet Like a tweet.Need to login first. Trial operation price: $0.001 per call. POST / twitter / like_tweet Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/like_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_id\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ auth_session string required The session of the login. It's returned by /twitter/login_by_2fa ​ tweet_id string required The id of the tweet to like ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port.You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 Response 200 application/json Like tweet response ​ status string Status of the request.success or error ​ msg string Message of the request.error message Post/reply/quote a tweet Reweet a tweet ⌘ I telegram Powered by Mintlify"
698
+ "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Tweet Action Endpoint--deprecated Like a tweet Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/like_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_id\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Tweet Action Endpoint--deprecated Like a tweet Like a tweet.Need to login first. Trial operation price: $0.001 per call. POST / twitter / like_tweet Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/like_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_id\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ auth_session string required The session of the login. It's returned by /twitter/login_by_2fa ​ tweet_id string required The id of the tweet to like ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port.You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 Response 200 application/json Like tweet response ​ status string Status of the request.success or error ​ msg string Message of the request.error message Post/reply/quote a tweet Reweet a tweet ⌘ I telegram Powered by Mintlify",
699
+ "deprecation_notice": "ℹ️ LEGACY VERSION: This v1 endpoint uses auth_session from the legacy login flow. For the newer authentication using login_cookies, see like_tweet_v2."
698
700
  },
699
701
  "like_tweet_v2": {
700
702
  "name": "like_tweet_v2",
@@ -728,7 +730,8 @@
728
730
  "{\n \"session\": \"<string>\",\n \"status\": \"<string>\",\n \"msg\": \"<string>\",\n \"user\": {\n \"id_str\": \"<string>\",\n \"screen_name\": \"<string>\",\n \"name\": \"<string>\"\n }\n}"
729
731
  ],
730
732
  "curl_example": "curl --request POST \\\n --url https://api.twitterapi.io/twitter/login_by_2fa \\\n --header 'Content-Type: application/json' \\\n --header 'X-API-Key: <api-key>' \\\n --data '\n{\n \"login_data\": \"<string>\",\n \"2fa_code\": \"<string>\",\n \"proxy\": \"<string>\"\n}\n'",
731
- "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Login Endpoint--deprecated Login Step 2: by 2fa code Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/login_by_2fa \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"login_data\": \"<string>\", \"2fa_code\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"session\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"user\" : { \"id_str\" : \"<string>\" , \"screen_name\" : \"<string>\" , \"name\" : \"<string>\" } } Login Endpoint--deprecated Login Step 2: by 2fa code Deprecated soon. Please use login V2 instead, as it is more stable.Login Step 2: by 2fa code.Trial operation price: $0.003 per call. POST / twitter / login_by_2fa Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/login_by_2fa \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"login_data\": \"<string>\", \"2fa_code\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"session\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"user\" : { \"id_str\" : \"<string>\" , \"screen_name\" : \"<string>\" , \"name\" : \"<string>\" } } Authorizations ​ X-API-Key string header required Body application/json ​ login_data string required The login data returned by /twitter/login_by_email_or_username ​ 2fa_code string required The 2fa code of the user. get 2fa code from https://2fa.fb.rip/ ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port .You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 Response 200 application/json Login Step 2(2fa) response ​ session string The session of the login.Use this session to call other endpoints.eg. /twitter/create_tweet /twitter/like_tweet ​ status string Status of the request.success or error ​ msg string Message of the request.error message ​ user object The user info of the login. Show child attributes Login Step 1: by email or username Upload Image ⌘ I telegram Powered by Mintlify"
733
+ "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Login Endpoint--deprecated Login Step 2: by 2fa code Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/login_by_2fa \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"login_data\": \"<string>\", \"2fa_code\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"session\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"user\" : { \"id_str\" : \"<string>\" , \"screen_name\" : \"<string>\" , \"name\" : \"<string>\" } } Login Endpoint--deprecated Login Step 2: by 2fa code Deprecated soon. Please use login V2 instead, as it is more stable.Login Step 2: by 2fa code.Trial operation price: $0.003 per call. POST / twitter / login_by_2fa Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/login_by_2fa \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"login_data\": \"<string>\", \"2fa_code\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"session\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"user\" : { \"id_str\" : \"<string>\" , \"screen_name\" : \"<string>\" , \"name\" : \"<string>\" } } Authorizations ​ X-API-Key string header required Body application/json ​ login_data string required The login data returned by /twitter/login_by_email_or_username ​ 2fa_code string required The 2fa code of the user. get 2fa code from https://2fa.fb.rip/ ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port .You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 Response 200 application/json Login Step 2(2fa) response ​ session string The session of the login.Use this session to call other endpoints.eg. /twitter/create_tweet /twitter/like_tweet ​ status string Status of the request.success or error ​ msg string Message of the request.error message ​ user object The user info of the login. Show child attributes Login Step 1: by email or username Upload Image ⌘ I telegram Powered by Mintlify",
734
+ "deprecation_notice": "⚠️ DEPRECATED: This endpoint is deprecated. Please use user_login_v2 instead for a more stable authentication flow."
732
735
  },
733
736
  "login_by_email_or_username": {
734
737
  "name": "login_by_email_or_username",
@@ -745,7 +748,8 @@
745
748
  "{\n \"hint\": \"<string>\",\n \"login_data\": \"<string>\",\n \"status\": \"<string>\",\n \"msg\": \"<string>\"\n}"
746
749
  ],
747
750
  "curl_example": "curl --request POST \\\n --url https://api.twitterapi.io/twitter/login_by_email_or_username \\\n --header 'Content-Type: application/json' \\\n --header 'X-API-Key: <api-key>' \\\n --data '\n{\n \"username_or_email\": \"<string>\",\n \"password\": \"<string>\",\n \"proxy\": \"<string>\"\n}\n'",
748
- "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Login Endpoint--deprecated Login Step 1: by email or username Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/login_by_email_or_username \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"username_or_email\": \"<string>\", \"password\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"hint\" : \"<string>\" , \"login_data\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Login Endpoint--deprecated Login Step 1: by email or username Login Step 1: by email or username.Recommend to use email.Trial operation price: $0.003 per call. Please read the guide: https://twitterapi.io/blog/twitter-login-and-post-api-guide POST / twitter / login_by_email_or_username Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/login_by_email_or_username \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"username_or_email\": \"<string>\", \"password\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"hint\" : \"<string>\" , \"login_data\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ username_or_email string required User name or email.If you can't log in with your email, use your username. If you can't log in with your username, use your email instead.ref: https://twitterapi.io/blog/twitter-login-and-post-api-guide ​ password string required The password of the user ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port . You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 Response 200 application/json Login response ​ hint string Hint of the login.eg. \"Please use second endpoint /login_2fa to continue login.\" ​ login_data string Use this data to call /twitter/login_2fa to continue login. ​ status string Status of the request.success or error ​ msg string Message of the request.error message Remove a user from monitor list Login Step 2: by 2fa code ⌘ I telegram Powered by Mintlify"
751
+ "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Login Endpoint--deprecated Login Step 1: by email or username Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/login_by_email_or_username \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"username_or_email\": \"<string>\", \"password\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"hint\" : \"<string>\" , \"login_data\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Login Endpoint--deprecated Login Step 1: by email or username Login Step 1: by email or username.Recommend to use email.Trial operation price: $0.003 per call. Please read the guide: https://twitterapi.io/blog/twitter-login-and-post-api-guide POST / twitter / login_by_email_or_username Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/login_by_email_or_username \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"username_or_email\": \"<string>\", \"password\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"hint\" : \"<string>\" , \"login_data\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ username_or_email string required User name or email.If you can't log in with your email, use your username. If you can't log in with your username, use your email instead.ref: https://twitterapi.io/blog/twitter-login-and-post-api-guide ​ password string required The password of the user ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port . You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 Response 200 application/json Login response ​ hint string Hint of the login.eg. \"Please use second endpoint /login_2fa to continue login.\" ​ login_data string Use this data to call /twitter/login_2fa to continue login. ​ status string Status of the request.success or error ​ msg string Message of the request.error message Remove a user from monitor list Login Step 2: by 2fa code ⌘ I telegram Powered by Mintlify",
752
+ "deprecation_notice": "⚠️ LEGACY: This is the first step of the legacy 2FA login flow. Consider using user_login_v2 for the newer, recommended authentication method."
749
753
  },
750
754
  "remove_user_to_monitor_tweet": {
751
755
  "name": "remove_user_to_monitor_tweet",
@@ -779,7 +783,8 @@
779
783
  "{\n \"status\": \"<string>\",\n \"msg\": \"<string>\"\n}"
780
784
  ],
781
785
  "curl_example": "curl --request POST \\\n --url https://api.twitterapi.io/twitter/retweet_tweet \\\n --header 'Content-Type: application/json' \\\n --header 'X-API-Key: <api-key>' \\\n --data '\n{\n \"auth_session\": \"<string>\",\n \"tweet_id\": \"<string>\",\n \"proxy\": \"<string>\"\n}\n'",
782
- "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Tweet Action Endpoint--deprecated Reweet a tweet Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/retweet_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_id\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Tweet Action Endpoint--deprecated Reweet a tweet Retweet a tweet.Need to login first. Trial operation price: $0.001 per call. POST / twitter / retweet_tweet Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/retweet_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_id\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ auth_session string required The session of the login. It's returned by /twitter/login_by_2fa ​ tweet_id string required The id of the tweet to retweet ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port.You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 Response 200 application/json Retweet tweet response ​ status string Status of the request.success or error ​ msg string Message of the request.error message Like a tweet ⌘ I telegram Powered by Mintlify"
786
+ "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Tweet Action Endpoint--deprecated Reweet a tweet Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/retweet_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_id\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Tweet Action Endpoint--deprecated Reweet a tweet Retweet a tweet.Need to login first. Trial operation price: $0.001 per call. POST / twitter / retweet_tweet Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/retweet_tweet \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"tweet_id\": \"<string>\", \"proxy\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ auth_session string required The session of the login. It's returned by /twitter/login_by_2fa ​ tweet_id string required The id of the tweet to retweet ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port.You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 Response 200 application/json Retweet tweet response ​ status string Status of the request.success or error ​ msg string Message of the request.error message Like a tweet ⌘ I telegram Powered by Mintlify",
787
+ "deprecation_notice": "ℹ️ LEGACY VERSION: This v1 endpoint uses auth_session from the legacy login flow. For the newer authentication using login_cookies, see retweet_tweet_v2."
783
788
  },
784
789
  "retweet_tweet_v2": {
785
790
  "name": "retweet_tweet_v2",
@@ -933,7 +938,8 @@
933
938
  "{\n \"status\": \"<string>\",\n \"msg\": \"<string>\",\n \"media_id\": \"<string>\"\n}"
934
939
  ],
935
940
  "curl_example": "curl --request POST \\\n --url https://api.twitterapi.io/twitter/upload_image \\\n --header 'Content-Type: application/json' \\\n --header 'X-API-Key: <api-key>' \\\n --data '\n{\n \"auth_session\": \"<string>\",\n \"proxy\": \"<string>\",\n \"image_url\": \"<string>\"\n}\n'",
936
- "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Tweet Action Endpoint--deprecated Upload Image Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/upload_image \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"proxy\": \"<string>\", \"image_url\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"media_id\" : \"<string>\" } Tweet Action Endpoint--deprecated Upload Image upload image to twitter.Need to login first. Trial operation price: $0.001 per call. POST / twitter / upload_image Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/upload_image \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"proxy\": \"<string>\", \"image_url\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"media_id\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ auth_session string required The session of the login. It's returned by /twitter/login_by_2fa ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port ​ image_url string The url of the image to upload Response 200 application/json Upload image response ​ status string Status of the request.success or error ​ msg string Message of the request.error message ​ media_id string The id of the uploaded image Login Step 2: by 2fa code Post/reply/quote a tweet ⌘ I telegram Powered by Mintlify"
941
+ "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Tweet Action Endpoint--deprecated Upload Image Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/upload_image \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"proxy\": \"<string>\", \"image_url\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"media_id\" : \"<string>\" } Tweet Action Endpoint--deprecated Upload Image upload image to twitter.Need to login first. Trial operation price: $0.001 per call. POST / twitter / upload_image Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/upload_image \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"auth_session\": \"<string>\", \"proxy\": \"<string>\", \"image_url\": \"<string>\" } ' 200 400 Copy { \"status\" : \"<string>\" , \"msg\" : \"<string>\" , \"media_id\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ auth_session string required The session of the login. It's returned by /twitter/login_by_2fa ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port ​ image_url string The url of the image to upload Response 200 application/json Upload image response ​ status string Status of the request.success or error ​ msg string Message of the request.error message ​ media_id string The id of the uploaded image Login Step 2: by 2fa code Post/reply/quote a tweet ⌘ I telegram Powered by Mintlify",
942
+ "deprecation_notice": "ℹ️ LEGACY VERSION: Consider using upload_media_v2 for the newer authentication method."
937
943
  },
938
944
  "user_login_v2": {
939
945
  "name": "user_login_v2",
@@ -951,6 +957,56 @@
951
957
  ],
952
958
  "curl_example": "curl --request POST \\\n --url https://api.twitterapi.io/twitter/user_login_v2 \\\n --header 'Content-Type: application/json' \\\n --header 'X-API-Key: <api-key>' \\\n --data '\n{\n \"user_name\": \"<string>\",\n \"email\": \"<string>\",\n \"password\": \"<string>\",\n \"proxy\": \"<string>\",\n \"totp_secret\": \"<string>\"\n}\n'",
953
959
  "raw_text": "twitterapi.io - Twitter data, 96% cheaper. No auth, no limits, just API. Skip to main content KaitoTwitterAPI home page Search... ⌘ K Support Start Now Start Now Search... Navigation Post & Action Endpoint V2 Log in Get Started Introduction Authentication User Endpoint GET Get User Profile About GET Batch Get User Info By UserIds GET Get User Info GET Get User Last Tweets GET Get User Followers GET Get User Followings GET Get User Mentions GET Check Follow Relationship GET Search user by keyword GET Get User Verified Followers Tweet Endpoint GET Get Tweets by IDs GET Get Tweet Replies GET Get Tweet Quotations GET Get Tweet Retweeters GET Get Tweet Thread Context GET Get Article GET Advanced Search List Endpoint GET Get List Followers GET Get List Members Communities Endpoint GET Get Community Info By Id GET Get Community Members GET Get Community Moderators GET Get Community Tweets GET Search Tweets From All Community Trend Endpoint GET Get Trends Spaces Endpoint GET Get Space Detail My Endpoint GET Get My Account Info Post & Action Endpoint V2 POST Log in POST Upload media POST Create tweet v2 GET Get History Messages By UserID POST Send DM V2 POST Retweet Tweet POST Dlete Tweet POST Follow User POST Unfollow User POST Like Tweet POST Unlike Tweet POST Create Community V2 POST Delete Community V2 POST Join Community v2 POST Leave Community V2 Webhook/Websocket Filter Rule POST Add Webhook/Websocket Tweet Filter Rule GET Get ALL test Webhook/Websocket Tweet Filter Rules POST Update Webhook/Websocket Tweet Filter Rule DEL Delete Webhook/Websocket Tweet Filter Rule Stream Endpoint POST Add a twitter user to monitor his tweets POST Remove a user from monitor list Login Endpoint--deprecated POST Login Step 1: by email or username POST Login Step 2: by 2fa code Tweet Action Endpoint--deprecated POST Upload Image POST Post/reply/quote a tweet POST Like a tweet POST Reweet a tweet cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/user_login_v2 \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"user_name\": \"<string>\", \"email\": \"<string>\", \"password\": \"<string>\", \"proxy\": \"<string>\", \"totp_secret\": \"<string>\" } ' 200 400 Copy { \"login_cookie\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Post & Action Endpoint V2 Log in Log in directly using your email, username, password, and 2FA secret key. And obtain the Login_cookie, to post tweets, etc. Please note that the Login_cookie obtained through login_v2 can only be used for APIs with the “v2” suffix, such as create_tweet_v2. Trial operation price: $0.003 per call. POST / twitter / user_login_v2 Try it cURL cURL Copy curl --request POST \\ --url https://api.twitterapi.io/twitter/user_login_v2 \\ --header 'Content-Type: application/json' \\ --header 'X-API-Key: <api-key>' \\ --data ' { \"user_name\": \"<string>\", \"email\": \"<string>\", \"password\": \"<string>\", \"proxy\": \"<string>\", \"totp_secret\": \"<string>\" } ' 200 400 Copy { \"login_cookie\" : \"<string>\" , \"status\" : \"<string>\" , \"msg\" : \"<string>\" } Authorizations ​ X-API-Key string header required Body application/json ​ user_name string required User name.Must be set ​ email string required Email.Must be set ​ password string required The password of the user ​ proxy string required The proxy to use.Please use high-quality residential proxies and avoid free proxies.Required.Example: http://username:password@ip:port . You can get proxy from: https://www.webshare.io/?referral_code=4e0q1n00a504 ​ totp_secret string The totp secret of the user.If you don't have it, you can get it from the user's profile page.This field is required because it will make your login more reliable and less likely to be banned. Response 200 application/json Login response ​ login_cookie string The login cookie of the user.Use this cookie to post tweets, etc.You can only call v2 APIs with this cookie.If your account is in good standing and you're using residential proxies, the cookies will generally remain valid indefinitely. ​ status string Status of the request.success or error ​ msg string Message of the request.error message Get My Account Info Upload media ⌘ I telegram Powered by Mintlify"
960
+ },
961
+ "update_avatar_v2": {
962
+ "name": "update_avatar_v2",
963
+ "title": "Update Avatar V2",
964
+ "path": "/twitter/update_avatar_v2",
965
+ "type": "PATCH",
966
+ "url": "https://docs.twitterapi.io/api-reference/endpoint/update_avatar_v2",
967
+ "description": "Update Twitter profile picture. Requires login_cookies from user_login_v2. Trial price: $0.003/call. Image: JPG/PNG, 400x400px recommended, max 700KB.",
968
+ "raw_text": "PATCH /twitter/update_avatar_v2 - Update profile picture. Parameters: login_cookies (required), proxy (required), file (binary, required). Response: {status, message}",
969
+ "scraped_at": "2026-01-26T10:24:36.597Z"
970
+ },
971
+ "update_banner_v2": {
972
+ "name": "update_banner_v2",
973
+ "title": "Update Banner V2",
974
+ "path": "/twitter/update_banner_v2",
975
+ "type": "PATCH",
976
+ "url": "https://docs.twitterapi.io/api-reference/endpoint/update_banner_v2",
977
+ "description": "Update Twitter banner/header image. Requires login_cookies from user_login_v2. Trial price: $0.003/call. Image: JPG/PNG, 1500x500px recommended, max 2MB.",
978
+ "raw_text": "PATCH /twitter/update_banner_v2 - Update banner image. Parameters: login_cookies (required), proxy (required), file (binary, required). Response: {status, message}",
979
+ "scraped_at": "2026-01-26T10:24:36.598Z"
980
+ },
981
+ "update_profile_v2": {
982
+ "name": "update_profile_v2",
983
+ "title": "Update Profile V2",
984
+ "path": "/twitter/update_profile_v2",
985
+ "type": "PATCH",
986
+ "url": "https://docs.twitterapi.io/api-reference/endpoint/update_profile_v2",
987
+ "description": "Update Twitter profile info (name, bio, location, url). Requires login_cookies from user_login_v2. Trial price: $0.003/call.",
988
+ "raw_text": "PATCH /twitter/update_profile_v2 - Update profile info. Parameters: login_cookies (required), proxy (required), name (optional, max 50 chars), description (optional, max 160 chars), location (optional, max 30 chars), url (optional). Response: {status, message}",
989
+ "scraped_at": "2026-01-26T10:24:36.598Z"
990
+ },
991
+ "get_tweet_replies_v2": {
992
+ "name": "get_tweet_replies_v2",
993
+ "title": "Get Tweet Replies V2",
994
+ "path": "/twitter/tweet/replies/v2",
995
+ "type": "GET",
996
+ "url": "https://docs.twitterapi.io/api-reference/endpoint/get_tweet_replies_v2",
997
+ "description": "Get tweet replies by tweet ID (V2). Returns up to 20 replies per page. Supports pagination and sorting by Relevance, Latest, or Likes.",
998
+ "raw_text": "GET /twitter/tweet/replies/v2 - Get tweet replies. Parameters: tweetId (required), cursor (optional), queryType (optional: Relevance/Latest/Likes). Response: {replies[], has_next_page, next_cursor, status, message}",
999
+ "scraped_at": "2026-01-26T10:24:36.598Z"
1000
+ },
1001
+ "get_user_to_monitor_tweet": {
1002
+ "name": "get_user_to_monitor_tweet",
1003
+ "title": "Get Users to Monitor Tweet",
1004
+ "path": "/oapi/x_user_stream/get_user_to_monitor_tweet",
1005
+ "type": "GET",
1006
+ "url": "https://docs.twitterapi.io/api-reference/endpoint/get_user_to_monitor_tweet",
1007
+ "description": "Get all users that have been added for tweet monitoring. Returns list of monitored users with their settings.",
1008
+ "raw_text": "GET /oapi/x_user_stream/get_user_to_monitor_tweet - Get monitored users. No parameters required. Response: {status, msg, data[{id_for_user, x_user_id, x_user_name, x_user_screen_name, is_monitor_tweet, is_monitor_profile, ...}]}",
1009
+ "scraped_at": "2026-01-26T10:24:36.598Z"
954
1010
  }
955
1011
  },
956
1012
  "pages": {
package/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  #!/usr/bin/env node
2
2
  /**
3
- * TwitterAPI.io Documentation MCP Server v1.0.14
3
+ * TwitterAPI.io Documentation MCP Server v1.0.16
4
4
  *
5
5
  * Production-ready MCP server with:
6
6
  * - Comprehensive error handling with ErrorType classification
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "twitterapi-io-mcp",
3
- "version": "1.0.14",
3
+ "version": "1.0.16",
4
4
  "mcpName": "io.github.dorukardahan/twitterapi-io-mcp",
5
5
  "description": "TwitterAPI.io MCP server providing offline access to docs (endpoints, pages, blogs) for Claude and other AI assistants",
6
6
  "main": "index.js",
@@ -21,15 +21,20 @@
21
21
  "model-context-protocol",
22
22
  "claude",
23
23
  "twitter",
24
+ "twitter-api",
25
+ "x-api",
24
26
  "twitterapi",
25
27
  "twitterapi.io",
26
28
  "twitterapi-io",
27
29
  "twitterapi-io-mcp",
28
30
  "api-documentation",
31
+ "api-reference",
29
32
  "ai-assistant",
30
33
  "llm",
31
34
  "anthropic",
32
- "offline-docs"
35
+ "offline-docs",
36
+ "claude-mcp",
37
+ "twitter-docs"
33
38
  ],
34
39
  "author": "Doruk Ardahan",
35
40
  "license": "MIT",