Skip to content

Browser Management

Fresh

All endpoints use http://localhost:40185/api/v1/browser/... with POST method.

Create Browser

URL: /browser/create

Key Parameters

ParameterRequiredTypeDescription
serialNameYesstringEnvironment name (max 100 chars)
browserOsYesint1=Windows, 2=Mac
groupIdNostringGroup ID
tagIdsNoarray[string]Tag IDs
remarkNostringRemark (max 1500 chars)
cookieNostringCookie (JSON or Netscape format)
accountPlatformNostringhttps://www.tiktok.com/ or https://www.facebook.com/
accountUsernameNostringAccount username
accountPasswordNostringAccount password
accountTOTPSecretNostring2FA secret key
openLastPageNointRestore last visit: 1=Yes, 2=No
openSpecPageNointOpen specified URL: 1=Yes, 2=No
openTabsNostringURLs to open (separated by ;)
browserUaNostringCustom User-Agent
simulateConfigNoobjectFingerprint simulation config
proxyIdNostringExisting proxy ID
proxyConfigNoobjectProxy info
browserStartArgNostringBrowser startup parameters

Simulation Config (SimulateConfig)

Controls browser fingerprint including: timezone, language, resolution, WebRTC, geolocation, canvas, WebGL, hardware acceleration, AudioContext, media devices, ClientRects, SpeechVoices, hardware concurrency, device memory, Do Not Track, Bluetooth, battery, and port scan protection.

Proxy Types

typeIdProxy Type
-1Direct connection
1SOCKS5
2HTTP
3HTTPS
20IPIDEA
21IPHTML
22kookeey
23Lumatuo

Response

json
{ "code": 0, "data": { "id": "497548067550006541" } }

Update Browser

URL: /browser/update

Same parameters as Create, plus id (required). Only provided fields are updated.


Delete Browser

URL: /browser/delete

ParameterRequiredTypeDescription
envIdsYesarray[string]Browser IDs (max 100)

Response

json
{
  "data": {
    "successIds": ["id1"],
    "busyIds": ["id2"],
    "serverErrIds": ["id3"]
  }
}

Get Browser List

URL: /browser/list

ParameterRequiredTypeDescription
pageNointPage number (default 1)
pageSizeNointItems per page (1-100, default 10)
idsNoarray[string]Filter by IDs (max 100)
serialNameNostringFilter by name
remarkNostringFilter by remark

Launch Browser

URL: /browser/start

ParameterRequiredTypeDescription
idYesstringBrowser ID

Close Browser

URL: /browser/close

ParameterRequiredTypeDescription
idYesstringBrowser ID

Transfer Browsers

URL: /browser/transfer

ParameterRequiredTypeDescription
idsYesarray[string]Browser IDs
targetUserIdYesstringTarget user ID

Check Browser Status

URL: /browser/status

ParameterRequiredTypeDescription
idYesstringBrowser ID

Clear Browser Cache

URL: /browser/cache/clear

ParameterRequiredTypeDescription
idYesstringBrowser ID

Move Browser Group

URL: /browser/group/move

ParameterRequiredTypeDescription
idsYesarray[string]Browser IDs
groupIdYesstringTarget group ID

Get Environment Cookies

URL: /browser/cookies

ParameterRequiredTypeDescription
idYesstringBrowser ID

Error Codes

CodeDescription
44002Maximum package environments reached
44003Maximum user environments reached
44004Maximum daily environments reached
45006Incorrect proxy information
45003Proxy not allowed
45004Proxy verification failed
43028Sub-user group permission denied

GEELark API Documentation - Built with VitePress