Developer Docs

This section of the documentation is for other developers, and contains the complete information about each package, module, class, and method.

groupy.client

class groupy.client.Client(session)

The API client.

The client is the main point of interaction. It can directly list groups, chats, bots, and provide your user information. It can also download the image of a message attachment.

Parameters:session (Session) – the request session

classmethod from_token(token)

Create a client directly from an API token.

Parameters:token (str) – an API token Returns:a client Return type:Client

groupy.api

groupy.api.attachments

class groupy.api.attachments.Attachment(type, **data)

Base attachment class.

Every attachment has a type and additional data.

Parameters:

• type (str) – attachment type
• data (kwargs) – additional attachment data

classmethod from_bulk_data(attachments)

Create multiple attachments from a list of attachment data.

Returns:attachment sublcass objects Return type:list

classmethod from_data(type, **data)

Create an attachment from data.

Parameters:

• type (str) – attachment type
• data (kwargs) – additional attachment data

Returns:

an attachment subclass object

Return type:

~groupy.api.attachments.Attachment

to_json()

Return the attachment as JSON serializable dict.

Returns:serializable attachment data Return type:dict

class groupy.api.attachments.Emoji(placeholder, charmap)

An emoji attachment.

Parameters:

• placeholder (str) – the “stand-in” character for the emoji
• charmap (list) – a list of 2-tuples specifying which emojis

class groupy.api.attachments.Image(url, source_url=None)

An image attachment.

Parameters:

• url (str) – the absolute URL for the image
• source_url (str) – an optional, absolute URL for the image source

class groupy.api.attachments.Images(session, path=None)

A manager for handling image uploads/downloads.

base_url = 'https://image.groupme.com/'

the base url for the pictures API

download(image, url_field='url', suffix=None)

Download the binary data of an image attachment.

Parameters:

• image (Image) – an image attachment
• url_field (str) – the field of the image with the right URL
• suffix (str) – an optional URL suffix

Returns:

binary image data

Return type:

bytes

download_avatar(image, url_field='url')

Downlaod the binary data of an image attachment at avatar size.

Parameters:url_field (str) – the field of the image with the right URL Returns:binary image data Return type:bytes

download_large(image, url_field='url')

Downlaod the binary data of an image attachment at large size.

Parameters:url_field (str) – the field of the image with the right URL Returns:binary image data Return type:bytes

download_preview(image, url_field='url')

Downlaod the binary data of an image attachment at preview size.

Parameters:url_field (str) – the field of the image with the right URL Returns:binary image data Return type:bytes

from_file(fp)

Create a new image attachment from an image file.

Parameters:fp (file) – a file object containing binary image data Returns:an image attachment Return type:Image

upload(fp)

Upload image data to the image service.

Call this, rather than from_file(), you don’t want to create an attachment of the image.

Parameters:fp (file) – a file object containing binary image data Returns:the URLs for the image uploaded Return type:dict

class groupy.api.attachments.LinkedImage(url, source_url=None)

class groupy.api.attachments.Location(lat, lng, name, foursqure_venue_id=None)

A location attachment.

Parameters:

• lat (float) – latitude
• lng (float) – longitude
• name (str) – the name
• foursqure_venue_id (str) – an optional Foursquare venue ID

class groupy.api.attachments.Mentions(loci=None, user_ids=None)

A mentions attachment.

Parameters:

• loci (list) – the start and end indices of one or more mentions
• user_ids (list) – the user_ids of one or more users mentioned

class groupy.api.attachments.Split(token)

A split attachment (deprecated in the API).

Parameters:token (str) – the split token

groupy.api.base

class groupy.api.base.ManagedResource(manager, **data)

Class to represent an API object.

class groupy.api.base.Manager(session, path=None)

Class for interacting with the endpoint for a resource.

Parameters:

• session (Session) – the requests session
• path (str) – path relative to the base URL

base_url = 'https://api.groupme.com/v3/'

the base URL

groupy.api.blocks

class groupy.api.blocks.Block(manager, **data)

A block between you and another user.

exists()

Return True if the block still exists.

Returns:True if the block exists Return type:bool

unblock()

Remove the block.

Returns:True if successful Return type:bool

class groupy.api.blocks.Blocks(session, user_id)

Blocks manager.

Parameters:

• session (Session) – the request session
• user_id (str) – your user ID

between(other_user_id)

Check if there is a block between you and the given user.

Returns:True if the given user has been blocked Return type:bool

