API docs by Redocly

GmodListing (1.0)

Download OpenAPI specification:Download

Server

/api/v1/server/me

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/server/{id}

Authorizations:
ApiKey
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ipAddress": "string",
  • "port": 0,
  • "description": "string",
  • "discordLinkUrl": "string",
  • "steamGroupLinkUrl": "string",
  • "websiteUrl": "string",
  • "language": 0,
  • "players": 0,
  • "maxPlayers": 0,
  • "gamemode": "string",
  • "map": "string",
  • "lastChecked": "2019-08-24T14:15:22Z",
  • "verified": true,
  • "status": true,
  • "votes": 0,
  • "totalVotes": 0,
  • "name": "string",
  • "disabled": true,
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "rank": 0,
  • "tags": [
    ],
  • "disabledById": "string",
  • "ownerId": "string",
  • "isSponsored": true,
  • "sponsoredEnd": "2019-08-24T14:15:22Z",
  • "serverHost": "string"
}

Vote

/api/v1/vote/{serverId}/chart

Authorizations:
ApiKey
path Parameters
serverId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "serverId": "10d2345a-e43d-463d-830e-4f5b19b60d41",
  • "data": [
    ]
}

Return if userid has voted for server id within the last 24hours ** SEVRER MUST BE VERIFIED **

Authorizations:
ApiKey
path Parameters
serverId
required
string <uuid>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "discordId": "string",
  • "steamId": "string",
  • "isClaimed": true,
  • "serverId": "10d2345a-e43d-463d-830e-4f5b19b60d41"
}

Check if a player has voted by their steamid64 and server id within the last 24 hours ** SEVRER MUST BE VERIFIED **

Authorizations:
ApiKey
path Parameters
serverId
required
string <uuid>
steamId64
required
string

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "discordId": "string",
  • "steamId": "string",
  • "isClaimed": true,
  • "serverId": "10d2345a-e43d-463d-830e-4f5b19b60d41"
}

sets a vote to claim in the last 24 hours matching the server id and user id ** SEVRER MUST BE VERIFIED **

Authorizations:
ApiKey
path Parameters
serverId
required
string <uuid>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "serverId": "10d2345a-e43d-463d-830e-4f5b19b60d41",
  • "isClaimed": true,
  • "steamId": "string",
  • "discordId": "string"
}

Returns the most recent 100 votes for a server id ** SEVRER MUST BE VERIFIED **

Authorizations:
ApiKey
path Parameters
serverId
required
string <uuid>
query Parameters
count
integer <int32>
Default: 100

Responses

Response samples

Content type
application/json
[
  • {
    }
]