Get profile by id

curl --request GET \
  --url https://api.gologin.com/browser/{id} \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "id": "<string>",
  "notes": "<string>",
  "browserType": "fierfox",
  "os": "lin",
  "osSpec": "M1",
  "startUrl": "<string>",
  "autoLang": true,
  "bookmarks": {},
  "googleServicesEnabled": true,
  "isBookmarksSynced": true,
  "launchArguments": "<string>",
  "lockEnabled": true,
  "debugMode": true,
  "navigator": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.6998.36 Safari/537.36",
    "resolution": "1920x1080",
    "language": "en-US",
    "platform": "Win32",
    "hardwareConcurrency": 4,
    "deviceMemory": 4,
    "maxTouchPoints": 10
  },
  "proxyEnabled": true,
  "autoProxyServer": "<string>",
  "autoProxyUsername": "<string>",
  "autoProxyPassword": "<string>",
  "dns": "<string>",
  "facebookAccountData": {
    "date": "<string>",
    "token": "<string>",
    "fbIdAccount": "<string>",
    "email": "<string>",
    "password": "<string>",
    "googleDriveUrl": "<string>",
    "fb2faToolUrl": "<string>",
    "fbUrl": "<string>",
    "uaVersion": "<string>",
    "cookies": "<string>",
    "notParsedData": [
      "<string>"
    ]
  },
  "canBeRunning": true,
  "isM1": true,
  "storage": {
    "local": true,
    "extensions": true,
    "bookmarks": true,
    "history": true,
    "passwords": true,
    "session": true,
    "indexedDb": false,
    "enableExternalExtensions": false
  },
  "proxy": {
    "mode": "http",
    "id": "6201422450e3b9cd602f24e1",
    "host": "127.0.0.1",
    "port": 80,
    "username": "user",
    "password": "password",
    "changeIpUrl": "https://some-proxy-provider.com/change-ip",
    "customName": "My Proxy"
  },
  "archivedProxy": {
    "id": "<string>",
    "name": "<string>",
    "country": "<string>"
  },
  "plugins": {
    "enableVulnerable": true,
    "enableFlash": true
  },
  "timezone": {
    "enabled": true,
    "fillBasedOnIp": true,
    "timezone": "America/New_York"
  },
  "geolocation": {
    "mode": "prompt",
    "enabled": true,
    "customize": true,
    "fillBasedOnIp": true,
    "isCustomCoordinates": true,
    "latitude": 123,
    "longitude": 123,
    "accuracy": 123
  },
  "audioContext": {
    "mode": "noise",
    "noise": 0.1
  },
  "canvas": {
    "mode": "off",
    "noise": 0.1
  },
  "fonts": {
    "families": [
      "Arial",
      "Helvetica",
      "Verdana"
    ],
    "enableMasking": true,
    "enableDomRect": true
  },
  "mediaDevices": {
    "videoInputs": 1,
    "audioInputs": 1,
    "audioOutputs": 1,
    "enableMasking": false,
    "uid": "<string>"
  },
  "webRTC": {
    "mode": "off",
    "enable": true,
    "isEmptyIceList": true
  },
  "webGL": {
    "mode": "noise",
    "getClientRectsNoise": 0.5,
    "noise": 0.5
  },
  "webGpu": {},
  "clientRects": {
    "mode": "noise",
    "noise": 0.5
  },
  "webGLMetadata": {
    "mode": "mask",
    "vendor": "Google Inc. (Intel)",
    "renderer": "ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)"
  },
  "extensions": {
    "enabled": true,
    "preloadCustom": true,
    "names": [
      "WEBGL_debug_renderer_info",
      "EXT_texture_filter_anisotropic"
    ]
  },
  "profile": "<string>",
  "s3Path": "<string>",
  "s3Date": "<string>",
  "s3SignedUrl": "<string>",
  "createdInOs": {},
  "devicePixelRatio": 123,
  "checkCookies": true,
  "chromeExtensions": [
    "<string>"
  ],
  "userChromeExtensions": [
    "<string>"
  ],
  "isAutoGenerated": true,
  "permissions": {}
}

GET

browser

{id}

Get profile by id