block(other_user_id)

Block the given user.

Parameters:other_user_id (str) – the ID of the user to block Returns:the block created Return type:Block

list()

List the users you have blocked.

Returns:a list of Block’s Return type:list

unblock(other_user_id)

Unblock the given user.

Parameters:other_user_id (str) – the ID of the user to unblock Returns:True if successful Return type:bool

groupy.api.bots

class groupy.api.bots.Bot(manager, **data)

A bot.

destroy()

Destroy the bot.

Returns:True if successful Return type:bool

post(text, attachments=None)

Post a message as the bot.

Parameters:

• text (str) – the text of the message
• attachments (list) – a list of attachments

Returns:

True if successful

Return type:

bool

class groupy.api.bots.Bots(session)

A bot manager.

create(name, group_id, avatar_url=None, callback_url=None, dm_notification=None, **kwargs)

Create a new bot in a particular group.

Parameters:

• name (str) – bot name
• group_id (str) – the group_id of a group
• avatar_url (str) – the URL of an image to use as an avatar
• callback_url (str) – a POST-back URL for each new message
• dm_notification (bool) – whether to POST-back for direct messages?

Returns:

the new bot

Return type:

Bot

destroy(bot_id)

Destroy a bot.

Parameters:bot_id (str) – the ID of the bot to destroy Returns:True if successful Return type:bool

list()

Return a list of bots.

Returns:all of your bots Return type:list

post(bot_id, text, attachments=None)

Post a new message as a bot to its room.

Parameters:

• bot_id (str) – the ID of the bot
• text (str) – the text of the message
• attachments (list) – a list of attachments

Returns:

True if successful

Return type:

bool

groupy.api.chats

class groupy.api.chats.Chat(manager, **data)

A chat with another user.

post(text=None, attachments=None)

Post a message to the chat.

Note

This endpoint seems to only work with an application API token. If you’re getting HTTP 429 Too Many Requests, create a new application at https://dev.groupme.com/applications and use the API token provided at the end of that process.

Parameters:

• text (str) – the text of the message
• attachments (list) – a list of attachments

Returns:

True if successful

Return type:

bool

class groupy.api.chats.Chats(session)

A chat manager.

list(page=1, per_page=10)

List a page of chats.

Parameters:

• page (int) – which page
• per_page (int) – how many chats per page

Returns:

chats with other users

Return type:

ChatList

list_all(per_page=10)

List all chats.

Parameters:per_page (int) – how many chats per page Returns:chats with other users Return type:ChatList

groupy.api.groups

class groupy.api.groups.ChangeOwnersResult(group_id, owner_id, status)

The result of requesting a group owner change.

Parameters:

• group_id (str) – group_id of the group
• owner_id (str) – the ID of the new owner
• status (str) – the status of the request

is_success

Return True if the request was successful.

status_texts = {'200': 'everything checked out', '400': 'the group is already owned by that user', '403': 'you must own a group to change its owner', '404': 'either the new owner is not a member of the group, or the new owner or the group were not found', '405': 'request object is missing required field or any of the required fields is not an ID'}

a map of statuses to meanings

success_code = '200'

the status that represents success

class groupy.api.groups.Group(manager, **data)

A group.

change_owners(user_id)

Change the owner of the group.

Note that the user must be a member of the group.

Parameters:user_id (str) – the user_id of the new owner Returns:the result Return type:ChangeOwnersResult

create_bot(name, avatar_url=None, callback_url=None, dm_notification=None, **kwargs)

Create a new bot in a particular group.

Parameters:

• name (str) – bot name
• avatar_url (str) – the URL of an image to use as an avatar
• callback_url (str) – a POST-back URL for each new message
• dm_notification (bool) – whether to POST-back for direct messages?

Returns:

the new bot

Return type:

Bot

destroy()

Destroy the group.

Note that you must be the owner.

Returns:True if successful Return type:bool

get_membership()

Get your membership.

Note that your membership may not exist. For example, you do not have a membership in a former group. Also, the group returned by the API when rejoining a former group does not contain your membership. You must call refresh_from_server() to update the list of members.

Returns:your membership in the group Return type:Member Raises:groupy.exceptions.MissingMembershipError – if your membership is not in the group data

leave()

Leave the group.

Returns:True if successful Return type:bool

post(text=None, attachments=None)

Post a new message to the group.

Parameters:

• text (str) – the text of the message
• attachments (list) – a list of attachments

