Nimble API
Nimble Docsnimbleway.com
HomeAPI ReferenceSDKsContext Plugin
Extract

Extract

POST
/v2/extract

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

auto_driver_configuration?

Custom flow for the optimization engine: maps candidate names to the number of attempts to spend on each candidate before advancing (0 skips it). Key order defines the flow order. Providing it opts the request into 'auto' driver selection.

body?unknown

Request body for POST, PUT, PATCH methods

browser?|
browser_actions?array<||||||||||||>

Array of browser automation actions to execute sequentially

Items1 <= items
city?string

City for geolocation

consent_header?boolean

Whether to automatically handle cookie consent headers

cookies?array<>|
country?|

Country code for geolocation and proxy selection

Default"ALL"
device?string

Device type for browser emulation

Default"desktop"

Value in

  • "desktop"
  • "mobile"
  • "tablet"
driver?string

Browser driver to use

Value in

  • "auto"
  • "vx6"
  • "vx8"
  • "vx8-pro"
  • "vx10"
  • "vx10-pro"
  • "vx12"
  • "vx12-pro"
  • "media-vx6"
  • "fast-vx6"
expected_status_codes?array<>

Expected HTTP status codes for successful requests

formats?array<>

List of acceptable response formats in order of preference

Items1 <= items
headers?

Custom HTTP headers to include in the request

Default{}
http2?boolean

Whether to use HTTP/2 protocol

Defaultfalse
is_xhr?boolean

Whether to emulate XMLHttpRequest behavior

Defaultfalse
locale?|

Locale for browser language and region settings

Default"en"
markdown_backend?string

Selects which markdown conversion strategy to use. "full_page" converts the entire HTML page. "main_content" uses Mozilla Readability to extract the main article content before converting.

Default"full_page"

Value in

  • "full_page"
  • "main_content"
method?string

HTTP method for the request

Default"GET"

Value in

  • "GET"
  • "POST"
  • "PUT"
  • "PATCH"
  • "DELETE"
network_capture?array<>

Filters for capturing network traffic

os?string

Operating system to emulate

Value in

  • "windows"
  • "mac os"
  • "linux"
  • "android"
  • "ios"
parse?boolean

Whether to parse the response content

Defaultfalse
parser?|

Custom parser configuration as a key-value map

referrer_type?|

Referrer policy for the request

render?|

Whether to render JavaScript content using a browser

request_timeout?number

Request timeout in milliseconds

Range1 <= value
session?
skill?|array<string>
state?string

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

Value in

  • "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"
tag?string

User-defined tag for request identification

url*string

Target URL to scrape

Response Body

application/json

curl -X POST "https://example.com/v2/extract" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
{  "data": {    "browser_actions": {      "results": [        {          "duration": 0,          "error": "string",          "name": "goto",          "result": null,          "status": "no-run"        }      ],      "success": true,      "total_duration": 0    },    "cookies": [      null    ],    "eval": [      null    ],    "fetch": [      null    ],    "headers": {      "property1": "string",      "property2": "string"    },    "html": "string",    "links": [      "string"    ],    "markdown": "string",    "network_capture": [      {        "errorMessage": "string",        "filter": {          "method": "GET",          "resource_type": "document",          "status_code": 100,          "url": {            "type": "exact",            "value": "string"          },          "validation": false,          "wait_for_requests_count": 0,          "wait_for_requests_count_timeout": 1        },        "results": [          {            "request": {              "body": "string",              "headers": {                "property1": "string",                "property2": "string"              },              "method": "string",              "resource_type": "document",              "url": "string"            },            "response": {              "body": "string",              "headers": {                "property1": "string",                "property2": "string"              },              "serialization": "none",              "status": 0,              "status_text": "string"            }          }        ]      }    ],    "pages_html": [      "string"    ],    "parsing": {      "entities": {        "property1": null,        "property2": null      },      "status": "success"    },    "redirects": [      {        "status_code": 100,        "url": "string"      }    ],    "screenshots": [      null    ]  },  "debug": {    "performance_metrics": {      "property1": 0,      "property2": 0    },    "proxy_total_bytes_usage": 0,    "transformed_output": null,    "userbrowser": null  },  "metadata": {    "agent": "string",    "driver": "string",    "localization_id": "string",    "query_duration": 0,    "query_time": "string",    "response_parameters": null,    "tag": "string"  },  "pagination": {    "next_page_params": {      "property1": null,      "property2": null    }  },  "status": "success",  "status_code": 0,  "task_id": "string",  "url": "string",  "warnings": [    "string"  ]}

Get Driver GET

Resolves the suggested driver for a given URL or agent name. Exactly one of `url` or `agent` must be provided.

Extract Async POST

Next Page