curl --request GET \
  --url https://api.gologin.com/browser/{id} \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "id": "<string>",
  "notes": "<string>",
  "browserType": "fierfox",
  "os": "lin",
  "osSpec": "M1",
  "startUrl": "<string>",
  "autoLang": true,
  "bookmarks": {},
  "googleServicesEnabled": true,
  "isBookmarksSynced": true,
  "launchArguments": "<string>",
  "lockEnabled": true,
  "debugMode": true,
  "navigator": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.6998.36 Safari/537.36",
    "resolution": "1920x1080",
    "language": "en-US",
    "platform": "Win32",
    "hardwareConcurrency": 4,
    "deviceMemory": 4,
    "maxTouchPoints": 10
  },
  "proxyEnabled": true,
  "autoProxyServer": "<string>",
  "autoProxyUsername": "<string>",
  "autoProxyPassword": "<string>",
  "dns": "<string>",
  "facebookAccountData": {
    "date": "<string>",
    "token": "<string>",
    "fbIdAccount": "<string>",
    "email": "<string>",
    "password": "<string>",
    "googleDriveUrl": "<string>",
    "fb2faToolUrl": "<string>",
    "fbUrl": "<string>",
    "uaVersion": "<string>",
    "cookies": "<string>",
    "notParsedData": [
      "<string>"
    ]
  },
  "canBeRunning": true,
  "isM1": true,
  "storage": {
    "local": true,
    "extensions": true,
    "bookmarks": true,
    "history": true,
    "passwords": true,
    "session": true,
    "indexedDb": false,
    "enableExternalExtensions": false
  },
  "proxy": {
    "mode": "http",
    "id": "6201422450e3b9cd602f24e1",
    "host": "127.0.0.1",
    "port": 80,
    "username": "user",
    "password": "password",
    "changeIpUrl": "https://some-proxy-provider.com/change-ip",
    "customName": "My Proxy"
  },
  "archivedProxy": {
    "id": "<string>",
    "name": "<string>",
    "country": "<string>"
  },
  "plugins": {
    "enableVulnerable": true,
    "enableFlash": true
  },
  "timezone": {
    "enabled": true,
    "fillBasedOnIp": true,
    "timezone": "America/New_York"
  },
  "geolocation": {
    "mode": "prompt",
    "enabled": true,
    "customize": true,
    "fillBasedOnIp": true,
    "isCustomCoordinates": true,
    "latitude": 123,
    "longitude": 123,
    "accuracy": 123
  },
  "audioContext": {
    "mode": "noise",
    "noise": 0.1
  },
  "canvas": {
    "mode": "off",
    "noise": 0.1
  },
  "fonts": {
    "families": [
      "Arial",
      "Helvetica",
      "Verdana"
    ],
    "enableMasking": true,
    "enableDomRect": true
  },
  "mediaDevices": {
    "videoInputs": 1,
    "audioInputs": 1,
    "audioOutputs": 1,
    "enableMasking": false,
    "uid": "<string>"
  },
  "webRTC": {
    "mode": "off",
    "enable": true,
    "isEmptyIceList": true
  },
  "webGL": {
    "mode": "noise",
    "getClientRectsNoise": 0.5,
    "noise": 0.5
  },
  "webGpu": {},
  "clientRects": {
    "mode": "noise",
    "noise": 0.5
  },
  "webGLMetadata": {
    "mode": "mask",
    "vendor": "Google Inc. (Intel)",
    "renderer": "ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)"
  },
  "extensions": {
    "enabled": true,
    "preloadCustom": true,
    "names": [
      "WEBGL_debug_renderer_info",
      "EXT_texture_filter_anisotropic"
    ]
  },
  "profile": "<string>",
  "s3Path": "<string>",
  "s3Date": "<string>",
  "s3SignedUrl": "<string>",
  "createdInOs": {},
  "devicePixelRatio": 123,
  "checkCookies": true,
  "chromeExtensions": [
    "<string>"
  ],
  "userChromeExtensions": [
    "<string>"
  ],
  "isAutoGenerated": true,
  "permissions": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Id of the profile.

Query Parameters

currentWorkspace

string

If you want to get the profile from a specific workspace.

Example:

"60a763f86501b3abcdc54b21"

Response

200 - application/json

name

string

required

string

required

notes

string

required

browserType

enum<string>

required

Available options:

fierfox,

chrome

enum<string>

required

Available options:

lin,

mac,

win,

android,

android-cloud

osSpec

enum<string>

required

Available options:

M1,

M2,

M3,

M4,

win11,

startUrl

string

required

autoLang

boolean

required

bookmarks

object

required

googleServicesEnabled

boolean

required

isBookmarksSynced

boolean

required

launchArguments

string

required

lockEnabled

boolean

required

debugMode

boolean

required

navigator

object

required

Show child attributes

navigator.userAgent

string

required

The most important parameter of the browser.It decides which browser version will be used. It is not recommended to change it by yourself

Example:

"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.6998.36 Safari/537.36"

navigator.resolution

string

required

Maximum resolution of the browser, should not exceed your system maximum resolution

Example:

"1920x1080"

navigator.language

string

required

Language of the browser. If autoLang is enabled - this option will be ignored.

Example:

"en-US"

navigator.platform

enum<string>

required

It is internal browser parameter. "Win32", "MacIntel" - desktop, "Linux armv81", "Linux aarch64", "Linux armv8l", "Linux armv7l" - mobile. For mac os it is always "MacIntel" even for arm.

Available options:

Win32,

MacIntel,

