Skip to main content

pygologin - GoLogin Python SDK

This package provides functionality to run and stop GoLogin profiles with python and then connect the profiles to automation tools like Selenium, Puppetteer, Playwright etc.

Getting Started

Before you can make requests to the GoLogin API, you will need to grab your API key from your dashboard. You find it here https://app.gologin.com/personalArea/TokenApi.

Installation

pip3 install gologin

or clone this repository

git clone https://github.com/gologinapp/pygologin.git

for running gologin-selenium.py install selenium

pip install selenium

for Selenium need download webdriver

Usage

Where is token? API token is here. To have an access to the page below you need register GoLogin account.

Token API in Settings

!!! Attention !!! If your selenium version is greater than or equal to 4.11, then you should use the "gologin-selenium_4.11.py" script, otherwise use "gologin-selenium.py" script

Example "gologin-selenium.py"

import time
from sys import platform
from selenium import webdriver
from selenium.webdriver.chrome.options import Options
from gologin import GoLogin
from gologin import getRandomPort

# random_port = get_random_port() # uncomment to use random port

gl = GoLogin({
	"token": "yU0token",
	"profile_id": "yU0Pr0f1leiD",
	# "port": random_port
	})

if platform == "linux" or platform == "linux2":
	chrome_driver_path = "./chromedriver"
elif platform == "darwin":
	chrome_driver_path = "./mac/chromedriver"
elif platform == "win32":
	chrome_driver_path = "chromedriver.exe"

debugger_address = gl.start()
chrome_options = Options()
chrome_options.add_experimental_option("debuggerAddress", debugger_address)
driver = webdriver.Chrome(executable_path=chrome_driver_path, options=chrome_options)
driver.get("http://www.python.org")
assert "Python" in driver.title
driver.close()
time.sleep(3)
gl.stop()

Running example:

python gologin-selenium.py

Methods

constructor

  • options <[Object]> Options for profile
    • autoUpdateBrowser <[boolean]> do not ask whether download new browser version (default false)
    • token <[string]> your API token
    • profile_id <[string]> profile ID
    • executablePath <[string]> path to executable Orbita file. Orbita will be downloaded automatically if not specified.
    • remote_debugging_port <[int]> port for remote debugging
    • vncPort <[integer]> port of VNC server if you using it
    • tmpdir <[string]> path to temporary directore for saving profiles
    • extra_params arrayof <[string]> extra params for browser orbita (ex. extentions etc.)
    • uploadCookiesToServer <[boolean]> upload cookies to server after profile stopping (default false)
    • writeCookesFromServer <[boolean]> download cookies from server and write to profile cookies file (default true)
    • port <[integer]> Orbita start port (uncomment out the lines with "random port" and "port" in gologin-selenium.py to select a random launch port)
gl = GoLogin({
	"token": "yU0token",
	"profile_id": "yU0Pr0f1leiD",
	})

Example create profile

python gologin-create-profile.py

from gologin import GoLogin


gl = GoLogin({
	"token": "yU0token",
	})

profile_id = gl.create({
    "name": 'profile_mac',
    "os": 'mac',
    "navigator": {
        "language": 'en-US',
        "userAgent": 'random', # Your userAgent (if you don't want to change, leave it at 'random')
        "resolution": '1024x768', # Your resolution (if you want a random resolution - set it to 'random')
        "platform": 'mac',
    },
    'proxyEnabled': True, # Specify 'false' if not using proxy
    'proxy': {
        'mode': 'gologin',
        'autoProxyRegion': 'us' 
        # 'host': '',
        # 'port': '',
        # 'username': '',
        # 'password': '',
    },
    "webRTC": {
        "mode": "alerted",
        "enabled": True,
    },
});

print('profile id=', profile_id);

# gl.update({
#     "id": 'yU0Pr0f1leiD',
#     "name": 'profile_mac2',
# });

profile = gl.getProfile(profile_id);

print('new profile name=', profile.get("name"));

# gl.delete('yU0Pr0f1leiD')

start()

start browser with profile id

stop()

stop browser with profile id

Full GoLogin API

Swagger: link here

Postman: link here

Metadata

Release files for gologin 2025.4.10135747

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gologin 2025.4.10135747
File Size Uploaded
gologin-2025.4.10135747.tar.gz 19.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gologin 2025.4.10135747
File Interpreter ABI Platform
gologin-2025.4.10135747-py3-none-any.whl Python 3 none any Details

Total release size: 40.9 kB

Release files / gologin-2025.4.10135747.tar.gz

Download URL gologin-2025.4.10135747.tar.gz
Size 19.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3b7caad2c387872edce5b80dbdad07e0a9fd7ac09d649c1c4d6c66c631cf815a
BLAKE2b-256 checksum
How to use checksums
a7eadf4783f1bf3f84c9cc737e7351d4a2979a7273dcb7fdb2a9ff81c95f3bfb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.0

Release files / gologin-2025.4.10135747-py3-none-any.whl

Download URL gologin-2025.4.10135747-py3-none-any.whl
Size 21.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
084726166b82cf133fdd0f679879ffab8406a39227d0dbe0cfe278c51341096c
BLAKE2b-256 checksum
How to use checksums
af8647cacd0a5a1caedec438f5a4c72a7de0b2eefe9968527c57cea89b4d1de7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.0

Release history Release notifications | RSS feed

This release

2025.4.10135747 This release

2 release files

2.0.1

2 release files

0.1.1

2 release files

0.1

3 release files

0.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page