search
HomepageCommunityDashboard

square-codeRoblox Developer Packages

Easy-to-integrate modules for your Roblox game, built on the Ranking API

hashtag
BloxTech API Client

This package contains the core fundamentals to interact with the Ranking API, featuring auto-retries, a request queue, Promises and type-safety ✨

To install this package, follow these steps:

1

hashtag
Generate a BloxTech API Key

Follow the steps in Ranking API to generate an API key, then continue with this guide.

2

hashtag
Get the module

Go to this linkarrow-up-right on the Creator Hub, and press the blue Get Model button.

3

hashtag
Enter Roblox Studio

Find your game in Roblox Studio, open the place and make sure the Explorer, Toolbox and Properties windows are visible. You can find these under the View tab.

4

hashtag
Insert the BloxTech API

In the Toolbox window, navigate to the second tab and click on BloxTech Ranking API.

5

hashtag
Drag the Script to ServerStorage

Click and drag the BloxTechAPI script to ServerStorage.

6

hashtag
Insert your API key

Click on the BloxTechAPI script, and in the Properties window, paste the API key you generated earlier in the ApiKey field.

7

hashtag
🎉 You did it!

Now that BloxTech's API is installed, you can use it in your other Scripts.

To do this, add the following two lines at the top of your Script:

local BloxTech = require(game.ServerStorage.BloxTechAPI)
local BloxTechClient = BloxTech.new()

Now you can interact with BloxTechClient directly to manage your group members:

hashtag
Update member rank

BloxTechClient:setRank(8460964972, 1)
    :andThen(function(response)
        -- Runs when the rank has been updated successfully
        print("Success", response)
    end)
    :catch(function(response)
        -- Runs when the rank couldn't be updated
        -- eg. because they already have this rank
        warn("Error", response)
    end)

hashtag
Accept Join Request

BloxTechClient:acceptJoinRequest(8460964972)
    :andThen(function(response)
        -- Runs when the join request has been accepted successfully
        print("Success", response)
    end)
    :catch(function(response)
        -- Runs when the request couldn't be accepted
        -- eg. because they haven't sent any request yet
        warn("Error", response)
    end)

hashtag
Reject Join Request

BloxTechClient:rejectJoinRequest(8460964972)
    :andThen(function(response)
        -- Runs when the join request has been rejected successfully
        print("Success", response)
    end)
    :catch(function(response)
        -- Runs when the request couldn't be rejected
        -- eg. because they haven't sent any request yet
        warn("Error", response)
    end)
PreviousHandle Join RequestNextExample: Promotion commands

Last updated

Was this helpful?