chillet 1.0.0

Chillet is a modern, fully typed Python SDK designed for Palworld REST API.

Chillet provides both synchronous and asynchronous clients, allowing developers to manage servers, query metrics, and perform administrative actions with clean, predictable interfaces. Chillet is built with httpx and pydantic, so it focuses on reliability and type safety.

Installation

From PyPI (recommended)

pip install chillet

From source (this repository)

# clone
git clone https://github.com/domi2k/chillet.git
cd chillet

# create env + install (uv)
uv sync --all-extras

Quickstart

Synchronous

from chillet import PalworldClient

with PalworldClient(password="YOUR_PASSWORD") as client:
    info = client.get_info()
    print(info.servername, info.version)

    metrics = client.get_metrics()
    print("FPS:", metrics.serverfps, "Players:", metrics.currentplayernum)

    client.post_announce("Welcome to the server!")

Asynchronous

import asyncio
from chillet import AsyncPalworldClient

async def main():
    async with AsyncPalworldClient(password="YOUR_PASSWORD") as client:
        info = await client.get_info()
        print(info.servername, info.version)

        metrics = await client.get_metrics()
        print("FPS:", metrics.serverfps, "Players:", metrics.currentplayernum)

        await client.post_announce("Welcome to the server!")

asyncio.run(main())

Documentation

Full documentation with tutorials and API reference is available here.

Contact

If you have any questions about this project, feel free to contact me on Discord.

⚠︎ Disclaimer ⚠︎

This project isn’t endorsed by Pocket Pair, Inc., and doesn’t reflect the views or opinions of Pocket Pair or anyone officially involved in producing or managing Pocket Pair’s products. Pocket Pair, Inc. and its products are trademarks or registered trademarks of Pocket Pair, Inc. Use at your own risk; provided AS IS per the license.