JS Render - Scrapeless API

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Body Params application/json

actor

string

required

fixed valueunlocker.webunlocker

proxy

object

optional

proxy info

country

string

required

proxy country

input

object

required

url

string

required

target URL

headless

boolean

optional

headless: true or false

Default:

false

js_render

boolean

optional

js_instructions

array [object {6}]

optional

JavaScript Instructions Reference

block

object

optional

js_wait_until

enum<string>

optional

when to consider waiting succeeds. given an array of event strings, waiting is considered to be successful after all events have been fired

Allowed values:

loaddomcontentloadednetworkidle0networkidle2

Default:

domcontentloaded

outputs

enum<string>

optional

filter data from HTML, it accepts a comma-separated list of filter names and returns the results in a escaped JSON string format. work in js render mode only

Allowed values:

phone_numbersheadingsimagesaudiosvideoslinksmenushashtagsemailsmetadatatablesfavicon

response_type

enum<string>

optional

specify the return type of the string data in response. work in js render mode only

Allowed values:

htmlplaintextmarkdownpngjpegnetwork

Default:

html

response_image_full_page

boolean

optional

when true, takes a image of the full page. only works when response_type=png | jpeg

Default:

false

response_network_filters

object

optional

filter which network requests are included in the result. If omitted, all XHR/fetch requests are returned, only works when response_type=network

selector

string

optional

CSS selector for output filters and specified response type. work in js render mode only

Example

{
    "actor": "unlocker.webunlocker",
    "proxy": {
        "country": "US"
    },
    "input": {
        "url": "https://www.scrapeless.com",
        "headless": false,
        "js_render": true,
        "js_instructions": [
            {
                "wait": 10000
            },
            {
                "wait_for": [
                    ".dynamic-content",
                    30000
                ]
            },
            {
                "click": [
                    "#load-more",
                    1000
                ]
            },
            {
                "fill": [
                    "#search-input",
                    "search term"
                ]
            },
            {
                "keyboard": [
                    "press",
                    "Enter"
                ]
            },
            {
                "evaluate": "window.scrollTo(0, document.body.scrollHeight)"
            }
        ],
        "block": {
            "resources": [
                "stylesheet",
                "image",
                "media",
                "font",
                "script",
                "texttrack",
                "xhr",
                "fetch",
                "eventsource",
                "websocket",
                "manifest",
                "other"
            ]
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.scrapeless.com/api/v1/unlocker/request' \
--header 'Content-Type: application/json' \
--header 'x-api-token;' \
--data-raw '{
    "actor": "unlocker.webunlocker",
    "proxy": {
        "country": "US"
    },
    "input": {
        "url": "https://www.scrapeless.com",
        "headless": false,
        "js_render": true,
        "js_instructions": [
            {
                "wait": 10000
            },
            {
                "wait_for": [
                    ".dynamic-content",
                    30000
                ]
            },
            {
                "click": [
                    "#load-more",
                    1000
                ]
            },
            {
                "fill": [
                    "#search-input",
                    "search term"
                ]
            },
            {
                "keyboard": [
                    "press",
                    "Enter"
                ]
            },
            {
                "evaluate": "window.scrollTo(0, document.body.scrollHeight)"
            }
        ],
        "block": {
            "resources": [
                "stylesheet",
                "image",
                "media",
                "font",
                "script",
                "texttrack",
                "xhr",
                "fetch",
                "eventsource",
                "websocket",
                "manifest",
                "other"
            ]
        }
    }
}'

Responses

🟢200Success

application/json

Body

code

integer

required

data

string

required

Example

{
    "code": 200,
    "data": ""
}