{"repo":"iwatkot/py3xui","free":true,"listed":false,"github":"https://github.com/iwatkot/py3xui","clone":"git clone https://github.com/iwatkot/py3xui.git","description":"Sync and Async Object-oriented Python SDK for the 3x-ui API.","language":"Python","stars":170,"topics":["3x-ui","api","async","httpx","mypy","pylint","pytest","python","requests","sdk"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"⚠️ The legacy secret token feature was removed in 3x-UI 2.6.0. ⚠️ The project also supports optional bearer token authentication with the token constructor argument or XUI TOKEN environment variable for panels that expose token auth. Sync and Async Object-oriented Python SDK for the 3x-ui API. Overview • Quick Start • Examples • Bugs and Feature Requests • Documentation • PyPI ℹ️ If you need a JavaScript SDK, check out js3xui. Overview This SDK is designed to interact with the 3x-ui app in a more object-oriented way. It provides both synchronous and asynchronous methods to interact with the app. The SDK is designed to be as simple as possible to use, while still providing a lot of flexibility and uses Pydantic models to validate the data. Used dependencies: - requests for synchronous API - httpx for asynchronous API - pydantic for models Supported Python versions: - 3.11 - 3.12 Since the 3x-ui app is under development, the SDK may not be compatible with all versions of the app. The developer of SDK is not related to the 3x-ui app, therefore the latest versions of the software are not guaranteed to be compatible with the SDK. The SDK does not support versions of the 3x-ui older than 2.3.7 . Quick Start You can use both synchronous and asynchronous methods to interact with the 3x-ui app. Both APIs have the same methods and return the same data, so it's up to you to choose which one to use. After installing the SDK, you can create a new instance of the API. When creating a new i","default_branch":null,"files":null,"tree":[],"storefront":"/r/iwatkot","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/iwatkot/py3xui/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}