Linux armv81,

Linux aarch64,

Linux x86_64,

Linux armv8l,

Linux armv7l

Example:

"Win32"

navigator.hardwareConcurrency

number

Number of processor cores of the system.

Example:

4

navigator.deviceMemory

number

Number of operating system memory in gigabytes.

Example:

4

navigator.maxTouchPoints

number

Maximum number of simultaneous touch contact points supported by the device. Its particularly relevant for touch - enabled devices like smartphones, tablets, and touchscreen laptops.

Example:

10

proxyEnabled

boolean

required

autoProxyServer

string

required

autoProxyUsername

string

required

autoProxyPassword

string

required

dns

string

required

facebookAccountData

object

Show child attributes

facebookAccountData.date

string

facebookAccountData.token

string

facebookAccountData.fbIdAccount

string

facebookAccountData.email

string

facebookAccountData.password

string

facebookAccountData.googleDriveUrl

string

facebookAccountData.fb2faToolUrl

string

facebookAccountData.fbUrl

string

facebookAccountData.uaVersion

string

facebookAccountData.cookies

string

facebookAccountData.notParsedData

string[]

canBeRunning

boolean

isM1

boolean

storage

object

Show child attributes

storage.local

boolean

default:true

If true, the browser will save local storage between sessions.

Example:

true

storage.extensions

boolean

default:true

If true, the browser will save extensions between sessions.

Example:

true

storage.bookmarks

boolean

default:true

If true, the browser will save bookmarks between sessions.

Example:

true

storage.history

boolean

default:true

If true, the browser will save history between sessions.

Example:

true

storage.passwords

boolean

default:true

If true, the browser will save passwords between sessions.

Example:

true

storage.session

boolean

default:true

If true, the browser will save session between sessions.

Example:

true

storage.indexedDb

boolean

default:false

If true, the browser will save indexedDb between sessions.

Example:

false

storage.enableExternalExtensions

boolean

default:false

If true, the browser will block external extensions that your system will try to add.

Example:

false

proxy

object

Show child attributes

proxy.mode

enum<string>

required

Proxy mode represent the protocolo of the connection to the proxy.

Available options:

http,

socks4,

socks5,

possh,

geolocation,

none,

gologin,

tor

Example:

"http"

proxy.id

string

You can specify particular proxy by its id or leave it empty to use default proxy.

Example:

"6201422450e3b9cd602f24e1"

proxy.host

string

Proxy host. It could be ip address or domain name.

Example:

"127.0.0.1"

proxy.port

number

Proxy port.

Example:

80

proxy.username

string

Proxy username.

Example:

"user"

proxy.password

string

Proxy password if proxy requires authentication.

Example:

"password"

proxy.changeIpUrl

string

This allows you to change IP address of the proxy if your proxy provider supports it.

Example:

"https://some-proxy-provider.com/change-ip"

proxy.customName

string

As proxy is separate entity in gologin, you can set custom name for it to identify it in the list of proxies.

Example:

"My Proxy"

archivedProxy

object

Show child attributes

archivedProxy.id

string

required

archivedProxy.name

string

archivedProxy.country

string

plugins

object

Show child attributes

plugins.enableVulnerable

boolean

default:true

If true, the browser will use vulnerable plugins.

plugins.enableFlash

boolean

default:true

If true, the browser will use Flash.

timezone

object

Show child attributes

timezone.enabled

boolean

default:true

If true, the browser will use the timezone of the user.

timezone.fillBasedOnIp

boolean

default:true

If true, the browser will use the timezone of the user based on their IP address or proxy IP address if proxy is enabled.

timezone.timezone

string

The timezone to use for the browser profile.

Example:

"America/New_York"

geolocation

object

Show child attributes

geolocation.mode

enum<string>

required

This setting controls how the browser handles geolocation requests from websites. Prompt will ask the user for permission to share their location, Block will block all geolocation requests, Allow will allow all geolocation requests.

Available options:

prompt,

block,

allow

geolocation.enabled

boolean

default:true

If true, the browser will use the geolocation.

geolocation.customize

boolean

default:true

If true, user can customize the geolocation.

geolocation.fillBasedOnIp

boolean

default:true

If true, the browser will use the geolocation based on the IP address.

geolocation.isCustomCoordinates

boolean

default:true

If true, the browser will use the custom coordinates.

geolocation.latitude

number

The latitude of the custom coordinates.

geolocation.longitude

number

The longitude of the custom coordinates.

geolocation.accuracy

number

The accuracy of the custom coordinates.

audioContext

object

Show child attributes

audioContext.mode

enum<string>

default:off

When set to "noise", it applies a small randomization to audio processing. When set to "off", audio fingerprinting protection is disabled.

Available options:

noise,

off

Example:

"noise"

audioContext.noise

number

A floating-point number that adds subtle variations to audio processing.

Example:

