izzzzzi/py3xui

py3xui is a Python toolkit that lets you programmatically control a 3x-ui server. 3x-ui is a popular panel for managing proxy connections, the kind of thing you might use to run a personal VPN or proxy service. Instead of clicking around a web interface to add users, set traffic limits, or configure connection rules, this library lets your Python code do it automatically. You could use it to build a bot that provisions new proxy accounts for users, manage traffic quotas, or generate connection strings and QR codes that users scan to connect. The library gives you two ways to talk to a 3x-ui server: a standard synchronous mode and an asynchronous mode. Both expose the same capabilities, so you pick whichever fits your project. You create a connection object with your server address and credentials, call a login step, and then you can start doing things like listing existing connection setups (called "inbounds"), adding new ones, finding users by email, updating their traffic limits, or creating new client accounts. The data comes back as structured Python objects rather than raw JSON, which makes it easier to work with. Someone running a proxy or VPN service would find this useful. For example, if you run a Telegram bot where users pay for VPN access, you could use this library to automatically create a new client when someone subscribes, set their data cap to 100 GB, generate a QR code they can scan to connect, and update their limits when they renew. Without a library like this, you'd be writing raw HTTP requests and parsing JSON responses yourself. One practical note: the 3x-ui app itself is still under active development, and the library author isn't affiliated with that project, so compatibility isn't guaranteed with every version. The SDK requires 3x-ui version 2.3.7 or newer. The README doesn't go into detail about what happens when newer versions of 3x-ui introduce breaking changes, so if you're building something production-critical, that's worth keeping in mind.