Extractions

Changed on

Returns extraction jobs with status and result counts.

get/api/v1/extractions

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/extractions
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

limitinteger

Maximum items per page, from 1 to 100. Default 50. A low credit balance can return fewer paid results. When it covers none, the answer is 402 insufficient_credits.

cursorstring

Previous nextCursor. The after alias also works. 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

  • 45942c75fdc2Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status