Sign in
Extractions

List extraction jobs

Returns extraction jobs with status and result counts.

get/api/v1/extractions

Query parameters

limitinteger

Maximum items per page: 1 to 100, default 50. Credits can reduce paid results. The endpoint returns 402 insufficient_credits when none are affordable.

cursorstring

Previous nextCursor. Offset pagination is not supported.

toolType'article_extractor' | 'community_extractor' | 'community_moderator_explorer' | 'community_post_extractor' | 'community_search' | 'favoriters' | 'follower_explorer' | 'following_explorer' | 'list_follower_explorer' | 'list_member_extractor' | 'list_post_extractor' | 'mention_extractor' | 'people_search' | 'post_extractor' | 'quote_extractor' | 'reply_extractor' | 'repost_extractor' | 'space_explorer' | 'thread_extractor' | 'tweet_search_extractor' | 'user_likes' | 'user_media' | 'verified_follower_explorer'

Identifier for the extraction tool used to run a job.

Example:follower_explorer

Filter by extraction tool type

status'pending' | 'running' | 'canceled' | 'completed' | 'failed'

Filter by job status

Response

Extraction job list

hasMoreboolean required
nextCursorstring

Example response

{
  "extractions": [],
  "nextCursor": "abc123"
}

Changes

Changed in 5 of the 19 revisions of this API.777

  • f23b15f4dac23See the full diff
    • ●

      added the new deadline_reached enum value to the extractions/items/completionReason response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pagination_safety_limit enum value to the extractions/items/completionReason response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new partial_failure enum value to the extractions/items/completionReason response property for the response status 200

      response-property-enum-value-added

  • d6cb34aefa9f2See the full diff
    • ○

      added the new enum value pending to the query request parameter status

      request-parameter-enum-value-added

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

  • dc5ab8bc994e25See the full diff
    • ●

      added the new canceled enum value to the extractions/items/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pending enum value to the extractions/items/status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value canceled to the query request parameter status

      request-parameter-enum-value-added

    • ○

      added the optional property extractions/items/completionReason to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property extractions/items/effectiveResultsLimit to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property extractions/items/errorMessage to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property extractions/items/resultsLimit to the response with the 200 status

      response-optional-property-added

  • 5d4938bb7de354See the full diff
    • ●

      added the new closed enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new closed enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new expired enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new expired enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

  • 4da209b29df818See the full diff
    • ●

      added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default

      response-property-enum-value-added