Xquik Docs

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: REST API, webhooks, MCP server, OAuth 2.1, SDKs, and how-to guides. Marketing content (blog, comparisons, glossary) lives on the main app at xquik.com.

What's covered

• REST API - 111 endpoint pages spanning account, api-keys, monitors, events, webhooks, draws, extractions, x, trends, radar, styles, drafts, compose, x-accounts, x-write, support, and integrations.
• Webhooks - HMAC SHA-256 signature verification, retry semantics, payload schemas.
• MCP server - Model Context Protocol integration for Claude, ChatGPT, Cursor, and other AI agents. Tool reference + setup.
• OAuth 2.1 - Authorization Code + PKCE flow, scopes, token refresh.
• Guides - Workflows, error handling, rate limits, billing, trends, extraction workflow, architecture, troubleshooting, types, webhook testing.
• 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.
• 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/      111 endpoint pages, grouped by resource
guides/             11 guides (workflows, errors, rate limits, billing, etc.)
webhooks/           Overview + signature verification
mcp/                MCP server overview + tool reference
oauth/              OAuth 2.1 setup + flow
sdks/               Per-language SDK landing pages
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 mintlify
mintlify dev          # local preview at http://localhost:3000
mintlify broken-links # check for broken internal links
mintlify 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. There is no separate build or test pipeline; broken-link and OpenAPI checks should be run 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

• Xquik-dev/xquik - Main app (closed-source).
• 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.

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.