Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.
Documentation for Xquik, an X data and automation platform. Published at docs.xquik.com.
This repository contains the Xquik REST API, webhook, MCP, OAuth 2.1, and SDK docs. Find request and response details for tweet search, user lookup, follower exports, media uploads, direct messages, 1-second tweet monitors, signed webhooks, SDK clients, and X automation.
Use the hosted site for current guidance. Review this repository when proposing fixes or validating contracts. Generated client APIs live in the SDK repositories.
- Quickstart. Make the first authenticated API call.
- API reference. Browse every OpenAPI-backed operation.
- Guest wallets. Fund accountless paid-read routes through a confirmed hosted checkout.
- Direct MPP. Pay per request on fixed-price GET operations.
- SDKs. Use TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, and Terraform clients.
- Tweet search export. Export tweets by keyword to CSV, JSON, or XLSX.
- Tweet replies export. Export replies to CSV, JSON, or XLSX.
- Follower export. Export X followers to CRM or warehouse.
- Direct message workflow. Send DMs and store returned message IDs.
- Prefect. Schedule tweet, user, timeline, and trend reads in Prefect flows.
- Webhooks. Verify HMAC signatures and receive monitor events.
- Open source assurance. Review OpenSSF project mapping and controls.
- Apify Actors. Run focused X data jobs on Apify.
- Context7 library. Load indexed Xquik docs in supported coding agents.
- llms.txt. Discover every docs page before reading deeper.
- MCP server. Connect through Code Mode or OpenAPI-native tools.
- MCP 2026-07-28. Understand
server/discover, request-scoped calls, and private cache hints. - Coding-agent setup. Connect current Claude Code, Cursor, OpenCode, Pi, Codex & other MCP clients.
- Agent catalog. Discover the MCP server, A2A agent, API contract, OAuth metadata, and auth.md.
- Agent Skills index. Discover and verify Xquik's hosted
SKILL.md. - auth.md. Read interactive and claimed agent authorization instructions.
- OpenAPI spec. Generate clients or inspect request and response shapes.
| Customer question | Documentation |
|---|---|
| How do I search tweets through an API? | Search Tweets API |
| How do I export tweet search results? | Tweet Search Export |
| How do I read an account timeline? | User Tweets API |
| How do I export followers? | Follower Export Guide |
| How do I scrape following accounts? | Following API |
| How do I read my home timeline? | Home Timeline API |
| How do I monitor accounts or keywords? | Brand Monitoring Guide |
| How do I verify signed webhooks? | Webhook Guide |
| How do I post or reply? | Create Tweet API |
| How do I send DMs with returned message IDs? | Direct Message Workflow |
| How do I run Apify dataset workflows? | Xquik on Apify |
| How does Xquik compare with the X API? | X API Alternative Guide |
| How can an AI agent use Xquik? | MCP Server Guide |
Search tweets with from:, since:, until:, filters, and cursor pagination.
- REST API. Operations span account, guest wallets, API keys, monitors, events, webhooks, draws, extractions, X data, trends, radar, styles, drafts, compose, X accounts, writes, support, and integrations.
- Webhooks. HMAC SHA-256 signature verification, retry semantics, and payload schemas.
- MCP server. Use 3 Code Mode tools or
docsplus OpenAPI-native tools, 1 for each eligible operation. Guest keys receive the eligible read operations. Binary downloads use REST. - OAuth 2.1. Automatic discovery, PKCE, client registration, claimed service identities, and token refresh.
- Guides. Workflows, error handling, rate limits, billing, trends, extractions, architecture, troubleshooting, types, webhook testing, and framework integrations.
- SDKs. 10 generated clients support TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, and Terraform.
- Comparisons. Alternatives for X APIs, tweet scrapers, follower exporters, creator tools, and social suites.
- Apify Actors. Actors cover tweets, replies, followers, trends, profiles, communities, lists, and user search.
- OpenAPI 3.1. Machine-readable contract for endpoint pages and SDK generation.
api-reference/ OpenAPI operations, grouped by resource
guides/ Workflow, operations, and framework guides
webhooks/ Overview + signature verification
mcp/ MCP server overview + tool reference
oauth/ OAuth 2.1 setup + flow
sdks/ Per-language SDK landing pages
alternatives/ Comparison and migration guides
x-api-quickstart.mdx 2-minute quickstart
docs.json Navigation + theme config
custom.css Custom styling
llms.txt AI-readable site index
openapi.yaml OpenAPI 3.1 spec, copied from the application
Install Bun, rustup, OSV-Scanner, Gitleaks & ShellCheck. Use the pinned npm version in package.json.
bunx --bun npm@12.0.1 ci --ignore-scripts
bun run check:allopenapi.yaml is an exact copy of the application's spec. Never edit it here.
Clone the application beside this repository, or set XQUIK_PRODUCT_ROOT to it.
bun run sync then copies the spec & rewrites each page's response examples.
The parity test needs that checkout too. Without it, the test skips & says so.
Run bunx --bun mint@4.2.949 dev when visual previewing is necessary.
main auto-deploys to docs.xquik.com.
Deployment status appears in commit check runs.
This repository runs no GitHub Actions. Run every required check locally before pushing. Verify the published pages after deployment.
See CONTRIBUTING.md for style rules, content conventions, and the workflow for opening a PR.
To report a vulnerability in the docs site or in any documented endpoint behaviour, see SECURITY.md. Do not file public issues for security findings.
- Xquik. Main app and dashboard.
- Xquik-dev/x-twitter-scraper-python. Python SDK.
- Xquik-dev/x-twitter-scraper-typescript. TypeScript SDK.
- Other generated SDKs are listed under the Xquik-dev org.
The documentation source uses the MIT License.
The license does not cover the Xquik product, brand, or platform.
Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.