Skip to content

Commit e022a71

Browse files
lanbytescursoragent
lanbytes
and
cursoragent
committed
Add a Mintlify docs site for the TwexAPI REST contract.
Co-authored-by: Cursor <cursoragent@cursor.com>
0 parents  commit e022a71

114 files changed

Lines changed: 12261 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/ci.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
pages:
14+
runs-on: ubuntu-24.04
15+
timeout-minutes: 10
16+
steps:
17+
- uses: actions/checkout@v4
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: "3.12"
21+
- name: Regenerate API pages
22+
run: python3 scripts/generate-api-pages.py
23+
- name: Fail if generated pages drifted
24+
run: git diff --exit-code -- api-reference scripts/api-navigation.json docs.json
25+
- name: Check required files
26+
run: test -f docs.json && test -f openapi.json && test -f index.mdx

‎.gitignore‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Secrets
2+
.env
3+
.env.*
4+
!.env.example
5+
6+
# Dependencies and build
7+
node_modules/
8+
.mintlify/
9+
dist/
10+
*.tgz
11+
12+
# OS and editor
13+
.DS_Store
14+
.idea/
15+
.vscode/

‎.mintignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
README.md
2+
LICENSE
3+
CODE_OF_CONDUCT.md
4+
CONTRIBUTING.md
5+
SECURITY.md

‎AGENTS.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Agent notes
2+
3+
- Source of truth for routes is `openapi.json` (copied from the TypeScript SDK OpenAPI).
4+
- Do not add endpoints that are not in that file.
5+
- Public reads: Bearer API key. Writes/DMs: cookie or `auth_token` plus confirmation.
6+
- MCP: `https://api.twexapi.io/mcp`, tools `explore` and `twexapi_request`.

‎CODE_OF_CONDUCT.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Code of Conduct
2+
3+
Be respectful. Do not harass maintainers, contributors, or users.
4+
5+
Unacceptable behavior includes harassment, hate speech, and posting secrets or personal data.
6+
7+
Report issues on GitHub. Maintainers may remove comments, close issues, or block accounts that violate this policy.
8+
9+
This project is not affiliated with X Corp.

‎CONTRIBUTING.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Contributing
2+
3+
This repository is the TwexAPI documentation source.
4+
5+
- Open an issue for bugs or missing docs.
6+
- Keep PRs small. Do not add endpoints that are not in `openapi.json`.
7+
- Do not invent webhooks, monitors, OAuth, or guest wallets.
8+
- Do not commit API keys, cookies, or `.env` files.
9+
- After OpenAPI updates, run `python3 scripts/generate-api-pages.py`.
10+
11+
Questions: open a GitHub issue or use the [TwexAPI dashboard](https://twexapi.io/dashboard).

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 TwexAPI
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# TwexAPI docs
2+
3+
> TwexAPI is an independent third-party service. Not affiliated with X Corp.
4+
> "Twitter" and "X" are trademarks of X Corp.
5+
6+
Documentation for [TwexAPI](https://twexapi.io), an X (Twitter) Scraper API and X API alternative. Intended for **[docs.twexapi.io](https://docs.twexapi.io)**.
7+
8+
This repository covers REST, MCP, SDKs, CLI, Terraform, n8n, and Apify. The OpenAPI contract currently documents **66** operations.
9+
10+
## Start here
11+
12+
- [Quickstart](https://docs.twexapi.io/x-api-quickstart)
13+
- [API overview](https://docs.twexapi.io/api-reference/overview)
14+
- [Authentication](https://docs.twexapi.io/api-reference/authentication)
15+
- [MCP](https://docs.twexapi.io/mcp/overview)
16+
- [SDKs](https://docs.twexapi.io/sdks)
17+
- [OpenAPI](https://github.com/twexapi-dev/x-api-scraper-docs/blob/main/openapi.json)
18+
19+
## Local preview
20+
21+
```bash
22+
npx mintlify@latest dev
23+
```
24+
25+
Regenerate API pages after updating `openapi.json`:
26+
27+
```bash
28+
python3 scripts/generate-api-pages.py
29+
```
30+
31+
## Related repositories
32+
33+
- [Skill and MCP catalog](https://github.com/twexapi-dev/x-api-scraper)
34+
- [TypeScript SDK](https://github.com/twexapi-dev/x-api-scraper-typescript)
35+
- [n8n node](https://github.com/twexapi-dev/n8n-nodes-x-api-scraper)
36+
37+
## License
38+
39+
MIT. The license does not cover the TwexAPI product, brand, or platform.

‎SECURITY.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security
2+
3+
Do not file public issues that include API keys, cookies, `auth_token` values, or personal data.
4+
5+
Report suspected vulnerabilities privately through GitHub Security Advisories on this repository.

‎alternatives/x-api.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "TwexAPI vs the official X API"
3+
sidebarTitle: X API
4+
description: "TwexAPI is a third-party X data API. Public reads need a TwexAPI key, not an official X developer account."
5+
---
6+
7+
Use TwexAPI when you need structured public X data through one API key, plus optional approved writes.
8+
9+
You do **not** need an official X developer account for supported public reads.
10+
11+
Use the official X API when you need the first-party contract, official support, or a platform relationship that only X provides.
12+
13+
TwexAPI is not affiliated with X Corp. Keys, credits, and rate limits are TwexAPI's. They are not X developer portal products.

0 commit comments

Comments
 (0)