Skip to main content
POST
/
api
/
sessions
Start Browser
curl --request POST \
  --url https://api.anchorbrowser.io/api/sessions \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '{
  "adblock_config": {
    "active": false,
    "popup_blocking_active": false
  },
  "captcha_config": {
    "active": false
  },
  "headless": false,
  "proxy_config": {
    "type": "anchor_residential",
    "country_code": "uk",
    "active": false
  },
  "recording": {
    "active": false
  },
  "profile": {
    "name": "my-profile",
    "persist": true
  },
  "viewport": {
    "width": 1440,
    "height": 900
  },
  "timeout": 10,
  "idle_timeout": 3,
  "view_only": true
}'
{
  "page_id": "<string>",
  "id": "<string>",
  "session_url": "<string>",
  "live_view_url": "<string>"
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Body

application/json
​
adblock_config
object

Configuration options for ad-blocking.

​
captcha_config
object

Configuration options for captcha-solving.

​
headless
boolean

Whether browser should be headless or headful.

Example:

false

​
proxy_config
object

Configuration options for proxy usage. Configuration options for residential proxy usage.

  • Anchor Residential Proxy
  • Anchor Mobile Proxy
  • Custom Proxy
​
recording
object

Should the session be recorded.

​
profile
object

Options for managing and persisting session profiles.

​
viewport
object

Configuration for the browser's viewport size.

​
timeout
integer

Maximum amount of time (in minutes) for the browser to run, before terminating. Defaults to 20. Setting it to -1 disables the global timeout mechanism [CAUTION - Keep track of long living sessions and manually kill them].

Example:

10

​
idle_timeout
integer

The amount of time (in minutes) the session waits for new connections after all others are closed before stopping. Defaults to 5. Setting it to -1 let the browser session continue forever [CAUTION - Keep track of long living sessions and manually kill them].

Example:

3

​
view_only
boolean

Whether the session is view only. Defaults to false. Only available for headful sessions.

Example:

true

Response

Successfully returned a browser object

​
page_id
string

Unique identifier for the browser page

​
id
string

Unique identifier for the browser instance

​
session_url
string

The cdp based live view embedding url

​
live_view_url
string

The headful chrome live view url, only available for headful sessions

⌘I