0.1

canvas

object

Show child attributes

canvas.mode

enum<string>

default:off

'block': Blocks canvas fingerprinting attempts completely 'noise': Applies a small randomization to canvas processing 'off': Disables canvas fingerprinting protection.

Available options:

block,

noise,

off

canvas.noise

number

A floating-point number that adds subtle variations to canvas processing.

Example:

0.1

fonts

object

Show child attributes

fonts.families

string[]

required

Array that tells the browser which fonts it can use.

Example:

["Arial", "Helvetica", "Verdana"]

fonts.enableMasking

boolean

default:true

A font fingerprinting protection feature that helps prevent websites from identifying users through font enumeration and detection.

Example:

true

fonts.enableDomRect

boolean

default:true

A companion setting to enableMasking that specifically protects against a technique called "DOM rect fingerprinting".

Example:

true

mediaDevices

object

Show child attributes

mediaDevices.videoInputs

number

required

Specifies the number of video capture devices (cameras) that will be reported to websites through the MediaDevices API.

Example:

1

mediaDevices.audioInputs

number

required

Specifies the number of audio capture devices (microphones) that will be reported to websites through the MediaDevices API.

Example:

1

mediaDevices.audioOutputs

number

required

Specifies the number of audio output devices (speakers, headphones, etc.) that will be reported to websites through the MediaDevices API.

Example:

1

mediaDevices.enableMasking

boolean

default:false

When enabled, this prevents websites from obtaining the actual hardware identifiers of media devices.

mediaDevices.uid

string

A unique identifier used to ensure consistent device IDs within a browser profile.

webRTC

object

Show child attributes

webRTC.mode

enum<string>

required

Sets the WebRTC operating mode from the allowed values. alerted - Allows WebRTC connections but notifies users before establishing connections. disabled - Completely turns off WebRTC functionality. real - Allows WebRTC connections and uses real IP addresses. public - Allows WebRTC connections and uses public IP addresses. fake - Allows WebRTC connections and uses fake IP addresses.

Available options:

alerted,

disabled,

real,

public,

fake

Example:

"off"

webRTC.enable

boolean

default:true

Boolean toggle that determines if WebRTC is active.

Example:

true

webRTC.isEmptyIceList

boolean

default:true

Controls whether ICE candidates are empty or not.

Example:

true

webGL

object

Show child attributes

webGL.mode

enum<string>

default:noise

Controls the WebGL rendering mode. off - Disables WebGL rendering. noise - Adds noise to the WebGL rendering.

Available options:

off,

noise

Example:

"noise"

webGL.getClientRectsNoise

number

Controls randomization of geometric calculations.

Example:

0.5

webGL.noise

number

Sets the noise level for the WebGL rendering. The value ranges from 0 to 1, where 0 is no noise and 1 is maximum noise.

Example:

0.5

webGpu

object

clientRects

object

Show child attributes

clientRects.mode

enum<string>

default:noise

Operating mode for client rects. Use "off" to disable or "noise" to add randomization.

Available options:

off,

noise

Example:

"noise"

clientRects.noise

number

Amount of noise/randomization to apply to client rects (higher values = more randomization).

Required range: x >= 0

Example:

0.5

webGLMetadata

object

Show child attributes

webGLMetadata.mode

enum<string>

default:mask

Controls the WebGL metadata mode. "mask" - Masks WebGL vendor and renderer information. "off" - Disables WebGL metadata masking.

Available options:

mask,

off

Example:

"mask"

webGLMetadata.vendor

string

The WebGL vendor string to use in the browser profile. This identifies the GPU vendor.

Example:

"Google Inc. (Intel)"

webGLMetadata.renderer

string

The WebGL renderer string to use in the browser profile. This identifies the specific GPU model and rendering API.

Example:

"ANGLE (Intel, Intel(R) HD Graphics 630 Direct3D11 vs_5_0 ps_5_0, D3D11)"

extensions

object

Show child attributes

extensions.enabled

boolean

default:true

Whether WebGL extensions are enabled for the browser profile.

Example:

true

extensions.preloadCustom

boolean

default:true

Whether to preload custom WebGL extensions.

Example:

true

extensions.names

string[]

List of WebGL extension names to be supported.

Example:

[
  "WEBGL_debug_renderer_info",
  "EXT_texture_filter_anisotropic"
]

profile

string

s3Path

string

s3Date

string

s3SignedUrl

string

createdInOs

object

devicePixelRatio

number

checkCookies

boolean

chromeExtensions

string[]

userChromeExtensions

string[]

isAutoGenerated

boolean

permissions

object

Update bookmarks for multiple profiles Update user agent of profile

⌘I

Introduction

API Reference

AI Integrations

Cloud Browser

Node.js SDK

Python SDK

Limitations

Get profile by id

Authorizations

Path Parameters

Query Parameters

Response