pymarz 1.0.1

Asynchronous Python library for interacting with Marzban

pymarz

pymarz is an asynchronous Python library designed for interacting with Marzban. It provides comprehensive methods for managing administrators, users, nodes, and system statistics.

Requirements.

Python 3.7+

Installation & Usage

pip install

pip install pymarz

install from repository

you can install directly form github repository using:

pip install git+https://github.com/SSaeedHoseini/pymarz.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/SSaeedHoseini/pymarz.git)

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Getting Started

Please follow the installation procedure and then run the following:

from asyncio import run

from pymarz import MarzAPI

pyload = {
    "url": "your-domain",
    "username": "admin-username",
    "password": "admin-password",
}


async def main():
    client = MarzAPI(**pyload)

    hosts = await client.host.get_all()

    print(hosts)


if __name__ == "__main__":
    try:
        run(main())
    except Exception as e:
        print(str(e))

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdminApi	admin_token	POST /api/admin/token	Admin Token
AdminApi	create_admin	POST /api/admin	Create Admin
AdminApi	get_admins	GET /api/admins	Get Admins
AdminApi	get_current_admin	GET /api/admin	Get Current Admin
AdminApi	modify_admin	PUT /api/admin/{username}	Modify Admin
AdminApi	remove_admin	DELETE /api/admin/{username}	Remove Admin
CoreApi	get_core_config	GET /api/core/config	Get Core Config
CoreApi	get_core_stats	GET /api/core	Get Core Stats
CoreApi	modify_core_config	PUT /api/core/config	Modify Core Config
CoreApi	restart_core	POST /api/core/restart	Restart Core
NodeApi	add_node	POST /api/node	Add Node
NodeApi	get_node	GET /api/node/{node_id}	Get Node
NodeApi	get_node_settings	GET /api/node/settings	Get Node Settings
NodeApi	get_nodes	GET /api/nodes	Get Nodes
NodeApi	get_usage	GET /api/nodes/usage	Get Usage
NodeApi	modify_node	PUT /api/node/{node_id}	Modify Node
NodeApi	reconnect_node	POST /api/node/{node_id}/reconnect	Reconnect Node
NodeApi	remove_node	DELETE /api/node/{node_id}	Remove Node
SubscriptionApi	user_get_usage	GET /sub/{token}/usage	User Get Usage
SubscriptionApi	user_subscription	GET /sub/{token}/	User Subscription
SubscriptionApi	user_subscription_info	GET /sub/{token}/info	User Subscription Info
SubscriptionApi	user_subscription_with_client_type	GET /sub/{token}/{client_type}	User Subscription With Client Type
SystemApi	get_hosts	GET /api/hosts	Get Hosts
SystemApi	get_inbounds	GET /api/inbounds	Get Inbounds
SystemApi	get_system_stats	GET /api/system	Get System Stats
SystemApi	modify_hosts	PUT /api/hosts	Modify Hosts
UserApi	add_user	POST /api/user	Add User
UserApi	delete_expired_users	DELETE /api/users/expired	Delete Expired Users
UserApi	get_expired_users	GET /api/users/expired	Get Expired Users
UserApi	get_user	GET /api/user/{username}	Get User
UserApi	get_user_usage	GET /api/user/{username}/usage	Get User Usage
UserApi	get_users	GET /api/users	Get Users
UserApi	get_users_usage	GET /api/users/usage	Get Users Usage
UserApi	modify_user	PUT /api/user/{username}	Modify User
UserApi	remove_user	DELETE /api/user/{username}	Remove User
UserApi	reset_user_data_usage	POST /api/user/{username}/reset	Reset User Data Usage
UserApi	reset_users_data_usage	POST /api/users/reset	Reset Users Data Usage
UserApi	revoke_user_subscription	POST /api/user/{username}/revoke_sub	Revoke User Subscription
UserApi	set_owner	PUT /api/user/{username}/set-owner	Set Owner
UserTemplateApi	add_user_template	POST /api/user_template	Add User Template
UserTemplateApi	get_user_template_endpoint	GET /api/user_template/{id}	Get User Template Endpoint
UserTemplateApi	get_user_templates	GET /api/user_template	Get User Templates
UserTemplateApi	modify_user_template	PUT /api/user_template/{id}	Modify User Template
UserTemplateApi	remove_user_template	DELETE /api/user_template/{id}	Remove User Template
DefaultApi	base	GET /	Base

Documentation For Models

• Admin
• AdminCreate
• AdminModify
• CoreStats
• HTTPValidationError
• LocationInner
• NodeCreate
• NodeModify
• NodeResponse
• NodeSettings
• NodeStatus
• NodeUsageResponse
• NodesUsageResponse
• Port
• ProxyHost
• ProxyHostALPN
• ProxyHostFingerprint
• ProxyHostSecurity
• ProxyInbound
• ProxyTypes
• SubscriptionUserResponse
• SystemStats
• Token
• UserCreate
• UserDataLimitResetStrategy
• UserModify
• UserResponse
• UserStatus
• UserStatusCreate
• UserStatusModify
• UserTemplateCreate
• UserTemplateModify
• UserTemplateResponse
• UserUsageResponse
• UserUsagesResponse
• UsersResponse
• UsersUsagesResponse
• ValidationError

Project Links

• PyPI: marzban
• GitHub Repository: pymarz

Contributing

We welcome contributions! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a Pull Request (PR).

Support

If you have any questions or need assistance, you can contact the author via:

• Telegram: @SSaeedhoseini

License

This project is licensed under the MIT License. For more details, refer to the LICENSE file.