API Documentation

This API allows you to interact with our server data programmatically. Below you will find a comprehensive guide to all the endpoints available.

Endpoints

Get Server Votes

Retrieve all votes for a specific server.

GET /api/v1/server/{api_key}/votes

Parameters:

  • api_key: Your server's unique API key.

Claim Steam Vote

Claim all votes made through Steam. Will return the number of votes claimed : 'claimed_votes_count'

POST /api/v1/server/{api_key}/votes/claim/steam/{steamId}

Parameters:

  • api_key: Your server's unique API key.
  • steamId: The Steam ID of the user claiming the vote.

Claim Discord Vote

Claim all vote made through Discord. Will return the number of votes claimed : 'claimed_votes_count'

POST /api/v1/server/{api_key}/votes/claim/discord/{discordId}

Parameters:

  • api_key: Your server's unique API key.
  • discordId: The Discord ID of the user claiming the vote.

Get Votes for Current Month

Retrieve all votes for the current month for a specific server.

GET /api/v1/server/{api_key}/votes/month_current

Parameters:

  • api_key: Your server's unique API key: Your server's unique API key.

Get Votes for Previous Month

Retrieve all votes for the previous month for a specific server.

GET /api/v1/server/{api_key}/votes/month_previous

Parameters:

  • api_key: Your server's unique API key.