Groups

groups.timeline(server_url, group, *args, **kwargs)

Shows a group’s timeline. Similar to other timeline resources.

Accepts the same parameters as requests.get() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get–api-statusnet-groups-timeline-(int-id)(string-nickname).json

Parameters:
  • server_url (str) – URL of the server
  • group – name or ID of the group
Return type:

list
Returns:

a list of status dicts
groups.join(server_url, group, *args, **kwargs)

Join a group.

Accepts the same parameters as requests.post() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#post–api-statusnet-groups-join-(int-id)(string-nickname).json

Parameters:
  • server_url (str) – URL of the server
  • group – name or ID of the group
Return type:

dict
Returns:

Group dict
groups.leave(server_url, group, *args, **kwargs)

Leave a group.

Accepts the same parameters as requests.post() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#post–api-statusnet-groups-leave-(int-id)(string-nickname).json

Parameters:
  • server_url (str) – URL of the server
  • group – name or ID of the group
Return type:

dict
Returns:

Group dict
groups.create(server_url, *args, **kwargs)

Create a new group.

Accepts the same parameters as requests.post() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#post–api-statusnet-groups-create.json

Parameters:server_url (str) – URL of the server
Return type:dict
Returns:Group dict
groups.show(server_url, group, *args, **kwargs)

Returns details about the group.

Accepts the same parameters as requests.get() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get–api-statusnet-groups-show-(int-id)(string-nickname).json

Parameters:
  • server_url (str) – URL of the server
  • group – name or ID of the group
Return type:

dict
Returns:

Group dict
groups.local_groups(server_url, *args, **kwargs)

List local groups.

Accepts the same parameters as requests.get() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get–api-statusnet-groups-list_all.json

Parameters:server_url (str) – URL of the server
Return type:list
Returns:a list of group dicts
groups.user_groups(server_url, *args, **kwargs)

Show the groups a given user is a member of.

Accepts the same parameters as requests.get() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get–api-statusnet-groups-list.json

Parameters:server_url (str) – URL of the server
Return type:list
Returns:a list of group dicts
groups.members(server_url, group, *args, **kwargs)

List the members of a given group.

Accepts the same parameters as requests.get() except url.

https://twitter-api.readthedocs.io/en/latest/groups.html#get–api-statusnet-groups-membership-(int-id)(string-nickname).json

Parameters:
  • server_url (str) – URL of the server
  • group – name or ID of the group
Return type:

list
Returns:

a list of user dicts
groups.is_member(server_url, group, *args, **kwargs)

Show is the specified user is a member of the group.

Accepts the same parameters as requests.get() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get–api-statusnet-groups-is_member.json

Parameters:
  • server_url (str) – URL of the server
  • group – name or ID of the group
Return type:

dict
Returns:

dict with is_member key set to True if the user is a member of the group, False otherwise
groups.admins(server_url, group, *args, **kwargs)

List the admins of a given group.

Accepts the same parameters as requests.get() except url.

Implements https://twitter-api.readthedocs.io/en/latest/groups.html#get–api-statusnet-groups-admins-(int-id)(string-nickname).json

Parameters:
  • server_url (str) – URL of the server
  • group – name or ID of the group
Return type:

list
Returns:

a list of user dicts