Skip to content

Parameters and API Beta ​

Parameters ​

Send them as JSON in the body of POST /v1/browsers?api_key=YOUR_API_KEY. All are optional.

ParameterTypeDefaultDescription
osstringlinuxThe identity's operating system: windows or linux.
proxystringpremiumpremium (residential), datacenter, or your own proxy URL (http://, https:// or socks5://, with user:pass@ if needed).
countrystringExit country of a premium or datacenter proxy, as a two-letter code (us, fr, …).
proxy_sessionstringKeeps the same exit IP for every session that uses this value (pool proxies only).
identitystringA label of your choice (1 to 64 characters: letters, digits, ., _, -). The first session with a label saves its device; later sessions with the same label reuse it. See Persistent identity.
humanizebooleanfalseMoves the mouse and types like a person. Each click takes 0.5 to 1 second longer, and typing about 180 ms per character.
timeout_secnumber3600Longest session, in seconds (10 to 3600).
idle_timeout_secnumber300Ends the session after this many seconds without a CDP message from your client (10 to 3600).
max_mbnumberEnds the session once its traffic reaches this many MB.

Response ​

POST /v1/browsers answers 201 Created:

json
{
  "id": "bs_ddf42ffe56b3cd9f935c",
  "connect_url": "wss://browser.bitfetcher.io/v1/connect/bs_ddf42ffe56b3cd9f935c?token=…",
  "expires_at": "2026-11-12T10:35:03Z",
  "limits": { "max_seconds": 3600, "max_mb": 0 }
}
FieldDescription
idThe session's ID, for the endpoints below.
connect_urlThe WebSocket URL to connect Puppeteer or Playwright to. One use, before expires_at.
expires_atWhen the connect_url stops working if nobody has connected.
limitsThe session's time and traffic limits.

Managing sessions ​

RequestDescription
GET /v1/browsersYour latest sessions and your balance.
GET /v1/browsers/{id}One session: its state, duration, traffic, cost and exit IP.
DELETE /v1/browsers/{id}Cancels a session nobody has connected to yet.

A running session ends when your client closes the browser or disconnects, or when it reaches one of its limits.

Limits and errors ​

StatusWhen
400An invalid parameter. The message names it.
402Your balance is too low to start a session.
429You already have 5 browsers running. Close one first.