Skip to main content

Package for HipChat's v2 API

Project description

A Python package for HipChat’s v2 JSON REST API. It’s based on v2’s navigability and self-declaration.


HypChat can either be installed from PyPI:

pip install hypchat

Or from source:

python install


There are two basic types in HypChat: Linker and RestObject. They are not meant to be instantiated directly but instead created as references from other objects.


A simple callable that represents an unfollowed reference.


The URL this object points to


Calling a Linker will perform the request and return a RestObject


A subclass of dict, contains additional functionality for links and actions.

Other Actions

Many of the v2 types define additional types, eg Rooms have methods for messaging, setting the topic, getting the history, and inviting users to the room. These are implemented as methods of subclasses. The complete listing is in the Type List.

Timezone Handling

HypChat uses aware datetime objects throughout by the dateutil module. However, the HipChat API universally uses UTC.

For methods that take a datetime, if a naive object is given, it will be assumed to be in UTC. If this is not what you mean, has a wonderful selection of timezones available.


First, create a HypChat object with the token

hc = HypChat("mytoken")

If you use Hipchat Server

hc = HypChat("mytoken", endpoint="")

There are several root links:

rooms = hc.rooms()
users = hc.users()
emots = hc.emoticons()
caps = hc.capabilities()

In addition, the HypChat object has methods for creating objects and directly referencing the basic types.

For example, you might do:

for room in (r for r in hipchat.rooms(expand='items') if r['last_active'] < datetime.datetime(2013, 12, 1)):
        room.owner.message("Your room is dead; maybe archive it")

Since room.owner is a User stub, not just a generic object. (The Room objects are not stubs, since the expand keyword is used).

Downloading history is as easy as:


Note that this may eat up many requests for large rooms.


If you call python -m hypchat, a interactive prompt (using IPython if available) will appear. The environment will contain hipchat, an instance of the HypChat object. The token is pulled from ~/.hypchat, /etc/hypchat, or the environment variable HIPCHAT_TOKEN.

Type List

See TYPES.rst


  • API Links

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hypchat-0.21.tar.gz (16.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page