Skip to content

Commit d14893b

Browse files
lanbytescursoragent
andcommitted
Add a Prefect collection page to the Mintlify docs.
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent e022a71 commit d14893b

9 files changed

Lines changed: 39 additions & 10 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Documentation for [TwexAPI](https://twexapi.io), an X (Twitter) Scraper API and X API alternative. Intended for **[docs.twexapi.io](https://docs.twexapi.io)**.
77

8-
This repository covers REST, MCP, SDKs, CLI, Terraform, n8n, and Apify. The OpenAPI contract currently documents **66** operations.
8+
This repository covers REST, MCP, SDKs, CLI, Terraform, n8n, Prefect, and Apify. The OpenAPI contract currently documents **66** operations.
99

1010
## Start here
1111

@@ -33,6 +33,7 @@ python3 scripts/generate-api-pages.py
3333
- [Skill and MCP catalog](https://github.com/twexapi-dev/x-api-scraper)
3434
- [TypeScript SDK](https://github.com/twexapi-dev/x-api-scraper-typescript)
3535
- [n8n node](https://github.com/twexapi-dev/n8n-nodes-x-api-scraper)
36+
- [Prefect collection](https://github.com/twexapi-dev/prefect-x-api-scraper)
3637

3738
## License
3839

changelog.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ description: "Docs repository changes for the TwexAPI Mintlify site."
66
## 2026-08-24
77

88
- First public docs repository aligned with the 66-operation SDK OpenAPI.
9-
- REST, MCP, SDK, CLI, Terraform, n8n, and Apify coverage.
9+
- REST, MCP, SDK, CLI, Terraform, n8n, Prefect, and Apify coverage.
1010
- No webhook, monitor, or OAuth CIMD pages. Those APIs are not in the current OpenAPI.

context7.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"projectTitle": "TwexAPI docs",
3-
"description": "TwexAPI documentation for REST API, MCP, SDKs, CLI, Terraform, n8n, and X/Twitter public reads plus approved writes. Not affiliated with X Corp.",
3+
"description": "TwexAPI documentation for REST API, MCP, SDKs, CLI, Terraform, n8n, Prefect, and X/Twitter public reads plus approved writes. Not affiliated with X Corp.",
44
"branch": "main",
55
"rules": [
66
"Not affiliated with X Corp.",

docs.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://mintlify.com/docs.json",
33
"theme": "maple",
44
"name": "TwexAPI",
5-
"description": "TwexAPI docs for tweet search, follower scraping, timelines, DMs, SDKs, MCP, CLI, Terraform, and n8n. Not affiliated with X Corp.",
5+
"description": "TwexAPI docs for tweet search, follower scraping, timelines, DMs, SDKs, MCP, CLI, Terraform, n8n, and Prefect. Not affiliated with X Corp.",
66
"search": {
77
"prompt": "Search docs"
88
},
@@ -88,7 +88,8 @@
8888
"sdks/php",
8989
"sdks/cli",
9090
"sdks/terraform",
91-
"sdks/n8n"
91+
"sdks/n8n",
92+
"sdks/prefect"
9293
]
9394
},
9495
{

index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "TwexAPI X (Twitter) Scraper API"
33
sidebarTitle: Home
4-
description: "Search tweets, read profiles, paginate followers, and run approved X actions through TwexAPI REST, SDKs, MCP, CLI, Terraform, n8n, or Apify. Not affiliated with X Corp."
4+
description: "Search tweets, read profiles, paginate followers, and run approved X actions through TwexAPI REST, SDKs, MCP, CLI, Terraform, n8n, Prefect, or Apify. Not affiliated with X Corp."
55
---
66

77
TwexAPI is an X (Twitter) Scraper API and X API alternative. Search tweets, read profiles, paginate followers, and run approved account actions.
@@ -38,7 +38,7 @@ Pass `next_cursor` from the previous page unchanged to fetch the next page.
3838
Hosted MCP at `https://api.twexapi.io/mcp` with `explore` and `twexapi_request`.
3939
</Card>
4040
<Card title="SDKs" icon="package" href="/sdks">
41-
TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, Terraform, and n8n.
41+
TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, Terraform, n8n, and Prefect.
4242
</Card>
4343
</CardGroup>
4444

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "x-api-scraper-docs",
33
"private": true,
4-
"description": "TwexAPI documentation source for REST, MCP, SDKs, CLI, Terraform, and n8n. Not affiliated with X Corp.",
4+
"description": "TwexAPI documentation source for REST, MCP, SDKs, CLI, Terraform, n8n, and Prefect. Not affiliated with X Corp.",
55
"scripts": {
66
"dev": "npx mintlify@latest dev",
77
"generate:api": "python3 scripts/generate-api-pages.py"

sdks.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "TwexAPI SDKs and clients"
33
sidebarTitle: SDKs
4-
description: "Install TwexAPI TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, Terraform, and n8n clients. Not affiliated with X Corp."
4+
description: "Install TwexAPI TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, Terraform, n8n, and Prefect clients. Not affiliated with X Corp."
55
---
66

77
Official clients wrap the same REST contract. Public reads use `X_API_SCRAPER_KEY`. Writes still need a cookie or `auth_token`.
@@ -40,6 +40,9 @@ Official clients wrap the same REST contract. Public reads use `X_API_SCRAPER_KE
4040
<Card title="n8n" href="/sdks/n8n" icon="workflow">
4141
Community node `n8n-nodes-x-api-scraper`
4242
</Card>
43+
<Card title="Prefect" href="/sdks/prefect" icon="calendar">
44+
Collection `prefect-x-api-scraper`
45+
</Card>
4346
<Card title="Apify" href="/guides/apify" icon="database">
4447
Pay-per-result tweet Actor, no TwexAPI key
4548
</Card>

sdks/prefect.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Prefect collection"
3+
description: "Install prefect-x-api-scraper for scheduled tweet search, user lookup, timelines, and trending tweets."
4+
---
5+
6+
Install `prefect-x-api-scraper` and store the API key in a Prefect block. Tasks send `Authorization: Bearer`.
7+
8+
```bash
9+
pip install prefect-x-api-scraper
10+
prefect block register -m prefect_x_api_scraper
11+
```
12+
13+
| Workflow step | Prefect task | TwexAPI route |
14+
| --- | --- | --- |
15+
| Search tweets | `search_tweets` | `POST /twitter/advanced_search/page` |
16+
| Read tweet detail | `get_tweet` | `POST /v2/tweet/detail` |
17+
| Search users | `search_users` | `GET /twitter/search-user/{keyword}/{target_count}` |
18+
| Read a profile | `get_user` | `GET /twitter/{screen_name}/about` |
19+
| Read a timeline page | `get_user_tweets` | `POST /twitter/{screen_name}/timeline/page` |
20+
| Read trending tweets | `get_trends` | `GET /twitter/global-trending/tweets` |
21+
22+
The collection is read-only. Use REST or an SDK for follower pagination and approved posting.
23+
24+
Source: [prefect-x-api-scraper](https://github.com/twexapi-dev/prefect-x-api-scraper)

twitter-api-alternatives.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ TwexAPI is an independent third-party X data API. It is not the official X API.
88

99
| Option | Strong fit | Main tradeoff |
1010
| --- | --- | --- |
11-
| TwexAPI | Filtered X data, agents, SDKs, CLI, n8n, and X actions | Uses TwexAPI credits and documented limits |
11+
| TwexAPI | Filtered X data, agents, SDKs, CLI, n8n, Prefect, and X actions | Uses TwexAPI credits and documented limits |
1212
| Official X API | Official platform contract and first-party support | Requires an official developer account |
1313
| Apify Actor | Console runs, schedules, and datasets | Actor and platform charges can both apply |
1414
| General scraper | Flexible HTML or browser retrieval | You own parsing, pagination, and schema drift |

0 commit comments

Comments
 (0)