rocketchat_API

Python API wrapper for Rocket.Chat

PyPI

Installation

From PyPI (recommended):

pip install rocketchat_API

From source:

git clone https://github.com/jadolg/rocketchat_API.git
cd rocketchat_API
pip install .

Requirements

Python 3.10 or higher
requests

Compatibility

This library is tested against all supported versions of Python and Rocket.Chat. It is also continuously tested against the latest Rocket.Chat release to ensure compatibility with new versions.

We do not guarantee any compatibility outside of the tested versions.

See the Test GitHub Action to get the list of tested versions.

Usage

Basic Authentication

from rocketchat_API.rocketchat import RocketChat

rocket = RocketChat('user', 'pass', server_url='https://demo.rocket.chat')

# Get current user info
rocket.me()

# List all channels
for channel in rocket.channels_list():
    print(channel.get("name"))

# Post a message
rocket.chat_post_message('good news everyone!', channel='GENERAL', alias='Farnsworth')

# Get channel history
rocket.channels_history('GENERAL', max_count=5)

Token-Based Authentication

If you already have a user ID and authentication token, you can use them directly:

from rocketchat_API.rocketchat import RocketChat

rocket = RocketChat(
    user_id='WPXGmQ64S3BXdCRb6',
    auth_token='jvNyOYw2f0YKwtiFS06Fk21HBRBBuV7zI43HmkNzI_s',
    server_url='https://demo.rocket.chat'
)

rocket.me()

Method Parameters

Only required parameters are explicitly defined in the RocketChat class methods. However, you can pass any additional parameters supported by the Rocket.Chat API. For a complete list of available parameters, refer to the official Rocket.Chat API documentation.

Development

Setting Up the Development Environment

Clone the repository:

git clone https://github.com/jadolg/rocketchat_API.git
cd rocketchat_API

Install development dependencies:

pip install -e ".[test]"

Running Tests

Tests run against a Rocket.Chat instance in Docker. Make sure you have Docker and Docker Compose installed.

Start the test server:

docker compose up -d

Wait for Rocket.Chat to be ready:

until curl --silent http://localhost:3000/api/info/; do sleep 15; echo "waiting for Rocket.Chat server to start"; done

Run the tests:

pytest

To run tests with coverage:

pytest --cov=rocketchat_API

When finished, stop the test server:

docker compose down

Code Style

This project uses black for code formatting. All code must be formatted with black before submitting a pull request.

To format your code:

black .

To check if your code is properly formatted:

black --check --diff .

The CI pipeline will automatically reject pull requests that are not properly formatted.

Contributing

See CONTRIBUTING.md for guidelines on how to contribute to this project.

License

This project is licensed under the MIT License. See LICENSE.txt for details.

Metadata

Release files for rocketchat-API 3.7.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rocketchat-API 3.7.1
File	Size	Uploaded
rocketchat_api-3.7.1.tar.gz	91.6 kB	Aug 8, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for rocketchat-API 3.7.1
File	Interpreter	ABI	Platform	Reset
rocketchat_api-3.7.1-py3-none-any.whl 30.5 kB Aug 8, 2026	Python 3	none	any	Details

Total release size: 122.2 kB

Release files / rocketchat_api-3.7.1.tar.gz

Download URL	rocketchat_api-3.7.1.tar.gz
Size	91.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`915e7eeeddcdca02601fe06e4fbc596f45a5d366a71c72f3fb48f6103708696c`
BLAKE2b-256 checksum How to use checksums	`fd31440f15fe378aa3f14b11bde8b6db3c1922e6a2a7d3a9089afc9ae1c73f85`
Upload date	Aug 8, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/jadolg/rocketchat_API
Publishing commit: github.com/jadolg/rocketchat_API/tree/e845a9551018dfeee5dc625e061969b524e217e0

Workflow

Publishing configuration: github.com/jadolg/rocketchat_API/blob/e845a9551018dfeee5dc625e061969b524e217e0/.github/workflows/release.yml
Publishing logs: github.com/jadolg/rocketchat_API/actions/runs/31248075982/attempts/1

Artifact

Subject: rocketchat_api-3.7.1.tar.gz
SHA-256 checksum: 915e7eeeddcdca02601fe06e4fbc596f45a5d366a71c72f3fb48f6103708696c Verifying attestations

Release files / rocketchat_api-3.7.1-py3-none-any.whl

Download URL	rocketchat_api-3.7.1-py3-none-any.whl
Size	30.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ad07005312a7f68572960c4768a9a7b9512a4f60c83d15273f5917bf655d49a1`
BLAKE2b-256 checksum How to use checksums	`7b049f8e28e558e013c760f7d4e1b40ba540119cbfbf338fee9f0a6736fa6350`
Upload date	Aug 8, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/jadolg/rocketchat_API
Publishing commit: github.com/jadolg/rocketchat_API/tree/e845a9551018dfeee5dc625e061969b524e217e0

Workflow

Publishing configuration: github.com/jadolg/rocketchat_API/blob/e845a9551018dfeee5dc625e061969b524e217e0/.github/workflows/release.yml
Publishing logs: github.com/jadolg/rocketchat_API/actions/runs/31248075982/attempts/1

Artifact

Subject: rocketchat_api-3.7.1-py3-none-any.whl
SHA-256 checksum: ad07005312a7f68572960c4768a9a7b9512a4f60c83d15273f5917bf655d49a1 Verifying attestations