Returns:

the message

Return type:

Message

refresh_from_server()

Refresh the group from the server in place.

rejoin()

Rejoin the group.

Note that this must be a former group.

Returns:a current (not former) group Return type:Group

update(name=None, description=None, image_url=None, office_mode=None, share=None, **kwargs)

Update the details of the group.

Parameters:

• name (str) – group name (140 characters maximum)
• description (str) – short description (255 characters maximum)
• image_url (str) – GroupMe image service URL
• office_mode (bool) – (undocumented)
• share (bool) – whether to generate a share URL

Returns:

an updated group

Return type:

Group

update_membership(nickname=None, **kwargs)

Update your own membership.

Note that this fails on former groups.

Parameters:nickname (str) – new nickname Returns:updated membership Return type:Member

class groupy.api.groups.Groups(session)

A group manager.

change_owners(group_id, owner_id)

Change the owner of a group.

Note

you must be the owner to change owners

Parameters:

• group_id (str) – the group_id of a group
• owner_id (str) – the ID of the new owner

Returns:

the result

Return type:

ChangeOwnersResult

create(name, description=None, image_url=None, share=None, **kwargs)

Create a new group.

Note that, although possible, there may be issues when not using an image URL from GroupMe’s image service.

Parameters:

• name (str) – group name (140 characters maximum)
• description (str) – short description (255 characters maximum)
• image_url (str) – GroupMe image service URL
• share (bool) – whether to generate a share URL

Returns:

a new group

Return type:

Group

destroy(id)

Destroy a group.

Parameters:id (str) – a group ID Returns:True if successful Return type:bool

get(id)

Get a single group by ID.

Parameters:id (str) – a group ID Returns:a group Return type:Group

join(group_id, share_token)

Join a group using a share token.

Parameters:

• group_id (str) – the group_id of a group
• share_token (str) – the share token

Returns:

the group

Return type:

Group

list(page=1, per_page=10, omit=None)

List groups by page.

The API allows certain fields to be excluded from the results so that very large groups can be fetched without exceeding the maximum response size. At the time of this writing, only ‘memberships’ is supported.

Parameters:

• page (int) – page number
• per_page (int) – number of groups per page
• omit (int) – a comma-separated list of fields to exclude

Returns:

a list of groups

Return type:

GroupList

list_all(per_page=10, omit=None)

List all groups.

Since the order of groups is determined by recent activity, this is the recommended way to obtain a list of all groups. See list() for details about omit.

Parameters:

• per_page (int) – number of groups per page
• omit (int) – a comma-separated list of fields to exclude

Returns:

a list of groups

Return type:

GroupList

list_former()

List all former groups.

Returns:a list of groups Return type:list

rejoin(group_id)

Rejoin a former group.

Parameters:group_id (str) – the group_id of a group Returns:the group Return type:Group

update(id, name=None, description=None, image_url=None, office_mode=None, share=None, **kwargs)

Update the details of a group.

Note

There are significant bugs in this endpoint! 1. not providing name produces 400: “Topic can’t be blank” 2. not providing office_mode produces 500: “sql: Scan error on column index 14: sql/driver: couldn’t convert <nil> (<nil>) into type bool”

Note that these issues are “handled” automatically when calling update on a Group object.

Parameters:

• id (str) – group ID
• name (str) – group name (140 characters maximum)
• description (str) – short description (255 characters maximum)
• image_url (str) – GroupMe image service URL
• office_mode (bool) – (undocumented)
• share (bool) – whether to generate a share URL

Returns:

an updated group

Return type:

Group

groupy.api.memberships

class groupy.api.memberships.Member(manager, group_id, **data)

A user’s membership in a particular group.

Members have both an ID and a membership ID. The membership ID is unique to the combination of user and group.

It can be helpful to think of a “memmber” as a “membership.” That is, a specific user in a specific group. Thus, two Member objects are equal only if their id fields are equal,. As a consequence, the two Member objects representing user A in two groups X and Y will _not_ be equal.

Parameters:

• manager (Manager) – a manager for the group of the membership
• group_id (str) – the group_id of the membership
• data (kwargs) – additional membership data

add_to_group(group_id, nickname=None)

Add the member to another group.

If a nickname is not provided the member’s current nickname is used.

Parameters:

• group_id (str) – the group_id of a group
• nickname (str) – a new nickname

Returns:

a membership request

Return type:

MembershipRequest

block()

