Xquik Docs - X API, Real-Time X Data & Automation Reference

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

Public documentation for Xquik, the X (Twitter) real-time data and automation platform. Built on Mintlify, deployed 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.

Start here

  • 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 real-time X events.
  • Apify Actors - run X tweet and follower export jobs on Apify.
  • llms.txt - give AI coding agents the docs index.

Use With AI Coding Agents

  • 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.

Common jobs

  • Search tweets with from:, since:, until:, filters, and cursor pagination.
  • Fetch tweet threads, read quotes, and inspect replies.
  • Look up users, export followers, list following, and check relationships.
  • Upload media, create tweets, send DMs with returned message IDs, and update profiles.
  • Track new tweets with 1-second monitors and signed webhook delivery.
  • Export results as JSON, CSV, XLSX, or Markdown.
  • Run X Tweet Scraper and X Follower Scraper Actors for Apify dataset workflows.
  • Compare Xquik with X API, social schedulers, data tools, and automation platforms.

What's covered

  • 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 - 118 full-scope operations or 33 guest paid_reads GET routes through 2 code-mode tools.
  • 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 spec at openapi.yaml, used by Mintlify for endpoint pages and by Stainless for SDK generation.

Repository layout

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

Local development

Prerequisites: Node.js 20+ and the Mintlify CLI.

npm install -g mint
mint dev          # local preview at http://localhost:3000
mint broken-links # check for broken internal links
mint validate     # validate the documentation build
mint a11y         # check accessibility issues
mint openapi-check openapi.yaml  # validate the OpenAPI spec

Edit any .mdx file and the preview reloads automatically.

Deployment

main auto-deploys to docs.xquik.com via Mintlify. Deployment status is visible in commit check runs. GitHub Actions also runs the Agent-Friendly Docs test suite and refreshes the Context7 library after docs changes. Run broken-link, OpenAPI, and agent-docs checks locally before pushing.

Contributing

See CONTRIBUTING.md for style rules, content conventions, and the workflow for opening a PR.

Security

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.

Related repositories

License

The docs source is published under the MIT License. See LICENSE if present, or treat the repository contents as MIT-licensed for the purpose of citing or quoting documentation in third-party material. The Xquik product, brand, and platform are not covered by this license.