Extractions
Twitter Extraction Status & Result Progress
Inspect an extraction job’s status, tool, progress, row count, and paginated tweet, follower, reply, profile, timeline, or list results. See examples.
- 200
- 400
- 401
- 404
- 429
GET
Twitter Extraction Status & Result Progress
Free - does not consume credits
Headers
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.
Path parameters
string
required
Extraction job ID returned from Create Extraction or List Extractions.
Query parameters
number
Number of results to return per page. Default:
100. Maximum: 1000.string
Result ID cursor for pagination. Use the
nextCursor value from the previous response to fetch the next page.string
Result fields:
compact, full, or raw. Defaults to full.string
Keep enrichment
nested or merge it with flat.string
Field names:
source, camelCase, or snake_case.boolean
Deprecated. Use
outputMode=raw.Response
200 OK
object
Extraction job metadata.
Job object fields:
string
Unique extraction job ID.
string
Tool type used for this extraction.
string
Job status:
completed, failed, or running.number
Total number of extracted results.
string
Target tweet ID. Present for tweet-based tools.
string
Target username. Present for user-based tools.
string
Target X user ID. Present for user-based tools.
string
Target community ID. Present for
community_extractor, community_moderator_explorer, community_post_extractor, community_search.string
Search query. Present for
people_search, community_search.string
Error description. Only present for failed jobs.
string
ISO 8601 timestamp of when the job was created.
string
ISO 8601 timestamp of when the job finished. Only present for completed jobs.
object[]
Array of extracted user/tweet records for the current page.Result object fields:
Only
id and xUserId are guaranteed on every result. All other fields are omitted entirely when unavailable (never set to null). Always check for the presence of a field before accessing it.string
required
Unique result ID.
string
required
X user ID.
string
X username (handle). Omitted if unavailable.
string
X display name. Omitted if unavailable.
number
Follower count at time of extraction. Omitted if unavailable.
boolean
Whether the user has a verified badge. Omitted if unavailable.
string
URL to the user’s profile image. Omitted if unavailable.
string
Tweet ID. Omitted for non-tweet-based extractions.
string
Tweet text content. Omitted for non-tweet-based extractions.
string
ISO 8601 timestamp of the tweet. Omitted for non-tweet-based extractions.
string
ISO 8601 timestamp of when the result was created.
object
Additional profile, tweet, and article metadata. Omitted when unavailable. Contains nested user fields (
description, location, coverPicture, followingCount, favouritesCount, mediaCount, statusesCount), tweet fields (likeCount, replyCount, repostCount, quoteCount, viewCount, bookmarkCount, conversationId, lang, source), and article fields (title, bodyText, previewText).boolean
Whether more results exist beyond this page.
string
Cursor for the next
cursor parameter. Only present when hasMore is true.401 Unauthenticated
404 Not Found
429 Rate Limited
Retry-After value before polling again.
Paginating results
Results are ordered by ID ascending. To iterate through all results for a large extraction:- Make the initial request without the
cursorparameter. - Check
hasMore. PassnextCursoras the nextcursorvalue. - Repeat until
hasMoreisfalse.
Cursor handoff
UseGET /extractions/{id} when an integration needs structured JSON rows,
incremental checkpoints, or more rows 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
Persist selected fields such as
row_id, x_user_id, x_username,
tweet_id, and tweet_text. Do not dump raw result arrays into shared logs.Large jobs
Stream pages to
xquik-extraction-results.jsonl when you need replayable
rows or results beyond the export row cap.File handoff
Use Export Extraction when CSV, JSON,
XLSX, Markdown, PDF, or TXT files are enough.
Next steps: Export Extraction to download all results as CSV, XLSX, or Markdown, or List Extractions to browse your job history.
- 200
- 400
- 401
- 404
- 429
Twitter Extraction Status & Result Progress