founders 0.1.1

A small package for the founders api

FoundersApiPy

A small package for the Founders API access made into a python package!

Index:

• Package
• Sub Packages
  • user
  • server
  • status
• Classes
  • user_info
  • server_info
  • status_info

Package:

import founders

Sub Packages:

user:

founders.user.info(id): returns a user_info class based on user id input.

founderse.user.all(): returns a dictionary of all users in the form of {username: id, username: id...}.

server:

founders.server.info(id): returns a server_info class based on server id input.

founders.server.all(): returns a dictionary of all servers in the form of {server_name: id, server_name: id...}.

status:

founders.status.stat(id): returns a status_info class based on server id input.

Classes:

user_info:

self.success: True/False - whether information was obtained. This should always be checked before using information!

self.username: username of user.

self.rank: rank of user.

self.servers: servers user has access to.

self.lastSeen: time when user was last on in unix epoch time

self.created: time when user account was created in unix epoch time

server_info:

self.success: True/False - whether information was obtained. This should always be checked before using information!

self.domain: The domain name of the server; Ex: hypixel.net.

self.ip: The ip adress of the server, Ex: 172.65.128.70

self.port: The port of the server (by default and usually 25565).

self.name: The name of the server in the Founders Server Board; Ex: Hypixel

self.mRam: Minimum ram allocated to the server.

self.xRam: Maximum ram allocated to the server.

self.serverJar: Type of Minecraft server jar often pertaining to the Minecraft version, Ex: spigot-1.14.4.

status_info:

self.success: True/False - whether information was obtained. This should always be checked before using information!

self.status: True/False - whether the server is running or not.

self.ip: The ip adress of the server, Ex: 172.65.128.70

self.port: The port of the server (by default and usually 25565).