Xquik docs for X API, 1-second monitors & automation

August 27, 2026 ยท View on GitHub

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.

Choose this repository

Use the hosted site for current guidance. Review this repository when proposing fixes or validating contracts. Generated client APIs live in the SDK repositories.

Start here

Use with AI coding agents

  • 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.
  • Codex OAuth troubleshooting. Codex CLI 0.147.0 and newer support Xquik OAuth. Upgrade if an older release reports Authorization server response missing required issuer: expected https://xquik.com. Use bearer_token_env_var = "XQUIK_API_KEY" only when upgrading is unavailable. Issue #31573 records the fix.
  • 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.

Common questions

Customer questionDocumentation
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.

What's covered

  • REST API. 129 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 docs plus 118 OpenAPI-native tools. Guest keys receive 33 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.

Repository layout

api-reference/      129 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 source of truth

Local development

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.

Deployment

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.

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.

License

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.