Documentation

Everything you need to get started with roboat.

Package details, installation guide, and what makes roboat compelling for Roblox development.

Package details

Project details

Package: roboat

Language: Python 3.8+

Installation: pip install roboat

Features: Interactive terminal, programmatic client, async support, built-in SQLite database

Best for: Roblox bots, dashboards, group tools, catalog systems, trading workflows, and automation services.

API coverage: Users, games, catalog, groups, friends, presence, thumbnails, economy, badges, avatar

License: MIT

Why it stands out

What makes roboat compelling

It matches real Roblox product patterns: fetch live data, store it, compare it, automate on it, and expose it through tooling.

It reduces custom plumbing: one reusable client is far cleaner than scattered scripts for auth, trades, economy, groups, and user identity.

Built-in database layer: the included SQLite database handles caching users, games, key-value storage, and command history out of the box.

Interactive terminal included: explore the Roblox API from the command line without writing any code using the built-in REPL.

PyPI packageMIT LicenseOpen Source
Quick start

Get started in seconds.

Installation

pip install roboat

Basic usage

from roboat import RoboatClient

client = RoboatClient()
user = client.users.get_by_id(156)
print(user.username)

Authenticated client (OAuth)

from roboat import RoboatClient
from roboat.auth import OAuthManager

oauth = OAuthManager(client_id="your-client-id")
oauth.open_browser()  # Opens OAuth flow
client = RoboatClient(oauth=oauth)
me = client.users.get_authenticated_user()
print(f"Logged in as {me.username}")

Interactive terminal

# Launch the interactive REPL
python -m roboat

# Or run the roboat command
roboat