Remnawave Python SDK

[!WARNING] This repository is a fork of the official SDK remnawave/python-sdk.

A Python SDK client for interacting with the Remnawave API. This library simplifies working with the API by providing convenient controllers, Pydantic models for requests and responses, and fast serialization with orjson.

📦 Installation

Production Version

Install the latest release from PyPI:

pip install remnapy

Pin the version to the panel line you run:

# pyproject.toml
dependencies = ["remnapy (>=3.2.1, <3.3.0)"]

Development Version

If you need the unreleased code from the development branch:

pip install git+https://github.com/remnashop/remnapy.git@development

🫥 Compatible versions

The package version mirrors the Remnawave panel version exactly — remnapy 3.2.1 targets Remnawave 3.2.1.

Dependencies

• rapid-api-client (==0.6.0)
• orjson (>=3.10.15, <4.0.0)
• httpx (>=0.27.2, <0.28.0)
• pydantic[email] (>=2.9.2, <3.0.0)
• pydantic-core (>=2.33.1, <2.34.0)
• cryptography (>=46.0.3, <47.0.0)

🚀 Usage

Here’s a quick example to get you started:

import os
import asyncio

from remnapy import RemnawaveSDK
from remnapy.models import (
    UsersResponseDto, 
    UserResponseDto,
    GetAllConfigProfilesResponseDto,
    CreateInternalSquadRequestDto
)

async def main():
    # URL to your panel (ex. https://vpn.com or http://127.0.0.1:3000)
    base_url: str = os.getenv("REMNAWAVE_BASE_URL")
    # Bearer Token from panel (section: API Tokens) 
    token: str = os.getenv("REMNAWAVE_TOKEN")

    # Initialize the SDK
    remnawave = RemnawaveSDK(base_url=base_url, token=token)

    # Fetch all users
    response: UsersResponseDto = await remnawave.users.get_all_users()
    total_users: int = response.total
    users: list[UserResponseDto] = response.users
    print("Total users: ", total_users)
    print("List of users: ", users)

if __name__ == "__main__":
    asyncio.run(main())

❤️ About

This SDK was originally developed by @kesevone for integration with Remnawave's API.

Previously maintained by @sm1ky at sm1ky/remnawave-api.

The official Remnawave repository is located at remnawave/python-sdk.

This repository is a fork of the official SDK.