Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xquik.com/llms.txt

Use this file to discover all available pages before exploring further.

Use these X API workflows to wire Xquik into monitoring dashboards, webhook pipelines, AI agents, data exports, and content tools. Choose the handoff here, then open the focused workflow or API page for copy-ready examples.

Monitor & poll

Batch processing, dashboards, and low-frequency checks. Interval-based, low setup effort.

Real-time webhooks

Alerts, queues, customer support triage, and warehouse sync. Real-time, medium setup effort.

AI agent (MCP)

Tweet search, user lookups, follower checks, and research summaries. Real-time, low setup effort.

Publish tweet or reply

Post tweets, post tweet replies, and hand off public media URLs. Low setup effort.

Tweet composition

Draft generation and reply monitoring. Low setup effort.

​
Choose a Workflow

Track competitor or brand posts

Use monitor polling or webhooks. Returned data: tweets, replies, quotes, and retweets.

Send real-time alerts

Use real-time webhooks. Returned data: signed event payloads for Slack, queues, or support tools.

Build an AI research assistant

Use the MCP path. Returned data: tweet search results, user profiles, and monitor events.

Export followers or audiences

Use extraction workflows. Returned data: CSV, JSON, XLSX, or paginated JSON.

Sync followers to CRM

Use the follower export CRM workflow. Returned data: CSV, XLSX, JSON, and a CRM field map.

Post a tweet or reply

Use the create tweet workflow. Returned data: published tweetId and success.

Score and refine a draft tweet

Use tweet composition. Returned data: algorithm guidance, refined text, and score.

Audit giveaway activity

Use draws. Returned data: eligible participants, winners, and archived tweet metrics.

​
Integration Handoff Matrix

Use this matrix before choosing code, webhooks, MCP, or exports. Each row maps the setup work, first API call, returned data, handoff format, and billing check.
Setup: API key, monitor target, and event types. First call: POST /monitors, then GET /events. Returned data: tweet, reply, quote, and retweet events. Handoff: polling cursor or signed webhook payload. Cost check: active instant monitors bill 21 credits per hour while enabled.
Setup: webhook URL and subscribed event types. First call: POST /webhooks, then POST /webhooks/{id}/test. Returned data: delivery status and signed event body. Handoff: queue, Slack, CRM, or warehouse endpoint. Cost check: webhook management and deliveries are included with active monitor billing.
Setup: MCP client with API key or OAuth. First call: xquik.request('/api/v1/x/tweets/search'). Returned data: tweet search, user profiles, and monitor events. Handoff: MCP tool result with normalized pagination. Cost check: X data calls use endpoint credit costs.
Setup: target username and optional resultsLimit. First call: POST /extractions/estimate, then POST /extractions. Returned data: job status, rows, and export links. Handoff: CSV, JSON, XLSX, or paginated JSON. Cost check: estimate before creating the job.
Setup: tweet ID and optional resultsLimit. First call: POST /extractions/estimate with reply_extractor. Returned data: reply author fields, reply tweet fields, engagement counts, and metadata. Handoff: CSV, JSON, XLSX, JSONL, or moderation queue rows. Cost check: 1 credit per reply returned or extracted.
Setup: connected X account plus text, media URLs, or parent tweet ID. First call: POST /x/tweets. Returned data: tweetId and success. Handoff: published tweet ID for queue, CRM, CMS, or agent state. Cost check: 10 credits per write.
Setup: topic, goal, tone, and optional style username. First call: POST /compose with step. Returned data: algorithm guidance, refined draft, and score checklist. Handoff: draft text or X compose URL. Cost check: Compose, refine, and score are free.

​
High-Value Workflows First

Start here when you need to decide which Xquik tools to build around first. These jobs create the most reusable handoffs: rows for analysts, IDs for systems of record, events for queues, and published action IDs for audit trails.

1. Scrape tweets to CSV, JSON, or XLSX

