Get Started

BloxBan API provides access to getting, uploading, editing, and deleting bans.

To use this API, you need your console key. To get your key, go to your panel and then under dashboard -> console key.

This place is for developers who want to have more from BloxBan if you want to add BloxBan to your places, please follow this video tutorial.

Basic Information

This is subject to change
For every request sent with your console key this will add a request to your panel

Base URL: https://api.bloxban.com/place
Get Bans: /ban_list
Upload Bans: /ban_upload
Edit Bans: /ban_edit
Delete Bans: /ban_delete

Example to upload a ban https://api.bloxban.com/place/ban_upload

BASE QUERY PARAMETERS

Field	Type	Required	Description
game_id	Number	Required	This is so the API knows where to upload your bans to.
auth	String | Number	Required	This is so the API knows this transaction can be made under the game_id.
data	Array	Required	Data for the API.

Get Bans

EndPoint: /ban_list

Getting your bans is important to keep the banned users out of your game

Use case, blocking users who are banned from joining your game or searching if a user is banned.

DATA QUERY [ ARRAY ]

Field	Type	Required	Description
Roblox User ID	Number	Required	Roblox userID this is a identifier for the API.

GET BANS, ERRORS

Return	Message	Description
Error	This place isn't found	This means the game_id or auth is wrong.

Upload Bans

EndPoint: /ban_upload

This BloxBan endpoint allows developers to upload bans automatically.

Use case, when an anti-cheat needs to ban a user this endpoint would come into play or a in-game GUI.

Note if you send another request for a user who is already banned it will update that ban.

DATA QUERY [ ARRAY ]

Field	Type	Required	Description
rbx_id	Number	Required	Roblox userID this is a identifier for the API.
ban_reason	String | Number	Optional	This will add a ban reason, this is also shown to the user who is banned.
ban_time	Number	Required	This must be in Unix, BUT you can also return 0 and 1, 0 being Todays date | 1 being Permanent ban
ban_note	String | Number	Optional	This will add a ban note to the users ban.

UPLOAD BANS, ERRORS

Return	Message	Description
Error	console locked	This means the console is locked and must be paid for to use this endpoint.
Error	Roblox ID cannot be found	This means the Roblox ID given cannot be found.
Error	rbx_id or ban_time was not found	This means the query hasn't got rbx_id or ban_time.
Error	Place not found	This means the game_id given isn't stored on BloxBan possible you haven't add your place to BloxBan.

Edit Bans

Coming Soon.

Delete Bans

Coming Soon.