Nstbrowser SOP

Appearance

Install ​

Nstbrowser has two layers: the desktop client (or Docker container) that runs the browser engine, and an optional SDK that wraps the local API. You need the client running before any SDK or script call will work.

1. Desktop Client (Windows) ​

System requirements: Windows 7 or later, 2-core CPU, 2 GB RAM, at least 2 GB free disk space (install on a non-system drive when possible).

  1. Register at https://app.nstbrowser.io/account/register
  2. After login, the "Connect Agent" window appears automatically.
  3. Click the download button and run the installer.
  4. The client starts a local API server on http://localhost:8848/api/v2.

2. Docker Deployment ​

For headless or cloud environments, run the official Docker image:

bash
docker pull nstbrowser/agent:latest
docker run -d \
  -p 8848:8848 \
  --name nstbrowser-agent \
  nstbrowser/agent:latest

The same API (http://localhost:8848/api/v2) is available once the container starts. API v2 works identically for both the desktop client and Docker.

3. Node.js SDK ​

Requires Node.js 16+ and the client or Docker container already running.

bash
npm install nstbrowser-sdk-node
# or
pnpm install nstbrowser-sdk-node
# or
yarn add nstbrowser-sdk-node

4. Python SDK ​

Requires Python 3.8+ and the client or Docker container already running.

bash
pip install nstbrowser

5. Get Your API Key ​

Your API key is displayed in the Nstbrowser desktop client under Settings > API. Pass it to every SDK constructor or HTTP request header.