Skip to main content
GET https://xquik.com/api/v1/extractions/{id}
Free. This endpoint does not consume credits.

Headers

Path parameters

Query parameters

Response

200 OK

With outputMode=compact, tweet results keep tweetUrl, likeCount, retweetCount, replyCount, quoteCount, viewCount, and bookmarkCount. Compact output omits xProfileImageUrl and enrichmentData.

401 Unauthenticated

Missing or invalid API key.

404 Not found

No extraction job exists with this ID, or it belongs to a different account.

429 Rate limited

{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 1 } Wait for the Retry-After value before polling again.

Paginating results

The API orders results by ID ascending. Follow these steps to read every result of a large extraction.
  1. Make the initial request without the cursor parameter.
  2. Check hasMore. Pass nextCursor as the next cursor value.
  3. Repeat until hasMore is false.

Cursor handoff

Use GET /extractions/{id} when an integration needs structured JSON rows, incremental checkpoints, or extra rows. Extra rows are more than a file export can return. Treat nextCursor as an opaque checkpoint and pass it back as cursor.

Page checkpoint

Store extraction_id, page_index, page_cursor, next_cursor, has_more, and result_count after each successful page.

Row shape

Store selected fields such as row_id, x_user_id, x_username, tweet_id, and tweet_text. Do not write raw result arrays to shared logs.

Large jobs

Stream pages to xquik-extraction-results.jsonl when you need replayable rows.

File handoff

Use Export Extraction when CSV, JSON, XLSX, Markdown, PDF, or TXT files are enough.
Store page checkpoints separately from row data.
Next steps.

Response examples

200 example

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 404 { "error": "not_found", "message": "Resource not found." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }