hiddify/xtlsapi

Python library to communicate with xray core

xtlsapi

Python library to communicate with xray core

Install it from PyPI

pip install xtlsapi

Usage

from xtlsapi import XrayClient, utils, exceptions

xray_client = XrayClient('1.2.3.4', 1234)
user_id = utils.generate_random_user_id()
user_email = utils.generate_random_email()
inbound_tag = 'inbound-tag'

# Get stats
print(utils.human_readable_bytes(xray_client.get_client_download_traffic('[email protected]')))
print(utils.human_readable_bytes(xray_client.get_client_upload_traffic('[email protected]')))
print(utils.human_readable_bytes(xray_client.get_inbound_download_traffic(inbound_tag)))
print(utils.human_readable_bytes(xray_client.get_inbound_upload_traffic(inbound_tag)))

# Add & Remove client
user = xray_client.add_client(inbound_tag, user_id, user_email)
if user:
    print(user)
    xray_client.remove_client(inbound_tag, user_email)

# restart logger
xray_client.restart_logger()

Development

Read the CONTRIBUTING.md file.

xtlsapi's Issues

add/remove inbound/outbound api

Is your feature request related to a problem? Please describe.
No.

Describe the solution you'd like
Can we have add/remove inbound/outbound api as well? Seems like add/remove clients are the only apis implemented for handler.

Describe alternatives you've considered
I don't think so.

Additional context
Currently I just call a "xray api" subprocess to do the job. But it requires to create a json file somewhere on disk and it's not a very elegent solution. I rather find a way do it more "natively".

sign box support?

sing box seems to use v2ray core too. would this lib be able to use sing box soon?

can you tell me what the api can do?

I don't know what the api can do? can someone tell me? Give some examples. Thank you!

Api Add Users

hello,

if we add a new account using xtlsapi then restart xray-core, all account will be reset.
can you update so the account will be permanent?

thanks