1 What is it? How to use?

Welcome!

Here is what is this API...

• This API lets you to view informations from game servers.

What are the properties that they are coming from API?

• Properties:
  • name
  • map
  • password
  • maxPlayers
  • online
  • connect
  • ping
  • players
  • info

How to actually use API?

• There are 3 different fetch types:
  • Default
    • GET /api/default/:game?auth=AUTH_KEY&host=HOST_IP&port=HOST_PORT
    • This gives default properties (name, map, password, maxPlayers, online, connect, ping)
  • All
    • GET /api/all/:game?auth=AUTH_KEY&host=HOST_IP&port=HOST_PORT
    • This gives all properties in the object
  • Free
    • GET /free/:game?host=HOST_IP&port=HOST_PORT
    • This gives online and max players info.
  • Select
    • GET /api/select/:game?auth=AUTH_KEY&host=HOST_IP&port=HOST_PORT
    • This is a custom fetch type that allows you to select which properties you want to select
    • Example:
      • GET /api/select/:game?auth=AUTH_KEY&host=HOST_IP&port=HOST_PORT&players&info
      • This only gives an object with players and info.

How to get Auth Key?

• To get auth key you should join to our discord server: https://discord.gg/mv9Tbky42T
• Note: This is completely free and you will not be charged a monetary fee.