@bluezly/roquick-api
v0.0.1-beta
Published
Official RoQuick API wrapper for Roblox group management with advanced features
Maintainers
Readme
RoQuick API
RoQuick API is a Node.js library for Roblox group management. It provides tools to fetch user/group info, manage roles, handle join requests, and access premium features via subscription.
🚀 Features
✅ Current Features
- Fetch User & Group Information
- Get detailed info about Roblox users and groups.
- Supports lookup by user ID.
- Role Management
- Set roles for a single user or bulk update.
- Supports both rank number and role name.
- Supports user IDs only.
- Join Requests Handling
- Accept or decline join requests individually or in bulk.
- Group Filtering
- Filter members by rank, role name, or other criteria.
- API Key & Subscription Status
- Check active subscription, requests per minute, and blacklisting.
- Premium Features
- Operations require an active subscription.
⚡ Requirements
- Node.js v18 or higher
- A valid RoQuick API key (obtainable via Discord)
🟢 Installation
npm install @bluezly/roquick-api🛠 Usage
Initialize RoQuick
const RoQuick = require('@bluezly/roquick-api');
const client = new RoQuick({
apiKey: 'YOUR_API_KEY_HERE'
});Fetch User Info
const userInfo = await client.getUserInfo('userId');
console.log(userInfo);Fetch Group Info
const groupInfo = await client.getGroupInfo(123456);
console.log(groupInfo);Role Management
Set Role for a Single User
await client.setUserRole(123456, 'userId', { rank: 5 });
await client.setUserRole(123456, 'userId', { roleName: 'Admin' });Bulk Role Update
await client.bulkSetUserRole(
123456,
['192179263', '5491804225', '987654'], // IDs
{ roleName: 'Moderator' }
);✅ Supports usernames in future updates.
Join Request Handling
Fetch Join Requests
const requests = await client.getJoinRequests(123456, { limit: 20 });
console.log(requests);Accept / Decline Single Request
await client.acceptJoinRequest(123456, 'userId');
await client.declineJoinRequest(123456, 'userId');Bulk Accept / Decline Requests
await client.bulkJoinRequestAction(123456, ['userid', 'userid'], 'accept');
await client.bulkJoinRequestAction(123456, ['userid', 'userid'], 'decline');Check API Key Status
const status = await client.getApiKeyStatus();
console.log(status);⚠️ Notes
- Rate limits exist; exceeding them returns HTTP 429. Future versions will handle retries automatically.
- Premium subscription is required for certain features.
- Role updates support user IDs only.
- Join our Discord for support, API key, and examples.
- Some features are marked as Upcoming and will be released in future updates.
📄 License
MIT License
