Skip to main content
POST
/
v1
/
extract
/
async
Extract Async
curl --request POST \
  --url https://sdk.nimbleway.com/v1/extract/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://www.example.com",
  "render": true,
  "country": "US",
  "locale": "en-US",
  "storage_url": "s3://mu-s3-bucket.com/",
  "storage_type": "s3",
  "callback_url": "https://my-callback-url.com/"
}
'
{
  "status": "success",
  "task": {
    "id": "8e8cfde8-345b-42b8-b3e2-0c61eb11e00f",
    "state": "pending",
    "created_at": "2026-01-24T12:36:24.685Z",
    "modified_at": "2026-01-24T12:36:24.685Z",
    "input": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body model for the /extract endpoint

​
url
string<uri>
required

Target URL to scrape

Example:

"https://example.com/page"

​
country
string

Country used to access the target URL, use ISO Alpha-2 Country Codes

Example:

"US"

​
state
string

State used to access the target URL (US and CA only), use ISO Alpha-2 Country Codes

Example:

"NY"

​
city
string

City used to access the target URL

Example:

"new_york"

​
locale
string

LCID standard locale used for the URL request. Alternatively, user can use 'auto' for automatic locale based on geo-location

Example:

"en-US"

​
render
boolean

Whether to render JavaScript content using a browser

Example:

true

​
parse
boolean

Whether to parse the response content

​
parser
object

Custom extraction recipe defining what data to extract and how to structure it. Each property represents a field in the output.

​
format
enum<string>

Response format

Available options:
json,
html,
csv,
raw,
json-lines,
markdown
Example:

"json"

​
driver
enum<string>

Browserless drivers available for web extraction

Available options:
vx6,
vx8,
vx8-pro,
vx10,
vx10-pro
Example:

"vx8"

​
network_capture
object[]

Intercept and capture network requests made by the page

​
browser_actions
object[]

Array of actions to perform sequentially during browser rendering

Examples:
{ "wait": "2s" }

{
  "click": { "selector": "#load-more", "timeout": "5s" }
}
​
browser

Browser type to emulate

Available options:
chrome,
firefox
Example:

"chrome"

​
os
enum<string>

Operating system to emulate

Available options:
windows,
mac os,
linux,
android,
ios
Example:

"windows"

​
no_userbrowser
boolean

Whether to disable browser-based rendering

Example:

false

​
device
enum<string>

Device type for browser emulation

Available options:
desktop,
mobile,
tablet
Example:

"desktop"

​
tag
string

User-defined tag for request identification

Example:

"campaign-2024-q1"

​
is_xhr
boolean

Whether to emulate XMLHttpRequest behavior

Example:

true

​
http2
boolean

Whether to use HTTP/2 protocol

Example:

true

​
expected_status_codes
integer[]

Expected HTTP status codes for successful requests

Required range: -9007199254740991 <= x <= 9007199254740991
Examples:

200

201

​
referrer_type

Referrer policy for the request

Available options:
random,
no-referer,
same-origin
Example:

"no-referrer"

​
method
enum<string>

HTTP method for the request

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
Example:

"GET"

​
render_options
object
​
storage_type
enum<string>

Storage type for async results. Use s3 for Amazon S3 and gs for Google Cloud Platform.

Available options:
s3,
gs
Example:

"s3"

​
storage_url
string

Repository URL where output will be saved. Format: s3://Your.Bucket.Name/your/object/name/prefix/ - Output will be saved as TASK_ID.json

Example:

"s3://Your.Repository.Path/"

​
callback_url
string<uri>

A URL to callback once the data is delivered. The API will send a POST request with task details (without the requested data) when the task completes.

Example:

"https://your.callback.url/path"

​
storage_compress
boolean

When set to true, the response saved to storage_url will be compressed using GZIP format. If false or not set, response will be saved uncompressed.

Example:

false

​
storage_object_name
string

Custom name for the stored object instead of the default task ID

Example:

"my task"

Response

Async Task Created

​
status
string
required
Example:

"success"

​
task
object
required