🎉The new Browserless is Live! Experience the future of web scraping now!🎉

Nstbrowser API

StartOnceBrowser

POST

/browsers/once

v2/Browsers

Start once browser

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

name

string

optional

profile name, default value: nst_${timestamp}

Example:

Profile

platform

enum<string>

optional

fingerprint os platform, default value: it's Windows on windows otherwise macOS

Allowed values:

WindowsmacOSLinux

Example:

Windows

kernelMilestone

enum<string>

optional

kernelMilestone, default value: the latest published version

Allowed values:

128130132

Example:

132

autoClose

boolean

optional

indicates autoclose browser after finished

timedCloseSec

integer

optional

indicates autoclose browser after specified seconds

Example:

fingerprintRandomness

boolean

optional

more random fingerprints

Example:

true

headless

string

optional

incognito

boolean

optional

incognito mode

remoteDebuggingPort

integer

optional

browser port

proxy

string

optional

profile proxy, higher priority than proxyGroupName

Example:

http://username:password@ip:port

skipProxyChecking

boolean

optional

indicates skip proxy checking when launch profile,Based On IP flagged fingerprints will take on your local IP rather than your proxy IP

args

object

optional

custom args with kernel command line switches

Additional properties

string

optional

startupUrls

array[string]

optional

startup urls

fingerprint

object

optional

custom fingerprint

deviceMemory

enum<integer>

optional

deviceMemory

Allowed values:

248

Example:

disableImageLoading

boolean

optional

disableImageLoading

doNotTrack

boolean

optional

DoNotTrack

flags

object

optional

fingerprint flags

fonts

array[string]

optional

fonts list,works on flags.fonts == 'Custom'

geolocation

object

optional

geolocation,works on flags.localization == 'Custom'

hardwareConcurrency

enum<integer>

optional

hardwareConcurrency

Allowed values:

24810121416

Example:

localization

object

optional

languages,works on flags.localization == 'Custom'; localization.timezone works on flags.localization == 'Custom'

restoreLastSession

boolean

optional

indicates the last session should be restored on startup

screen

object

optional

screen,works on flags.screen == 'Custom'

userAgent

string

optional

navigator.userAgent

webrtc

object

optional

webrtc ips,works on flags.webrtc == 'Custom'

Example

{
  "name": "testProfile",
  "platform": "Windows",
  "kernelMilestone": "132",
  "autoClose": true,
  "timedCloseSec": 30,
  "headless": false,
  "incognito": false,
  "proxy": "http://admin:123456@127.0.0.1:8000",
  "skipProxyChecking": true,
  "fingerprint": {
    "flags": {
      "audio": "Noise",
      "battery": "Masked",
      "canvas": "Noise",
      "clientRect": "Noise",
      "fonts": "Masked",
      "geolocation": "Custom",
      "geolocationPopup": "Prompt",
      "gpu": "Allow",
      "localization": "Custom",
      "screen": "Custom",
      "speech": "Masked",
      "timezone": "Custom",
      "webgl": "Noise",
      "webrtc": "Custom"
    },
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.6998.45 Safari/537.36",
    "deviceMemory": 8,
    "hardwareConcurrency": 16,
    "disableImageLoading": true,
    "doNotTrack": true,
    "localization": {
      "language": "zh-HK",
      "languages": [
        "zh-HK",
        "en-US",
        "en"
      ],
      "timezone": "Asia/Hong_Kong"
    },
    "screen": {
      "width": 1280,
      "height": 1024
    },
    "geolocation": {
      "latitude": "31.2333",
      "longitude": "121.469",
      "accuracy": "603"
    },
    "webrtc": {
      "publicIp": "111.111.111.111"
    }
  },
  "startupUrls": [
    "https://www.nstbrowser.io"
  ],
  "args": {
    "--remote-debugging-port": 34543,
    "disable-backgrounding-occluded-windows": true
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:8848/api/v2/browsers/once' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "testProfile",
    "platform": "Windows",
    "kernelMilestone": "132",
    "autoClose": true,
    "timedCloseSec": 30,
    "headless": false,
    "incognito": false,
    "proxy": "http://admin:123456@127.0.0.1:8000",
    "skipProxyChecking": true,
    "fingerprint": {
        "flags": {
            "audio": "Noise",
            "battery": "Masked",
            "canvas": "Noise",
            "clientRect": "Noise",
            "fonts": "Masked",
            "geolocation": "Custom",
            "geolocationPopup": "Prompt",
            "gpu": "Allow",
            "localization": "Custom",
            "screen": "Custom",
            "speech": "Masked",
            "timezone": "Custom",
            "webgl": "Noise",
            "webrtc": "Custom"
        },
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.6998.45 Safari/537.36",
        "deviceMemory": 8,
        "hardwareConcurrency": 16,
        "disableImageLoading": true,
        "doNotTrack": true,
        "localization": {
            "language": "zh-HK",
            "languages": [
                "zh-HK",
                "en-US",
                "en"
            ],
            "timezone": "Asia/Hong_Kong"
        },
        "screen": {
            "width": 1280,
            "height": 1024
        },
        "geolocation": {
            "latitude": "31.2333",
            "longitude": "121.469",
            "accuracy": "603"
        },
        "webrtc": {
            "publicIp": "111.111.111.111"
        }
    },
    "startupUrls": [
        "https://www.nstbrowser.io"
    ],
    "args": {
        "--remote-debugging-port": 34543,
        "disable-backgrounding-occluded-windows": true
    }
}'

Responses

🟢200OK

application/json

Body

code

integer

optional

data

object (browser.RemoteDebuggingAddress)

optional

port

integer

optional

profileId

string

optional

proxy

string

optional

webSocketDebuggerUrl

string

optional

err

boolean

optional

msg

string

optional

Example

{
  "code": 0,
  "data": {
    "port": 0,
    "profileId": "string",
    "proxy": "string",
    "webSocketDebuggerUrl": "string"
  },
  "err": true,
  "msg": "string"
}

StartBrowsers

StopBrowser