Headless (POST)

post

https://clients.tcpnix.com/api/headless

Headless browser POST request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

apiKey

string

required

Defaults to xxxxx

Your TCPNIX API key

url

string

required

Defaults to https://tcpnix.com/ip

Target URL

untill

string

enum

Defaults to networkidle2

The waitUntil parameter accepts the following values: domcontentloaded, networkidle0, networkidle2, and load:

domcontentloaded waits for the DOMContentLoaded event to fire, which occurs when the initial HTML document has been completely loaded and parsed.

networkidle0 waits until there are no more than 0 network connections for at least 500 ms.

networkidle2 waits until there are no more than 2 network connections for at least 500 ms. (default)

load waits for the window.load event to fire, which occurs when all page resources (including images, stylesheets, and scripts) have finished loading.

Allowed:

render_js

boolean

enum

Defaults to false

The headless browser will execute the JavaScript code on the page (default: false)

Allowed:

wait

integer

The headless browsers will wait the duration of the time set in milliseconds before returning the page's HTML.

win_width

integer

Defaults to 1920

If you need to change the dimension of the browser's viewport (window) when scraping the target page you can use the win_width and win_height parameters.

win_height

integer

Defaults to 1080

If you need to change the dimension of the browser's viewport (window) when scraping the target page you can use the win_width and win_height parameters.

user_agent

string

Custom user agent

string

Set custom cookies for this request.

String must be a JSON encoded string, ie;

{"cookie_name_1":"cookie_value1","cookie_name_2":"cookie_value_2"}

Headers

TCPNIX-CustomHeader

string

Example to send custom header

Custom forwarded headers must start with TCPNIX-***

Example; TCPNIX-AuthCode: 123

Will forward the "AuthCode: 123" header

Response

200