roapipy 1.0.18

roapipy - A wrapper for the Roblox API built for Python

roapipy Documentation

roapipy - A python wrapper for the roblox api

class client()

For usage of roapipy, upon importing, you need to define your client - this will be your main mode of using the wrapper. Recommended names for its variable are; robloxclient, roclient & client
For the purpose of simplicity, this documentation will be using roclient.
If you are unsure on how to get your roblosecurity cookie, use the following tutorial (link from popular roblox python api wrapper, the purpose of this wrapper is to be a simpler version of it).

roclient = roapipy.client(".roblosecurity")

Parameters:

• rosec (Optional[str]) - roblosecurity code (only required if using authenticated commands like accepting users into a group or setting shout)

class user

Used to interact with users

info(user)

Returns information on the user with the given id
Parameters:

• user ( Any[int(id), str(username)] ) - the user you wish to get information on

check(user)

Returns whether the user with the given name/id exists
Parameters:

• user ( Any[int(id), str(username)] ) - the user you wish to check the existance status of

activity(user)

Returns the activity of the user with the given name/id
A roblosecurity is optional within the Client"s parameters for this command to give extra information
Parameters:

• user ( Any[int(id), str(username)] ) - the user you wish to get the activity of

groups(user)

Returns the groups the user with the given name/id is in
Parameters:

• user ( Any[int(id), str(username)] ) - the user you wish to get the groups of

class group

Used to interact with groups

info(id)

Returns information on the group with the given id
Parameters:

• id ( int ) - id of the group you wish to get the information on

roles(id)

Returns the roles of the group with the given id
Parameters:

• id ( int ) - id of the group you wish to get the roles of

shout(groupid, shout)

Sets the shout of the group with the given id
A roblosecurity is required within the Client"s parameters for this command to work
Parameters:

• groupid ( int ) - id of the group you wish to set the shout of
• shout ( str ) - what the shout should be set to

accept(groupid)

Accepts the user with the given id into the group with the given id
A roblosecurity is required within the Client"s parameters for this command to work
Parameters:

• groupid ( int ) - id of the group you wish to accept all users into
• user ( Any[int(id), str(username)] ) - the user you wish to accept into the group

acceptall(groupid)

Accepts all pending requests into the group with the given id
A roblosecurity is required within the Client"s parameters for this command to work
Parameters:

• groupid ( int ) - id of the group you wish to accept all requests for

declineall(groupid)

Declines all pending requests into the group with the given id
A roblosecurity is required within the Client"s parameters for this command to work
Parameters:

• groupid ( int ) - id of the group you wish to decline all requests for

rank(groupid, user, rank)

Rank the user with the given id into the group with the given id to the given rank
A roblosecurity is required within the Client"s parameters for this command to work
Parameters:

• groupid ( int ) - id of the group you wish to rank the user in
• user ( Any[int(id), str(username)] ) - the user you wish to rank
• rank ( Any[int(Unique ID/Group ID (1-255)), str(rank name)] ) - the rank you wish to set the user to

exile(groupid, user)

Exiles the user with the given id from the group with the given id. A roblosecurity is required within the Client"s parameters for this command to work
Parameters:

• groupid ( int ) - id of the group you wish to exile the user from
• user ( Any[int(id), str(username)] ) - the user you wish to exile from the group

Examples

To get information on a user, the following code would be written;

roclient.user.info(103956751) #Can use id or username
#Returns;
#{'name': 'Gytis5089', 'nick': 'Gytis', 'id': 103956751, 'creation': '2016-01-05T01:39:52.407Z', 'avatar': 'https://tr.rbxcdn.com/eda0a319e15547f339c4ff582982a770/720/720/Avatar/Png', 'friends': 17, 'followers': 290, 'following': 2}

Or, to get all of the roles within a group;

roclient.group.roles(5215428)
#Returns;
#{'Guest': {'id': 34713977, 'rank': 0, 'holders': 0}, 'Member': {'id': 34713976, 'rank': 1, 'holders': 0}, 'Admin': {'id': 34713975, 'rank': 254, 'holders': 0}, 'Chairman': {'id': 34713974, 'rank': 255, 'holders': 1}}

And ranking a user within a group;

roclient.group.rank(5215428, "Gytis5089", "Admin") #Can use id or username for user #And can use name, hierarchical id (1-255) & unique id for rank
#Returns;
#Ranked (or an error if you don't have a roblosecurity, whether it's invalid, or if the account doesn't have admin access to the group)

Credits

jmk

Creator of original roblox api wrapper/inspiration (ropy) Github / Twitter