RoRelay API

Getting a key

Open the dashboard, pick your community and go to Developers → Make a key. The key is shown once, so copy it somewhere safe. A key only works for its own server's members: the same people an admin could look up with /getinfo and /reversesearch.

Making requests

Send the key in the Authorization header. Every endpoint starts with https://rorelay.link/api/v1/guilds/<serverId>, where the server ID is the number in your dashboard link.

curl -H "Authorization: rr_yourkey" https://rorelay.link/api/v1/guilds/<serverId>/roblox/1849302211

Each key can make 60 requests a minute, of which 20 can be updates. Going over returns 429 with retryAfter in seconds. Errors look like {"error": "not_in_server", "message": "…"}.

Endpoints

GET /fluxer/<fluxerUserId>

Which Roblox account a member uses in your server.

{"fluxerId": "1557…", "linked": true,
 "roblox": {"robloxId": 1849302211, "username": "CoolBuilder_42", "displayName": "Cool"}}

GET /roblox/<robloxUserId>

Which members of your server linked a Roblox account.

{"robloxId": 1849302211, "fluxerIds": ["1557…"]}

POST /fluxer/<fluxerUserId>/update

Refresh one member's roles and nickname now.

{"fluxerId": "1557…", "linked": true, "roblox": {…},
 "added": ["role id"], "removed": [], "nickname": null,
 "bypassed": false, "blocked": null, "kicked": false, "errors": []}

POST /roblox/<robloxUserId>/update

Refresh every member linked to a Roblox account (up to 5), e.g. after a promotion in your game.

{"robloxId": 1849302211, "updated": [ …same as above… ]}

Roblox module

Download RoRelay.lua, make a ModuleScript called RoRelay in ServerScriptService and paste it in. Fill in your server ID and key at the top, and turn on Game Settings → Security → Allow HTTP Requests. Only use it from server scripts, so players can never see your key.

local RoRelay = require(game.ServerScriptService.RoRelay)

game.Players.PlayerAdded:Connect(function(player)
    if RoRelay.IsLinked(player.UserId) then
        print(player.Name .. " is verified in our Fluxer community")
    end
end)

-- after promoting someone in your group:
RoRelay.UpdateRoles(player.UserId)

It also has RoRelay.GetFluxerIds(robloxUserId) and RoRelay.GetRobloxAccount(fluxerUserId). Every function returns nil and an error message if something goes wrong.

Rules

Use the API only for your own community, keep keys secret, and follow our Terms. Revoke a key on the dashboard straight away if it leaks.