Turns search intent into rows for research, lead lists, support triage, and AI retrieval. First endpoint: POST /extractions/estimate with tweet_search_extractor. Handoff: export file, paginated JSON, or direct GET /x/tweets/search page. Cost model: 1 credit per tweet returned or extracted.

2. Scrape tweet replies to CSV, JSON, or XLSX

Turns a post’s conversation into moderation, support, giveaway, research, or AI review rows. First endpoint: POST /extractions/estimate with reply_extractor and targetTweetId. Handoff: export file, paginated JSON, JSONL rows, or direct GET /x/tweets/{id}/replies page. Cost model: 1 credit per reply returned or extracted.

3. Export followers to CRM or warehouse

Builds owned audience tables with stable X user IDs for import and upsert. First endpoint: POST /extractions/estimate with follower_explorer. Handoff: CSV, JSON, XLSX, or CRM field map keyed by x_user_id. Cost model: 1 credit per follower returned.

4. Monitor tweets to signed webhooks

Delivers new posts, replies, quotes, and retweets to queues without polling. First endpoint: POST /monitors, then POST /webhooks. Handoff: signed payload with deliveryId, streamEventId, eventType, and tweet data. Cost model: 21 credits per active monitor-hour; webhook delivery is included.

5. Post media tweets or replies

Publishes media-backed tweets or replies from public image URLs or 1 public MP4 video URL up to 100 MB without a separate upload step. First endpoint: POST /x/tweets with media. Handoff: tweetId, success, original media URLs, and optional reply_to_tweet_id. Cost model: 10 credits per post tweet call.

6. Send direct messages with returned IDs

Lets support, sales, and agent systems read a conversation and store the outbound message ID. First endpoint: GET /x/users/{id} if needed; use GET /x/dm/{userId}/history?account=..., then POST /x/dm/{userId}. Handoff: account, messages, has_next_page, next_cursor, messageId, and success. Cost model: 1 credit per user lookup or history message; 10 credits per DM send.

​
1. Scrape tweets to CSV, JSON, or XLSX

Use this when a user asks to scrape tweets, search tweets, build a tweet scraper, export hashtag results, or hand matching posts to an analyst. Estimate first, create the extraction job, poll it, then export the file format your downstream system expects. For reply-specific exports, use the next workflow. 
curl -X POST https://xquik.com/api/v1/extractions/estimate \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "toolType": "tweet_search_extractor",
    "searchQuery": "from:xquikcom webhook OR SDK",
    "language": "en",
    "resultsLimit": 500
  }' | jq
The extraction returns a job ID. GET /extractions/{id} returns job, results, hasMore, and nextCursor; GET /extractions/{id}/export?format=csv downloads the rows. For live pagination without a stored job, call GET /x/tweets/search with q and optional cursor; use limit only for bounded pulls. It returns tweets, has_next_page, and next_cursor.

​
2. Scrape tweet replies to CSV, JSON, or XLSX

Use this when a moderation, support, giveaway, research, or AI review system needs every reply under a specific post as rows. Estimate first with reply_extractor and targetTweetId, create the extraction job with the same fields, poll it, then export format=csv, format=json, or format=xlsx. 
curl -X POST https://xquik.com/api/v1/extractions/estimate \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "toolType": "reply_extractor",
    "targetTweetId": "1893704267862470862",
    "resultsLimit": 500
  }' | jq
GET /extractions/{id} returns reply rows, hasMore, and nextCursor; pass nextCursor as after for more stored results. For live pagination without a stored job, call GET /x/tweets/{id}/replies, pass next_cursor back as cursor, and store tweets, has_next_page, and next_cursor.

​
3. Export followers to CRM or warehouse

Use this when the real job is follower export, audience ownership, CRM import, or warehouse sync. Keep resultsLimit on both estimate and create calls so the first run has a predictable credit cap. 
curl -X POST https://xquik.com/api/v1/extractions \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "toolType": "follower_explorer",
    "targetUsername": "xquikcom",
    "resultsLimit": 10000
  }' | jq
After status becomes completed, export format=csv for CRM import, format=xlsx for analyst review, or format=json for a pipeline. Map stable User ID values to a CRM field such as x_user_id; do not key imports by display name.

