RoShield API Documentation

Welcome to the official API Documentation of RoShield.

Terms and Privacy Policy

By using the RoShield API, you acknowledge that you have read and agreed to our Privacy Policy and Terms of Service.

FAQ

Q1: How do I get an API key?

A1: To get an API key, please visit the RoShield Support page and open a ticket under the "RoShield" category.

Check if a Roblox User is Verified

GET https://api.roshield.net/beta/public/is-verified/:roblox_id

This endpoint checks whether a Roblox user is verified and registered with a Discord account.

Success Response:

{
    "status": "success",
    "message": "Verified user.",
    "verified": true
}

JavaScript Example:

fetch('https://api.roshield.net/beta/public/is-verified/123456789', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Check if a Roblox User is Flagged

GET https://api.roshield.net/beta/public/is-flagged/:roblox_id

This endpoint checks whether a Roblox user has any flags or notes registered in the system.

Success Response:

{
    "status": "success",
    "message": "User found.",
    "flags": ["High-risk user.", "Exploiting."]
}

Not Found Response:

{
    "status": "success",
    "message": "No flags registered for this user."
}

JavaScript Example:

fetch('https://api.roshield.net/beta/public/is-flagged/123456789', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Check if a User is a Server Booster

GET https://api.roshield.net/beta/public/is-booster/:server-id/:user-id

This endpoint checks if a user is a server booster on Discord based on their premium status.

Success Response:

{
    "status": "success", 
    "is_booster": true,
    "premium_since": "2025-01-09T12:34:56"
}

Not Found Response:

{
    "status": "error",
    "message": "User not found in server"
}

JavaScript Example:

fetch('https://api.roshield.net/beta/public/is-booster/1191892647976120390/1234', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Get Roblox ID for a Discord User

GET https://api.roshield.net/beta/public/discord-to-roblox/:discord_id

This endpoint retrieves the Roblox user ID associated with a given Discord user ID.

Success Response:

{
    "status": "success",
    "message": "User found.",
    "roblox_id": "123456789"
}

JavaScript Example:

fetch('https://api.roshield.net/beta/public/discord-to-roblox/1312442314001481861', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Get Discord ID for a Roblox User

GET Privileged https://api.roshield.net/beta/public/roblox-to-discord/:roblox_id

This endpoint retrieves the Discord user ID(s) associated with a given Roblox user ID.

Success Response:

{
    "status": "success",
    "message": "User found.",
    "discord_ids": ["1312442314001481861", "1189225868271304774"]
}

Note: Ensure that you have a valid API key with appropriate access privileges to use this endpoint.

JavaScript Example:

fetch('https://api.roshield.net/beta/public/roblox-to-discord/123456789', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Webhook API

POST https://api.roshield.net/beta/public/webhooks/:webhookname

This endpoint allows you to send messages to a specific webhook for a Roblox group. You must provide an API key and the name of the webhook to send a message. This can be used to notify group owners or perform other webhook-related tasks.

Success Response:

{
    "status": "success",
    "message": "Webhook posted."
}

JavaScript Example:

fetch('https://api.roshield.net/beta/public/webhooks/myWebhook', {
    method: 'POST',
    headers: {
        'Authorization': 'your-api-key',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        message: 'This is a test message to the webhook!'
    })
})
.then(response => response.json())
.then(data => console.log(data));