Objects

UserBalance

class unbelipy.UserBalance(total, cash, bank, user_id, guild_id, bucket, rank=None)

Dataclass representing the balance of a user from the API.

Note

The total, bank and cash attributes may be a float if set to infinity (positive or negative).

Parameters

• total (Union[int, float]) –

• cash (Union[int, float]) –

• bank (Union[int, float]) –

• user_id (int) –

• guild_id (int) –

• bucket (str) –

• rank (int) –

Return type

None

total

The user’s total amount of money (cash + bank).

Type

Union[int, float]

bank

The user’s bank amount.

Type

Union[int, float]

cash

The user’s cash amount.

Type

Union[int, float]

user_id

The user’s unique ID.

Type

int

guild_id

The user’s guild’s unique ID.

Type

int

rank

The rank of the user in the guild according to query parameters.

Type

int

Guild

class unbelipy.Guild(id, name, icon, owner_id, member_count, symbol, bucket)

Dataclass representing a guild from the API.

Parameters

• id (int) –

• name (str) –

• icon (str) –

• owner_id (int) –

• member_count (int) –

• symbol (str) –

• bucket (str) –

Return type

None

id

The guild’s unique ID.

Type

int

name

The guild’s name.

Type

str

owner_id

The guild owner’s unique ID.

Type

int

member_count

The guild’s amount of members.

Type

int

symbol

The guild’s currency symbol.

Type

str