robase logorobase

Documentation

Complete guide to using robase for Roblox API integration.

Installation

Install robase using pip. The library requires Python 3.8 or higher.

Terminal
 

Basic Usage

The synchronous client is the simplest way to get started. Create a client instance and start making API calls immediately.

example.py
 

Async Client

For high-throughput applications, use the async client with Python's asyncio.

async_example.py
 

Database Persistence

The built-in SQLite database provides persistent storage for users, games, and custom key-value data.

database_example.py
 

Core Concepts

SessionDatabase

SQLite storage with 4 tables: users, games, sessions (key-value), and log. Zero config, instant persistence.

TTLCache

Thread-safe TTL + LRU cache for GET requests. Reduces rate limits and improves performance.

TokenBucket

Built-in token bucket throttling prevents 429 errors and protects against hitting rate limits.

Open Cloud

RobaseCloudClient wraps Roblox Open Cloud APIs: DataStores, Ordered DataStores, and MessagingService.

Available Sub-APIs

The client provides access to 16+ specialized sub-APIs:

users
games
catalog
groups
friends
thumbnails
badges
economy
presence
avatar
trades
messages
chat
inventory
develop
events