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.

Choose the output shape before wiring a worker, dashboard, spreadsheet, or archive. Xquik gives you live JSON pages for endpoint calls, saved JSON pages for extraction jobs, file exports for downstream tools, and draw exports for giveaway audits.

​
Choose the Output Shape

Live JSON Page

Use endpoints such as GET /api/v1/x/tweets/search, GET /api/v1/x/users/{id}/tweets, and GET /api/v1/x/users/{id}/followers when your app needs fresh API results and endpoint-specific cursors.

Saved JSON Rows

Use GET /api/v1/extractions/{id}?limit=1000&after={nextCursor} when a saved extraction job is the source of truth. The response includes job, results, hasMore, and optional nextCursor.

File Export

Use GET /api/v1/extractions/{id}/export?format=csv when a downstream tool needs a downloaded file. Supported formats are csv, json, xlsx, md, md-document, pdf, and txt.

Draw Export

Use GET /api/v1/draws/{id}/export?format=csv&type=winners when you need giveaway winners or entry rows. Set type to winners or entries.

​
Output Decision Map

App UI

Call the live JSON endpoint and store the endpoint cursor with the filters that produced the page.

Worker or Queue

Read saved extraction pages, append JSON Lines, and resume with after when hasMore is true.

CRM or Spreadsheet

Download CSV for simple imports, or XLSX when analysts need a workbook.

Archive or Report

Download JSON for replay, Markdown or TXT for text archives, and PDF for a shareable report file.

​
Pagination and Cursor Map

Direct X API pages expose endpoint-specific cursor fields such as has_next_page and next_cursor. Keep the same query filters between requests and only change the cursor parameter documented on that endpoint. Extraction result pages use hasMore and nextCursor. Pass nextCursor back as after, and use limit up to 1000; the default is 100. File exports do not paginate. File exports are capped at 100,000 rows, and PDF exports are capped at 10,000 rows. Use extraction JSON pages or JSON Lines when you need to process larger jobs incrementally.

​
Format Map

CSV

Best for spreadsheet imports and CRM uploads. The response content type is text/csv; charset=utf-8.

JSON File

Best for replay, durable archives, and backend handoffs. The response content type is application/json; charset=utf-8.

XLSX

Best for analysts who need a workbook. The response content type is application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

Markdown

Best for docs and text review. md and md-document return text/markdown; charset=utf-8.

PDF

Best for a shareable report snapshot. The response content type is application/pdf.

TXT

Best for plain text archives. The response content type is text/plain; charset=utf-8.

​
Handoff Checkpoint

Store enough context to resume a job, verify filters, and download the right format later. 
{
  "source": "xquik.response_formats",
  "extraction_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "detail_path": "/api/v1/extractions/a1b2c3d4-e5f6-7890-abcd-ef1234567890?limit=1000",
  "export_paths": {
    "csv": "/api/v1/extractions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/export?format=csv",
    "json": "/api/v1/extractions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/export?format=json",
    "xlsx": "/api/v1/extractions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/export?format=xlsx"
  },
  "pagination": {
    "limit": 1000,
    "after": "990200",
    "hasMore": true
  },
  "draw_export_path": "/api/v1/draws/f4bd00a2-7b4e-4e59-8e1b-72e2c9f12345/export?format=csv&type=winners",
  "next_action": "poll_until_completed_then_download"
}

​
Safety Checklist

Do not print downloaded export bytes to shared logs.
Store the Content-Disposition filename if your workflow needs stable file names.
Validate format before making the request. Invalid formats return a 400 error.
Store the job ID, tool type, filters, cursor, and chosen export path with the downstream task.

​
Next Steps

Extraction Workflow

Build saved extraction jobs, poll results, and export finished rows.

Export Extraction

Download saved extraction rows as CSV, JSON, XLSX, Markdown, PDF, or TXT.

Export Draw

Download giveaway winners or entries.

Follower Export CRM

Move follower data into CSV and CRM workflows.
Last modified on May 24, 2026