Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.

Public documentation for Xquik, an X data and automation platform. Published at docs.xquik.com.

This repository powers the developer reference for the Xquik REST API, webhooks, MCP server, OAuth 2.1, SDKs, glossary, comparison guides, and how-to guides. Use it to 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 tasks.

Use hosted docs for current task guidance. Use this repository to review source, propose fixes, or validate public contracts. Use SDK repositories for generated client APIs.

• Quickstart - make the first authenticated API call.
• API Reference - browse 127 OpenAPI-backed operations.
• Guest wallets - fund 33 accountless GET routes through a confirmed Stripe Payment Link.
• Direct MPP - pay per request on 7 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.
• MCP Server - connect AI clients through their current OAuth or secure API-key path.
• Webhooks - verify HMAC signatures and receive monitor events.
• Open Source Assurance - review OpenSSF project mapping and public controls.
• Apify Actors - run X tweet and follower export jobs on Apify.
• llms.txt - give AI coding agents the docs index.

• Context7 library - load indexed Xquik docs in supported coding agents.
• llms.txt - discover every public docs page before reading deeper.
• MCP Server - connect Xquik tools through OAuth-first Streamable HTTP.
• Codex OAuth troubleshooting - if Codex reports Authorization server response missing required issuer: expected https://xquik.com, use bearer_token_env_var = "XQUIK_API_KEY" until the upstream Codex issue identifies a fixed release. Xquik already returns the required RFC 9207 iss value.
• Agent index - discover the API MCP endpoint, manifest, OAuth metadata, and auth.md.
• Agent Skills index - discover and verify Xquik's hosted SKILL.md.
• auth.md - read CIMD, DCR, PKCE, and MCP authorization instructions.
• OpenAPI spec - generate clients or inspect request and response shapes.

Search tweets with from:, since:, until:, filters, and cursor pagination.

• REST API - 127 operations spanning 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, payload schemas.
• MCP server - 119 full-scope catalog routes or 33 guest paid_reads GET routes through 2 code-mode tools. Binary support downloads use REST.
• OAuth 2.1 - Automatic discovery, CIMD, DCR fallback, Authorization Code + PKCE, and token refresh.
• Guides - Workflows, error handling, rate limits, billing, trends, extraction workflow, architecture, troubleshooting, types, webhook testing, and framework integrations.
• SDKs - 10 generated client libraries (TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI as Go binary, Terraform provider) with auto-pagination, retry, and typed responses.
• Comparisons - Factual alternatives and migration guides for X API, creator tools, social suites, data tools, and workflow platforms.
• Apify Actors - Public Apify Actors for tweet and follower dataset workflows before moving deeper workflows to REST, webhooks, SDKs, or MCP.
• OpenAPI 3.1 - Machine-readable contract for endpoint pages and SDK generation.

api-reference/      127 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
introduction.mdx    Platform overview
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 source of truth

Install Node.js 22, Bun 1.3.14, and REUSE 6.2.0.

npm ci --ignore-scripts
npm run check:dependencies
npm run test:agent-docs
npm run docs:validate
npm run docs:links
npm audit --audit-level=low
reuse lint

Run npm exec -- mint dev when visual previewing is necessary.

main auto-deploys to docs.xquik.com.

Deployment status appears in commit check runs.

GitHub Actions runs documentation, contract, security, and licensing checks.

Run every static check before pushing.

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.