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

CreateProfile

POST

/profiles

create profile, default parameters will be used if request body is empty

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

groupId

string

optional

profile group id, higher priority than groupName

Example:

1e455935-3e3e-4e3e-8e3e-3e3e3e3e3e3e

groupName

string

optional

an existing group name

Example:

Default

proxy

string

optional

profile proxy, higher priority than proxyGroupName

Example:

http://username:password@ip:port

proxyGroupName

string

optional

an existing proxy group name

note

string

optional

profile note

fingerprint

object

optional

fingerprints

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'

startupUrls

array[string]

optional

browser startup urls

args

object

optional

custom args with kernel command line switches

Additional properties

string

optional

Example

{
    "name": "testProfile",
    "platform": "Windows",
    "kernelMilestone": "132",
    "groupName": "Default",
    "note": "test profile note",
    "proxy": "http://admin:[email protected]:8000",
    "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 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.6834.83 Safari/537.36'",
        "deviceMemory": 8,
        "hardwareConcurrency": 16,
        "disableImageLoading": true,
        "restoreLastSession": 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/profiles' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "name": "testProfile",
    "platform": "Windows",
    "kernelMilestone": "132",
    "groupName": "Default",
    "note": "test profile note",
    "proxy": "http://admin:[email protected]:8000",
    "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 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.6834.83 Safari/537.36'\''",
        "deviceMemory": 8,
        "hardwareConcurrency": 16,
        "disableImageLoading": true,
        "restoreLastSession": 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 (business.CreateProfileResp)

optional

_id

string

optional

createdAt

string

optional

fingerprintId

string

optional

groupId

string

optional

kernel

integer

optional

kernelMilestone

string

optional

kernelVersion

string

optional

name

string

optional

note

string

optional

platform

integer

optional

platformVersion

string

optional

profileId

string

optional

saveLocal

boolean

optional

status

integer

optional