Sign in
Extract

Extract Async Endpoint

post/v1/extract/async

Request body

parseboolean

Whether to parse the response content

urlstring required

Target URL to scrape

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'

HTTP method for the request

expected_status_codesinteger[]

Expected HTTP status codes for successful requests

headersobject

Custom HTTP headers to include in the request

request_timeoutnumber

Request timeout in milliseconds

http2boolean

Whether to use HTTP/2 protocol

is_xhrboolean

Whether to emulate XMLHttpRequest behavior

driver'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro'

Browser driver to use

consent_headerboolean

Whether to automatically handle cookie consent headers

formatsstring[]

List of acceptable response formats in order of preference

renderboolean

Whether to render JavaScript content using a browser

tagstring

User-defined tag for request identification

device'desktop' | 'mobile' | 'tablet'

Device type for browser emulation

os'windows' | 'mac os' | 'linux' | 'android' | 'ios'

Operating system to emulate

state'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY'

US state for geolocation (only valid when country is US)

citystring

City for geolocation

callback_urlstring

URL to call back when async operation completes

storage_typestring

Type of storage to use for results

storage_urlstring

URL for storage location

storage_compressboolean

Whether to compress stored data

storage_object_namestring

Custom name for the stored object

Example request

{
  "browser_actions": [
    {
      "goto": "https://example.com/login"
    },
    {
      "wait_for_element": "#login-form"
    },
    {
      "fill": {
        "selector": "#username",
        "value": "user@example.com"
      }
    },
    {
      "fill": {
        "selector": "#password",
        "value": "password123"
      }
    },
    {
      "click": "#submit"
    },
    {
      "screenshot": {
        "full_page": true
      }
    }
  ]
}

Response

Task created successfully

statusstring required

Status indicating the async task was created successfully.

Changes