API Documentation
API options
To check if a Username has voted or not, and if the vote has been claimed or not. This can be used for a reward plugin. The API will only check for the last 24 hours.
Parameter | Description | Data Type | Required |
---|---|---|---|
key | Your Server API Key | String | Yes |
username | Username of the vote | String (Case insensitive) | Yes |
Response | Description |
---|---|
0 | Not found |
1 | Has voted and not claimed |
2 | Has voted and claimed |
To set a vote as claimed for a Username. This can be used for a reward plugin. The API will only set vote as claimed in the last 24 hours.
Parameter | Description | Data Type | Required |
---|---|---|---|
key | Your Server API Key | String | Yes |
username | Username of the vote | String (Case insensitive) | Yes |
Response | Description |
---|---|
0 | Vote has not been claimed |
1 | Vote has been claimed |
To get the list of voters for your server. Limited to the top 500 results.
Output is cached for 3 minutes.
Parameter | Value | Description | Data Type | Required |
---|---|---|---|---|
key | xxxxxxxx | Your Server API Key | String | Yes |
month | current | previous | Period to get | String | Yes |
format | json | html | Format of the response | String | Yes |
limit | xxx | Result limit. Max value is 500. Default value is 100. | Integer | No |
To get the list of votes for your server. Limited to the last 500 results.
Output is cached for 3 minutes.
Parameter | Value | Description | Data Type | Required |
---|---|---|---|---|
key | xxxxxxxx | Your Server API Key | String | Yes |
format | json | html | Format of the response | String | Yes |
limit | xxx | Result limit. Max value is 500. Default value is 100. | Integer | No |
To get the full detail of your server in json format. Can be used to create your own status page for example.
Output is cached for 3 minutes.
Parameter | Value | Description | Data Type | Required |
---|---|---|---|---|
key | xxxxxxxx | Your Server API Key | String | Yes |
Plugin(s) / Service(s) Using Our API
Minecraft-Schematics.com
"Minecraft Schematics" is the best place to find Minecraft creations to download. Browse, share, download, comment, add to favorites...