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.4.5	>=3.4.4
3.4.4	>=3.4.4
3.4.3	>=3.4.0
3.2.2	>=3.2.0
3.2.1	>=3.2.0
3.2.0	>=3.2.0
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)
pydantic[email] (>=2.9.2, <3.0.0)
cryptography (>=48.0.1, <51.0.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.

Release files for remnawave-api 3.4.5

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

Source distribution (sdist)

Source distribution for remnawave-api 3.4.5
File	Size	Uploaded
remnawave_api-3.4.5.tar.gz	73.2 kB	Sep 25, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for remnawave-api 3.4.5
File	Interpreter	ABI	Platform	Reset
remnawave_api-3.4.5-py3-none-any.whl 109.7 kB Sep 25, 2026	Python 3	none	any	Details

Total release size: 183.0 kB

Release files / remnawave_api-3.4.5.tar.gz

Download URL	remnawave_api-3.4.5.tar.gz
Size	73.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`fe15fbe6d400745df2d3e0163ef0ea5a4ad11c6a32400141c47d99e146a5c8b7`
BLAKE2b-256 checksum How to use checksums	`bf2404b55b00f7a66c126d927b3a58b4e4d9be9e7021c8236b1852812d4b8011`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.8`

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/sm1ky/remnawave-api
Publishing commit: github.com/sm1ky/remnawave-api/tree/44f5be0bb30e92682c6fcb8d1ce0db2285413959

Workflow

Publishing configuration: github.com/sm1ky/remnawave-api/blob/44f5be0bb30e92682c6fcb8d1ce0db2285413959/.github/workflows/upload.yml
Publishing logs: github.com/sm1ky/remnawave-api/actions/runs/36179018446/attempts/1

Artifact

Subject: remnawave_api-3.4.5.tar.gz
SHA-256 checksum: fe15fbe6d400745df2d3e0163ef0ea5a4ad11c6a32400141c47d99e146a5c8b7 Verifying attestations

Release files / remnawave_api-3.4.5-py3-none-any.whl

Download URL	remnawave_api-3.4.5-py3-none-any.whl
Size	109.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1191d92003d0d3ec511706f21d579d1c44adaa90033631aae9ac98bc40113344`
BLAKE2b-256 checksum How to use checksums	`ef09730d0315695adeaafc181482dbc3dc55054979c08892974a1f9627572be6`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.8`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/sm1ky/remnawave-api
Publishing commit: github.com/sm1ky/remnawave-api/tree/44f5be0bb30e92682c6fcb8d1ce0db2285413959

Workflow

Publishing configuration: github.com/sm1ky/remnawave-api/blob/44f5be0bb30e92682c6fcb8d1ce0db2285413959/.github/workflows/upload.yml
Publishing logs: github.com/sm1ky/remnawave-api/actions/runs/36179018446/attempts/1

Artifact

Subject: remnawave_api-3.4.5-py3-none-any.whl
SHA-256 checksum: 1191d92003d0d3ec511706f21d579d1c44adaa90033631aae9ac98bc40113344 Verifying attestations