roboat
A high performance interface for the Roblox API.
This library is designed to be high-performance capable, meaning that it supports proxies and is capable of making requests in parallel.
Note that this crate is currently economy-focused, meaning that endpoints related to items and trades are currently prioritized.
Documentation
Extensive documentation is used throughout this crate. All public methods in this crate are documented and have at least one corresponding example.
Documentation can be found here.
Coverage
- Auth API - [
auth.roblox.com/*
]- Force Refresh X-CSRF-TOKEN -
Client::force_refresh_xcsrf_token
- Force Refresh X-CSRF-TOKEN -
- BEDEV2 API - [
apis.roblox.com/*
]- Fetch Non-Tradable Limited Details -
Client::non_tradable_limited_details
- Fetch Collectible Product ID -
Client::collectible_product_id
- Fetch Collectible Product ID Bulk -
Client::collectible_product_id_bulk
- Fetch Collectible Creator ID -
Client::collectible_creator_id
- Purchase Non-Tradable Limited -
Client::purchase_non_tradable_limited
- Fetch Non-Tradable Limited Details -
- Catalog API - [
catalog.roblox.com/*
]- Fetch Item Details -
Client::item_details
- Fetch Product ID -
Client::product_id
- Fetch Product ID Bulk -
Client::product_id_bulk
- Fetch Collectible Item ID -
Client::collectible_item_id
- Fetch Collectible Item ID Bulk -
Client::collectible_item_id_bulk
- Fetch Item Details -
- Economy API - [
economy.roblox.com/*
]- Fetch Robux Balance -
Client::robux
- Fetch Resellers -
Client::resellers
- Fetch User Sales -
Client::user_sales
- Put Limited On Sale -
Client::put_limited_on_sale
- Take Limited Off Sale -
Client::take_limited_off_sale
- Purchase Tradable Limited -
Client::purchase_tradable_limited
- Fetch Robux Balance -
- Group API - [
groups.roblox.com/*
]- Fetch Group Roles -
Client::group_roles
- Fetch Group Role Members -
Client::group_role_members
- Set Group Member Role -
Client::set_group_member_role
- Fetch Group Roles -
- Presence API - [
presence.roblox.com/*
]- Register Presence -
Client::register_presence
- Register Presence -
- Trades API - [
trades.roblox.com/*
]- Fetch Trades List -
Client::trades
- Fetch Trades List -
- Users API - [
users.roblox.com/*
]- Fetch User ID -
Client::user_id
- Fetch Username -
Client::username
- Fetch Display Name -
Client::display_name
- User Search -
Client::user_search
- Fetch User ID -
Setup
You can add the latest version of roboat to your project by running:
Alternatively, you can add a specific version of roboat to your project by adding the crate to your Cargo.toml
:
[]
= "0.19.0"
Quick Start Examples
Example 1 - Purchase Free UGC Limited
This code snippet allows you to purchase a free ugc limited.
It can be modified to purchase a non-free ugc limited by changing the price.
// Replace this value with your own roblosecurity token.
const ROBLOSECURITY: &str = "your-roblosecurity-token";
// Replace this value with the item id of the item you want to purchase.
const ITEM_ID: u64 = 13119979433;
// Replace this value if you want to purchase a non-free item.
const PRICE: u64 = 0;
async
Example 2 - Fetch User Info
This code snippet allows you to get your current robux, id, username, and display name.
// Replace this value with your own roblosecurity token.
const ROBLOSECURITY: &str = "your-roblosecurity-token";
async
Example 3 - Fetch Price of Tradable Limited
This code snippet allows you to view the lowest price of a tradable limited item by fetching a list of reseller listings.
// Replace this value with your own roblosecurity token.
const ROBLOSECURITY: &str = "your-roblosecurity-token";
async
Example 4 - Fetch Item Details
This code snippet allows you to get the details of an item.
use ;
async
More Examples
More examples can be found in the examples directory.
Related Crates
This crate is a sister crate of roli, an API wrapper for Rolimons.com.
Contributing
Pull requests and issues are welcome!
Please refer to CONVENTIONS.md for information on conventions used in this crate.
Additional resources used to help make this crate are available in RESOURCES.md.
License
MIT License