Custom and Snipes State

get
Get Custom Games State

https://yunite.xyz/api/v1/servers/:GUILD_ID/customs/state2
This endpoint allows you to get the information displayed in the tracking embed while a custom game is running.
Request
Response
Request
Path Parameters
GUILD_ID
required
string
ID of the target guild.
Headers
Y-Api-Key
required
string
The API-Key corresponding to the guild you want to query.
Response
200: OK
Cake successfully retrieved.
{
"usersSignedUp":1, //how many users clicked the hand emoji
"dispatchedToParties":1, //in how many parties Yunite dropped the code
"dispatchedToUsers":1, //how many users were in these parties (sum)
"finished":true, //whether the process is finished (not the match!)
"running":false, //whether the process is running (not the match!)
"dispatched":true, //whether someone clicked the dispatch button
"sessionID":"80f424073a6b4312ae10029dde854868", //session ID of the match, may be null if the match has not yet started
"parties":[ //list of all parties Yunite is live tracking; may fill up over time when match starts
{
"partyID":"44b27853f8874ac1970fbe95ef65004d",
"players":[
{
"discordID":"386953515873992707",
"epicID":"6ff3b49520204d578a48d6eda2a0d9c6",
"ingame":true,
"kills":0
}
]
}
]
}

get
Get Snipe State

https://yunite.xyz/api/v1/servers/:GUILD_ID/snipes/state
Returns the state of all currently ongoing snipe sessions on the server.
Request
Response
Request
Path Parameters
GUILD_ID
required
string
ID of the target guild.
Headers
Y-Api-Key
required
string
The API-Key corresponding to the guild you want to query.
Response
200: OK
[
{
"startedAt":"2019-08-26T13:16:01.895674Z",
"mode":"SOLO",
"playerListFinished":false, //true if no new last3 can be added by users (120 seconds after countdown, usually)
"sessions":[ //list of sessions
{
"last3":"2ab", //last3 of session ID
"players":[ //discord IDs of players
"386953515873992707",
"286953515873992902"
]
}
]
}
]