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

Package (Recommended)

Install the latest version from PyPI:

pip install remnawave-api

Development Version

If you need the development version:

pip install git+https://github.com/sm1ky/remnawave-api.git@development

🫥 Compatible versions

Contract Version	Remnawave Panel Version
3.0.1	>=3.0.0
2.8.1	>=2.8.0
2.8.0	>=2.8.0
2.7.1	>=2.7.0
2.6.3	>=2.6.3
2.6.2	>=2.6.2
2.6.1	>=2.6.0
2.4.4	>=2.4.0
2.3.2	>=2.3.0, <2.4.0
2.3.0	>=2.3.0, <2.3.2
2.2.6	==2.2.6
2.2.3	>=2.2.13
2.1.19	>=2.1.19, <2.2.0
2.1.18	>=2.1.18
2.1.17	>=2.1.16, <=2.1.17
2.1.16	>=2.1.16
2.1.13	>=2.1.13, <=2.1.15
2.1.9	>=2.1.9, <=2.1.12
2.1.8	==2.1.8
2.1.7.post1	==2.1.7
2.1.4	>=2.1.4, <2.1.7
2.1.1	>=2.1.1, <2.1.4
2.0.0	>=2.0.0,<2.1.0
1.1.3	>=1.6.12,<2.0.0
1.1.2	>=1.6.3,<=1.6.11
1.1.1	1.6.1, 1.6.2
1.1.0	1.6.0
1.0.8	1.5.7

Dependencies

orjson (>=3.10.15, <4.0.0)
rapid-api-client (==0.6.0)
httpx (>=0.27.2, <0.28.0)

🚀 Usage

Here’s a quick example to get you started:

import os
import asyncio

from remnawave import RemnawaveSDK  # Updated import for new package
from remnawave.models import (  # Updated import path
    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.

Maintained by @sm1ky at sm1ky/remnawave-api.

Download files

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

Source Distribution

remnawave_api-3.0.1.tar.gz (63.2 kB view details)

Uploaded Aug 1, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

remnawave_api-3.0.1-py3-none-any.whl (97.1 kB view details)

Uploaded Aug 1, 2026 Python 3

File details

Details for the file remnawave_api-3.0.1.tar.gz.

File metadata

Download URL: remnawave_api-3.0.1.tar.gz
Upload date: Aug 1, 2026
Size: 63.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for remnawave_api-3.0.1.tar.gz
Algorithm	Hash digest
SHA256	`f02c24f0fcce4eecd8b3ea462deac538bd32b4247341acc3aaf1df89cad3e954`
MD5	`dad8257d530f62a0350a6f712035d8d8`
BLAKE2b-256	`2cf8948e9fb17c5c0a3f606aa1e287c335337e7fbc0c897dafd98af99458136d`

See more details on using hashes here.

Provenance

The following attestation bundles were made for remnawave_api-3.0.1.tar.gz:

Publisher: upload.yml on sm1ky/remnawave-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: remnawave_api-3.0.1.tar.gz
- Subject digest: f02c24f0fcce4eecd8b3ea462deac538bd32b4247341acc3aaf1df89cad3e954
- Sigstore transparency entry: 2313252641
- Sigstore integration time: Aug 1, 2026
Source repository:
- Permalink: sm1ky/remnawave-api@3f305f6dcc2e7f1b5892f3777fe5dcb65ce71472
- Branch / Tag: refs/heads/production
- Owner: https://github.com/sm1ky
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: upload.yml@3f305f6dcc2e7f1b5892f3777fe5dcb65ce71472
- Trigger Event: push