Block the user of the membership.

Returns:the block created Return type:Block

is_blocked()

Check whether you have the user of the membership blocked.

Returns:True if the user is blocked Return type:bool

post(text=None, attachments=None, source_guid=None)

Post a direct message to the user.

Parameters:

• text (str) – the message content
• attachments – message attachments
• source_guid (str) – a client-side unique ID for the message

Returns:

the message sent

Return type:

DirectMessage

remove()

Remove the member from the group (destroy the membership).

Returns:True if successfully removed Return type:bool

unblock()

Unblock the user of the membership.

Returns:True if successfully unblocked Return type:bool

class groupy.api.memberships.MembershipRequest(manager, *requests, **data)

A membership request.

Parameters:

• manager (Manager) – a manager for the group of the membership
• requests (args) – the members requested to be added
• data (kwargs) – the membership request response data

class Results(members, failures)

failures

Alias for field number 1

members

Alias for field number 0

check_if_ready()

Check for and fetch the results if ready.

get()

Return the results now.

Returns:

the membership request results

Return type:

Results

Raises:

• groupy.exceptions.ResultsNotReady – if the results are not ready
• groupy.exceptions.ResultsExpired – if the results have expired

get_failed_requests(results)

Return the requests that failed.

Parameters:results (list) – the results of a membership request check Returns:the failed requests Return type:generator

get_new_members(results)

Return the newly added members.

Parameters:results (list) – the results of a membership request check Returns:the successful requests, as Members Return type:generator

is_ready(check=True)

Return True if the results are ready.

If you pass check=False, no attempt is made to check again for results.

Parameters:check (bool) – whether to query for the results Returns:True if the results are ready Return type:bool

poll(timeout=30, interval=2)

Return the results when they become ready.

Parameters:

• timeout (int) – the maximum time to wait for the results
• interval (float) – the number of seconds between checks

Returns:

the membership request result

Return type:

Results

class groupy.api.memberships.Memberships(session, group_id)

A membership manager for a particular group.

Parameters:

• session (Session) – the request session
• group_id (str) – the group_id of a group

add(nickname, email=None, phone_number=None, user_id=None)

Add a user to the group.

You must provide either the email, phone number, or user_id that uniquely identifies a user.

Parameters:

• nickname (str) – new name for the user in the group
• email (str) – email address of the user
• phone_number (str) – phone number of the user
• user_id (str) – user_id of the user

Returns:

a membership request

Return type:

MembershipRequest

add_multiple(*users)

Add multiple users to the group at once.

Each given user must be a dictionary containing a nickname and either an email, phone number, or user_id.

Parameters:users (args) – the users to add Returns:a membership request Return type:MembershipRequest

check(results_id)

Check for results of a membership request.

Parameters:

results_id (str) – the ID of a membership request

Returns:

successfully created memberships

Return type:

list

Raises:

• groupy.exceptions.ResultsNotReady – if the results are not ready
• groupy.exceptions.ResultsExpired – if the results have expired

remove(membership_id)

Remove a member from the group.

Parameters:membership_id (str) – the ID of a member in this group Returns:True if the member was successfully removed Return type:bool

update(nickname=None, **kwargs)

Update your own membership.

Note that this fails on former groups.

Parameters:nickname (str) – new nickname Returns:updated membership Return type:Member

groupy.api.messages

class groupy.api.messages.DirectMessage(manager, **data)

A direct message between two users.

class groupy.api.messages.DirectMessages(session, other_user_id)

Manager for direct messages with a particular user.

Parameters:

• session – request session
• other_user_id (str) – user_id of another user

create(text=None, attachments=None, source_guid=None)

Send a new direct message to the user.

Only provide the source_guid if you want to control it.

Note

This endpoint seems to only work with an application API token. If you’re getting HTTP 429 Too Many Requests, create a new application at https://dev.groupme.com/applications and use the API token provided at the end of that process.

Parameters:

• text (str) – the message content
• attachments – message attachments
• source_guid (str) – a client-side unique ID for the message

Returns:

the message sent

Return type:

DirectMessage

list(before_id=None, since_id=None, **kwargs)

Return a page of direct messages.

The messages come in reversed order (newest first). Note you can only provide _one_ of before_id, since_id.

Parameters:

• before_id (str) – message ID for paging backwards
• since_id (str) – message ID for most recent messages since

Returns:

direct messages

Return type:

MessageList

list_all(before_id=None, since_id=None, **kwargs)

