Get Started
Get your API key
Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.
You can generate an API key from our Dashboard (SOON!) or by doing /apikey
Make your first request
Check a user's blacklisted status
GET
https://api.blacklister.xyz/<userid>
Headers
Name
Type
Description
Authorization*
Your API key
If the user is not blacklisted, it will return data in the following format:
{
"blacklisted": false
}
If the user is blacklisted, it will return data in the following format:
{
"blacklisted": true,
"reason": "Reason for the blacklist",
"moderator": "The moderator who blacklisted the user",
"date": "The date of the Blacklist (DD/MM/YYYY format)",
"evidence": "URL to the evidence"
}
Take a look at how you might call this method using Axios
or Requests
const axios = require("axios")
await axios.get(`https://api.blacklister.xyz/USERID`, {
"headers": { "Authorization":"API key" }
})
.then(async function (response) {
if (response.data.blacklisted) {
// User is blacklisted!
}
else {
// User is not blacklisted!
}
})
Last updated