​
4. Monitor tweets to signed webhooks

Use this when a workflow needs tweet alerts, support routing, warehouse ingest, or queue fanout within seconds. Create the monitor, register the webhook URL, test delivery, then process signed events asynchronously. 
curl -X POST https://xquik.com/api/v1/monitors \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "xquikcom",
    "eventTypes": ["tweet.new", "tweet.reply", "tweet.quote"]
  }' | jq
Webhook payloads include durable IDs for downstream systems: persist deliveryId for delivery-level idempotency and streamEventId when the same monitor event must be processed once across retries or endpoints. Store the one-time secret returned by POST /webhooks and verify X-Xquik-Signature against the raw body before accepting the event. Return 2xx before slow CRM, Slack, warehouse, or queue work starts.

​
5. Post media tweets or replies

Use this when an agent or app has public image URLs or exactly 1 public MP4 video URL up to 100 MB and needs to post a tweet or reply. Pass those URLs directly in the media array on POST /x/tweets. Do not call POST /x/media first for tweet posts when the media is already public; POST /x/tweets rejects media_ids with 400 unsupported_field. 
curl -X POST https://xquik.com/api/v1/x/tweets \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "account": "brand_account",
    "text": "Product screenshot from today",
    "reply_to_tweet_id": "1893456789012345678",
    "media": ["https://example.com/product-screenshot.png"]
  }' | jq
The response returns tweetId and success, or 202 x_write_unconfirmed with writeActionId if final confirmation is still pending. Store the original media URLs next to tweetId, reply_to_tweet_id, or writeActionId. Use POST /x/media only when you need a one-item media_ids array for POST /x/dm/{userId}.

​
6. Send direct messages with returned IDs

Use this when a support, sales, or agent workflow needs direct messages with audit trails. Look up the recipient user ID, pass the same connected sender as account for history reads and DM writes, then store returned message IDs. 
curl -G https://xquik.com/api/v1/x/dm/987654321/history \
  --data-urlencode "account=brand_account" \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq
History reads require account, and that connected account must participate in the conversation. Missing account returns 400 account_required; a non-participant account returns 403 dm_not_permitted. 
curl -X POST https://xquik.com/api/v1/x/dm/987654321 \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "account": "brand_account",
    "text": "Thanks for reaching out. Here is the next step."
  }' | jq
GET /x/dm/{userId}/history returns messages, has_next_page, and next_cursor; pass next_cursor back as cursor for older messages. POST /x/dm/{userId} returns messageId and success, which you should store on the support ticket, CRM note, or agent state.

​
Focused Workflow Pages

Use the overview to choose the path, then move to the focused page for copy-ready examples, SDK handoff, and endpoint-specific error recovery.

Tweet search exports

Build CSV, JSON, or XLSX exports from tweet_search_extractor, or use direct GET /x/tweets/search pagination.

Tweet replies exports

Turn a post conversation into reply_extractor jobs, direct replies pagination, JSONL rows, or moderation queues.

Follower CRM export

Estimate follower_explorer, export CSV/JSON/XLSX files, and map stable x_user_id fields.

Monitor webhooks

Test signed deliveries, verify X-Xquik-Signature, store deliveryId, and return 2xx before slow work.

Media tweets and DMs

Use public URLs in tweet media; upload only when DMs need one media_ids item.

Direct messages

Read DM history with account, send DMs, and store returned messageId values.

MCP agents

Connect agents, call xquik.request(...), and hand normalized pagination back to memory.

Tweet composition

Use POST /compose for compose, refine, and score loops without usage credits.

​
Public draw results

Completed giveaway draws have a public results page at https://xquik.com/results/{drawId}. No authentication required. Share the URL with participants for transparency.

Create a Monitor

Start monitoring a user for real-time events.

Register a Webhook

Receive events on your server in real time.

MCP Server

Connection details and setup instructions.

Signature Verification

Verify webhook payloads with HMAC-SHA256.
Last modified on May 16, 2026