Return all direct messages.

The messages come in reversed order (newest first). Note you can only provide _one_ of before_id, since_id.

Parameters:

• before_id (str) – message ID for paging backwards
• since_id (str) – message ID for most recent messages since

Returns:

direct messages

Return type:

generator

list_all_before(message_id, **kwargs)

Return all direct messages created before a message.

This can be used to page backwards through messages.

Parameters:message_id (str) – the ID of a message Returns:direct messages Return type:generator

list_before(message_id, **kwargs)

Return a page of direct messages created before a message.

This can be used to page backwards through messages.

Parameters:message_id (str) – the ID of a message Returns:direct messages Return type:MessageList

list_since(message_id, **kwargs)

Return a page of direct messages created since a message.

This is used to fetch the most recent messages after another. There may exist messages between the one given and the ones returned.

Parameters:message_id (str) – the ID of a message Returns:direct messages Return type:MessageList

class groupy.api.messages.Gallery(session, group_id)

Manager for messages in the gallery.

This endpoint is undocumented!

Parameters:

• session – request session
• group_id (str) – group_id for a particular group

class groupy.api.messages.GenericMessage(manager, conversation_id, **data)

A message.

Parameters:

• manager – a message manager
• conversation_id (str) – the ID for the conversation
• data (kwargs) – the data of the message

like()

Like the message.

preview_length = 42

number of characters seen in the repr output

unlike()

Unlike the message.

class groupy.api.messages.Leaderboard(session, group_id)

Manager for messages on the leaderboard.

list(period)

List most liked messages for a given period.

Parameters:period (str) – either “day”, “week”, or “month” Returns:the messages Return type:list

list_day()

List most liked messages for the last day.

Returns:the messages Return type:list

list_for_me()

List your top liked messages.

Returns:the messages Return type:list

list_mine()

List messages you liked.

Returns:the messages Return type:list

list_month()

List most liked messages for the last month.

Returns:the messages Return type:list

list_week()

List most liked messages for the last week.

Returns:the messages Return type:list

class groupy.api.messages.Likes(session, conversation_id, message_id)

Manager for likes/unlikes of a particular message.

The message can be from either a group or a chat.

Parameters:

• session – request session
• conversation_id (str) – unique ID for a the conversation from which the message originates
• message_id (str) – unique ID of the message to like/unlike

like()

Like the message.

unlike()

Unlike the message.

class groupy.api.messages.Message(manager, **data)

A group message.

class groupy.api.messages.Messages(session, group_id)

A message manager for a particular group.

Parameters:

• session (Session) – the request session
• group_id (str) – the group_id of a group

create(text=None, attachments=None, source_guid=None)

Create a new message in the group.

Parameters:

• text (str) – the text of the message
• attachments (list) – a list of attachments
• source_guid (str) – a unique identifier for the message

Returns:

the created message

Return type:

Message

list(before_id=None, since_id=None, after_id=None, limit=20)

Return a page of group messages.

The messages come in reversed order (newest first). Note you can only provide _one_ of before_id, since_id, or after_id.

Parameters:

• before_id (str) – message ID for paging backwards
• after_id (str) – message ID for paging forwards
• since_id (str) – message ID for most recent messages since
• limit (int) – maximum number of messages per page

Returns:

group messages

Return type:

MessageList

list_after(message_id, limit=None)

Return a page of group messages created after a message.

This is used to page forwards through messages.

Parameters:

• message_id (str) – the ID of a message
• limit (int) – maximum number of messages per page

Returns:

group messages

Return type:

MessageList

list_all(limit=None)

Return all group messages.

Parameters:limit (int) – maximum number of messages per page Returns:group messages Return type:generator

list_all_after(message_id, limit=None)

Return all group messages created after a message.

Parameters:

• message_id (str) – the ID of a message
• limit (int) – maximum number of messages per page

Returns:

group messages

Return type:

generator

list_all_before(message_id, limit=None)

Return all group messages created before a message.

Parameters:

• message_id (str) – the ID of a message
• limit (int) – maximum number of messages per page

Returns:

group messages

Return type:

generator

list_before(message_id, limit=None)

Return a page of group messages created before a message.

This can be used to page backwards through messages.

Parameters:

• message_id (str) – the ID of a message
• limit (int) – maximum number of messages per page

Returns:

group messages

Return type:

MessageList

list_since(message_id, limit=None)

Return a page of group messages created since a message.

