Skip to main content
<h1>V2Ray Python API</h1>
<p>This is a Python API for V2Ray that allows users to create and delete V2Ray accounts programmatically. It provides an easy-to-use interface that allows developers to automate the process of creating and deleting accounts.</p>
<p>[Github-flavored Markdown](https://guides.github.com/features/mastering-markdown/)</p>
<h2>Requirements</h2>
<ul>
    <li>Python 3.x</li>
    <li><code>requests</code> module</li>
</ul>
<h2>Usage</h2>
<h3>Creating an account</h3>
<p>To create a new V2Ray account, instantiate the <code>V2Ray</code> class and call the <code>create_account</code> method with the following parameters:</p>
<ul>
    <li><code>protocol</code>: string, must be either <code>'vmess'</code> or <code>'vless'</code></li>
    <li><code>remark</code>: string, the name of the account</li>
    <li><code>total</code>: integer, the total amount of data that the account is allowed to use (in GB)</li>
    <li><code>expire</code>: integer, the number of days until the account expires</li>
    <li><code>port</code>: integer (optional), the port number to use for incoming connections (default is a random port between 11111 and 55555)</li>
    <li><code>alert_id</code>: integer (optional), the alert ID to use for the account (default is 1)</li>
</ul>
<pre><code>from v2ray import V2Ray

v2ray = V2Ray('localhost', '8080', 'session_token')

result = v2ray.create_account('vmess', 'My V2Ray Account', 10, 30) if result: print(result) else: print('Failed to create account')

Deleting an account

To delete a V2Ray account, call the delete_account method with one of the following parameters:

  • by: string, the name of the account to delete
from v2ray import V2Ray

v2ray = V2Ray('localhost', '8080', 'session_token')

result = v2ray.delete_account('My V2Ray Account') if result: print(result) else: print('Failed to delete account')

License

This code is licensed under the MIT License. Feel free to use it in your own projects or modify it to suit your needs.

Wrote By

Wrote by @Santrich

Metadata

Release files for V2Ray 1.1

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

Source distribution (sdist)

Source distribution for V2Ray 1.1
File Size Uploaded
V2Ray-1.1.tar.gz 4.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for V2Ray 1.1
File Interpreter ABI Platform
V2Ray-1.1-py3-none-any.whl Python 3 none any Details

Total release size: 9.0 kB

Release files / V2Ray-1.1.tar.gz

Download URL V2Ray-1.1.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
40563ec53432509a2530639e7534902b4a188303562aa3247f866fb74266d6da
BLAKE2b-256 checksum
How to use checksums
1e2539de7e90f8289bc0d8e072de668d57c1ca7bb3cf3f62a9781f10e92126a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.10

Release files / V2Ray-1.1-py3-none-any.whl

Download URL V2Ray-1.1-py3-none-any.whl
Size 4.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7ffee4ef7ff02e13368a97a1ced60fcb61e130517bdbb236ba40789fe60da91b
BLAKE2b-256 checksum
How to use checksums
714a533a2cc5c399c62264a1a554715af13ee1bc6957ceca550ff6ccfebd9225
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.10

Release history Release notifications | RSS feed

This release

1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page