RoWifi API

RoWifi’s API is based around a HTTPS/REST API for all operations.

Base URL

RoWifi has different versions of its API. You need to specify which version of the API you would like to use in your request path like https://api.rowifi.xyz/v{version}.

API Versions

VersionStatus
2Active
1Deprecated

Authentication

Authenticating with the RoWifi API can be done only using the API tokens obtained from the Tokens page of the Dashboard. Authentication is performed with the Authorization HTTP header in the format Authorization: Bot TOKEN

Rate Limiting

All endpoints currently follow the 5 per second per IP/token rule. This may change in the future and an announcement will be made as such.

Routes

Get Member

GET /guilds/{guild.id}/members/{user.id}

Returns the associated RoUser for a server with the following fields.

FieldDescription
discord_idThe Discord ID of the user
roblox_idID of the linked Roblox account for the given guild_id
guild_idThe ID of the guild

GET /guilds/{guild.id}/members/roblox/{roblox_id}

Returns an array of discord_id linked to that particular Roblox account for the given guild_id.

NOTE: This endpoint will only return the set of Discord IDs from which Reverse Search consent has given. Reverse Search Consent can be given with /api consent reverse-search.

Get Blacklists

GET /guilds/{guild.id}/blacklists

Returns an array of blacklists for the given guild. Each blacklist has the following fields.

FieldDescription
blacklist_idThe internal ID for the blacklist
reasonThe reason set for the blacklist
kindThe type of the blacklist (0 - User, 1 - Group)
user_id?The ID of the Roblox User in the blacklist. Present only when kind = 0
group_id?The ID of the Roblox Group in the blacklist. Present only when kind = 1

*Currently doesn’t return the custom blacklists.

Create Blacklist

POST /guilds/{guild.id}/blacklists

Creates a blacklist for the given guild. The following fields are required.

FieldDescription
reasonThe reason set for the blacklist
kindThe type of the blacklist (0 - User, 1 - Group)
user_id?The ID of the Roblox User in the blacklist. Must be present only when kind = 0
group_id?The ID of the Roblox Group in the blacklist. Must be present only when kind = 1

Delete Blacklist

DELETE /guilds/{guild.id}/blacklists

Deletes blacklists from the given guild. It requires an array of blacklist_id in the body (blacklist_id can be obtained from the Get Blacklists endpoint).