Background ab26d25a9077a79c7de7881a8f284f40799d44fb85129c9d6ef662d60099e277

API Documentation

API Documentation


By using our the StarboundServers.org API you can ask us for specific data in an automated fashion.

API Endpoints

Checking wether someone has voted or not is an extremely handy feature. It can for example be used in vote verification plugins so you can reward your players after they have voted.
GEThttp://starboundservers.org/api/votes/check/YOUR_SERVER_API_KEY_HERE/USERNAME_OF_VOTER/
ParameterDescriptionData Type
keyYour Server API KeyString
usernameVoter's usernameString

ResponseDescription
{ "voted" : false, "claimed" : false }Not found
{ "voted" : true, "claimed" : false }Has voted and not claimed
{ "voted" : true, "claimed" : true }Has voted and claimed
This feature allows you to set someone's voted as claimed, this way they cannot claim the same reward twice.
POST http://starboundservers.org/api/votes/claim/YOUR_API_KEY_HERE/USERNAME_OF_VOTER/
ParameterDescriptionData Type
keyYour Server API KeyString
usernameVoter's usernameString

ResponseDescription
{ "voted" : false, "claimed" : false }We were unable to locate the user's vote based on the information provided.
{ "voted" : true, "claimed" : true }This vote has been marked as claimed