This is used to fetch the most recent messages after another. There may exist messages between the one given and the ones returned. Use list_after() to retrieve newer messages without skipping any.

Parameters:

• message_id (str) – the ID of a message
• limit (int) – maximum number of messages per page

Returns:

group messages

Return type:

MessageList

groupy.api.user

class groupy.api.user.SmsMode(session)

class groupy.api.user.User(session)

groupy.pagers

class groupy.pagers.ChatList(manager, endpoint, **params)

class groupy.pagers.GalleryList(manager, endpoint, **params)

Pager for gallery messages.

get_next_page_param(item)

Return the param from the given item.

Parameters:item – the item that has the next page param Returns:next page param value

class groupy.pagers.GroupList(manager, endpoint, **params)

Pager for groups.

default_params = {'page': 1}

default to the first page

set_next_page_params()

Set the params in preparation for fetching the next page.

class groupy.pagers.MessageList(manager, endpoint, **params)

Pager for messages.

default_mode = 'before_id'

the default mode param

classmethod detect_mode(**params)

Detect which listing mode of the given params.

Params kwargs params:  the params Returns:one of the available modes Return type:str Raises:ValueError – if multiple modes are detected

fetch_next()

Fetch the next page of results.

Returns:the next page of results Return type:list

get_last_item_index()

Return the index of the last item in the page.

get_next_page_param(item)

Return the param from the given item.

Parameters:item – the item that has the next page param Returns:next page param value

modes = {'after_id': -1, 'before_id': -1, 'since_id': 0}

all possible mode params and the index for their next page params

set_next_page_params()

Set the params so that the next page is fetched.

class groupy.pagers.Pager(manager, endpoint, **params)

Class for iterating over multiple pages of results.

This is a generic, base class. To create a specific type of pager, provide a definition for set_next_page_params in a subclass.

Parameters:

• manager (Manager) – the manager from which to get results
• endpoint (func) – a callable from which results can be fetched
• params (kwargs) – initial params to pass to the manager

autopage()

Iterate through results from all pages.

Returns:all results Return type:generator

default_params = {}

the base set of params

fetch()

Fetch the current page of results.

Returns:the current page of results Return type:list

fetch_next()

Fetch the next page of results.

Returns:the next page of results Return type:list

set_next_page_params()

Set the params in preparation for fetching the next page.

groupy.exceptions

exception groupy.exceptions.ApiError(message=None)

Base exception for all GroupMe API errors.

exception groupy.exceptions.BadResponse(response, message=None)

Exception raised when the status code of the response was 400 or more.

Parameters:

• response (Response) – the response
• message (str) – a description of the exception

exception groupy.exceptions.FindError(message, objects, tests, matches=None)

Exception raised when the number of results is not 1.

exception groupy.exceptions.GroupyError(message=None)

Base exception for all Groupy exceptions.

Parameters:message (str) – a description of the exception

message = None

a description of the exception

exception groupy.exceptions.InvalidJsonError(response, message='The JSON was incomplete/invalid')

Exception raised for incomplete/invalid JSON in a response.

exception groupy.exceptions.MissingMembershipError(group_id, user_id, message=None)

Exception raied when your membership could not be found in a group.

exception groupy.exceptions.MissingMetaError(response, message='The response contained no meta data')

Exception raised for a response that lacks meta data.

exception groupy.exceptions.MissingResponseError(response, message='The response contained no response data')

Exception raised for a response that lacks response data.

exception groupy.exceptions.MultipleMatchesError(objects, tests, matches)

Exception raised when the number of results exceeds 1.

exception groupy.exceptions.NoMatchesError(objects, tests)

Exception raised when the number of results is 0.

exception groupy.exceptions.NoResponse(request, *args, **kwargs)

Exception raised when the API server could not be reached.

Parameters:

• request (PreparedRequest) – the original request that was made
• message (str) – a description of the exception

exception groupy.exceptions.ResultsError(response, message)

Exception raised for asynchronous results.

Parameters:

• response (Response) – the response
• message (str) – a description of the exception

exception groupy.exceptions.ResultsExpired(response, message='The results have expired')

Exception raised when the results have expired.

Parameters:

• response (Response) – the response
• message (str) – a description of the exception

exception groupy.exceptions.ResultsNotReady(response, message='The results are not ready yet')

Exception raised when results are not yet ready.

Parameters:

• response (Response) – the response
• message (str) – a description of the exception