🚀 MarzbanSDK

MarzbanSDK is a fully typed client library for interacting with the Marzban API. It supports both browser and Node.js environments, providing seamless integration and enhanced developer experience.

📖 Table of Contents

• ✨ Features
• 📦 Installation
• 🚀 Quick Start
• 🔍 How It Works
• 📚 API Documentation
• 📡 WebSocket Support
• 🤝 Contributing
• 📜 License
• ⭐ Support the Project

✨ Features

• ✅ Full TypeScript Support – Schema definitions for all parameters, responses, and methods.
• 🔄 Automatic Token Refresh – Keeps your session alive without manual intervention.
• 🔁 Retry Mechanism – Ensures resilience against network failures.
• 🛠️ Comprehensive API Support – Access all Marzban API features.
• 📡 WebSocket Support – Real-time log streaming from core services and nodes.

📦 Installation

Install MarzbanSDK via npm:

1npm install marzban-sdk

Or using yarn:

1yarn add marzban-sdk

🚀 Quick Start

1import { MarzbanSDK, Config } from "marzban-sdk";
2
3const config: Config = {
4  baseUrl: "https://api.example.com",
5  username: "your-username",
6  password: "your-password",
7  retries: 3, // Option. default 3
8  token: 'token' // Option
9};
10
11const sdk = new MarzbanSDK(config);
12
13// Fetch user details
14sdk.user.getUserById("user-id").then((user) => {
15  console.log(user);
16});
17
18// get an authorization token
19sdk.getAuthToken().then((token) => {
20  console.log(token)
21});

🔍 How It Works

1️⃣ Full Typing and Schema

MarzbanSDK provides full TypeScript typing and schema definitions for all API methods, parameters, and responses.

2️⃣ Generated Sources

The SDK is auto-generated from the OpenAPI specification, ensuring it stays up-to-date with API changes.

• The entry point for the SDK is the MarzbanSDK class.
• All API methods are dynamically generated based on the OpenAPI schema.

📚 API Documentation

For detailed API reference, visit the API Documentation.

📡 WebSocket Support

MarzbanSDK supports WebSocket for real-time log streaming.
You can receive logs from both the core server and individual nodes.

For more details, check the WebSocket Guide.

🤝 Contributing

We welcome contributions! If you'd like to improve MarzbanSDK, please:

1. Fork the repository 🚀
2. Create a new branch 🔧
3. Submit a pull request 🎉

For details, check our Contribution Guidelines.

📜 License

This project is licensed under the MIT License.

⭐ Support the Project

If you find marzban-sdk useful, please give it a star on GitHub! It helps us stay motivated and grow the project.