All endpoints

All available endpoints on Hyra Ranking

post
Create a token
https://ranking.hyra.io/token
Create a Hyra Ranking token
Request
Response
Request
Headers
content-type
required
string
text/json
Body Parameters
cookie
required
string
The .ROBLOSECURITY cookie
groupId
required
integer
The ID of the Group
Response
200: OK
{ 
    "success": true, 
    "token": "XXXXXXXXXXXXXXXXXXXXXXX", 
    "username": "Roblox", 
    "id": 1
}
put
Spin token
https://ranking.hyra.io/spin
Roll the token, and regenerate a new one
Request
Response
Request
Headers
content-type
required
string
text/json
Body Parameters
token
required
string
The Hyra Ranking token
Response
200: OK
{
    "success": true,
    "token": "XXXXXXXXXXXXXXXX"
}
delete
Delete token
https://ranking.hyra.io/token/{token}
Delete supplied token from system, invalidating it entirely
Request
Response
Request
Path Parameters
token
required
string
The Hyra Ranking token
Response
200: OK
{
    "success": true
}
post
Rank User
https://ranking.hyra.io/rank
Rank a user to the specified rank in the specified group
Request
Response
Request
Headers
content-type
required
string
text/json
Body Parameters
token
required
string
The Hyra Ranking token
rankNumber
required
integer
The rank in the group which user should be ranked to (1-253 supported)
targetId
required
integer
The Roblox Player ID of the user you are ranking
groupId
required
integer
The group ID of where you are promoting the user
Response
200: OK
{
  "Success": true,
  "Message": "Successfully changed rank of user"
}
post
Message User
https://ranking.hyra.io/message
Message specified Roblox User
Request
Response
Request
Headers
content-type
required
string
text/json
Body Parameters
token
required
string
The Hyra Ranking token
subject
required
string
The subject of the message
message
required
string
The contents of the message
targetId
required
integer
The Roblox Player Id of the user you are messaging
Response
200: OK
{
    "Success": true,
    "Message": "Successfully messaged user",
}
get
Get token usage & information
https://ranking.hyra.io/token/{token}
Gets usage and information about the specified token
Request
Response
Request
Path Parameters
token
required
string
The Hyra Ranking token
Response
200: OK
{
    "success": true,
    "created": {
        "_nanoseconds": 966000000
        "_seconds": 1606651106
    },
    "groupId": 1,
    "paid": false,
    "usage": 0
}
get
Retrieve logs
https://ranking.hyra.io/logs/{token}
Will return an array of logs, sorted by date of log, descending.Supports optional cursor query to index the pages.Returns maximum of 20 logs per page.
Request
Response
Request
Path Parameters
token
required
string
The Hyra Ranking token
Query Parameters
index
optional
string
The ID of the index in logs to startAfter. Typically the last index on the first query.
Response
200: OK
{
    "success": true,
    "data": [{
        "id": "XXXXXXXXXXXXXXXXXXX",
        "data": {
            "country": "US",
            "date": {
                "_nanoseconds": 995000000
                "_seconds": 1607018400
            },
            "groupId": 1,
            "ip": 1.1.1.1,
            "rankId": 250,
            "ray": "5fbf2f4569837171-ORD",
            "type": "Hyra Browser",
            "user": "1"
        }
    }],
    "length": 1,
}