Skip to main content

vBroker: A Python wrapper for Viet Nam Broker API

Project description

vBroker

vBroker: A Python wrapper for Viet Nam Broker API

PyPI - Version Python Version PyPI - Downloads License: MIT

Installation

pip install vbroker

Usage

Basic usage

from vbroker import Broker, Config, EnumBroker

broker = Broker(
    broker=EnumBroker.SSI.value,
    config=Config(
        ssi_broker_account="666666",
        ssi_broker_id="<SSI_BROKER_ID>",
        ssi_broker_secret="<SSI_BROKER_SECRET>",
        ssi_broker_private_key="<SSI_BROKER_PRIVATE_KEY>"
    )
)

# Send OTP
print(broker.api.get_otp())
# Set OTP
broker.api.otp = "<OTP>"
# Get Token
print(broker.api.get_token())

# Get Orderbook History
print(broker.api.get_orderbook(account_no="6666661"))
print(broker.api.get_orderbook(account_no="6666668"))
print(broker.api.get_order_history(
    account_no="6666661", from_date="2021-09-18", to_date="2024-09-18")
)
print(broker.api.get_order_history(
    account_no="6666668", from_date="2024-09-18", to_date="2024-09-18")
)

# Get Max Buy/Sell Quantity
print(broker.api.get_max_buy_quantity(account_no="6666661", instrument="SSI", price=33.6))
print(broker.api.get_max_buy_quantity(account_no="6666668", instrument="VN30F2409", price=1315))
print(broker.api.get_max_sell_quantity(account_no="6666661", instrument="SSI", price=33.6))
print(broker.api.get_max_sell_quantity(account_no="6666668", instrument="VN30F2409", price=1315))

# Get Position/Account Balance
print(broker.api.get_equity_positions(account_no="6666661"))
print(broker.api.get_equity_account_balance(account_no="6666661"))

print(broker.api.get_derivative_positions(account_no="6666668"))
print(broker.api.get_derivative_account_balance(account_no="6666668"))

# Place Order
print(broker.api.place_equity_order(
    account_no="6666661", side="BUY", instrument="SSI", quantity=100, price=31)
)
print(broker.api.place_derivative_order(
    account_no="6666668", side="BUY", instrument="VN30F2409", quantity=1, price=1000)
)

Streaming order

import asyncio
from vbroker import Broker, Config, EnumBroker

broker = Broker(
    broker=EnumBroker.SSI.value,
    config=Config(
        ssi_broker_account="666666",
        ssi_broker_id="<SSI_BROKER_ID>",
        ssi_broker_secret="<SSI_BROKER_SECRET>",
        ssi_broker_private_key="<SSI_BROKER_PRIVATE_KEY>"
    )
)

broker.api.otp = "<OTP>"
print(broker.api.get_token())

def on_message(msg):
    print(f"MESSAGE: {msg}")


asyncio.run(broker.hub.listen(on_message))

MIT License

Copyright (c) 2024 Quant.vn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vbroker-0.1.4.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

vbroker-0.1.4-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file vbroker-0.1.4.tar.gz.

File metadata

  • Download URL: vbroker-0.1.4.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.12.5 Linux/6.5.0-1025-azure

File hashes

Hashes for vbroker-0.1.4.tar.gz
Algorithm Hash digest
SHA256 6c2b832388be08e52e81db395d7784c0e6a565710ccad6ed4228e851b6213230
MD5 87fccb927bc1428fc3bd1505301fb48c
BLAKE2b-256 a87ea3de0568bf38566794a91b2c3d0a27964e7f5ddce03d1b612b21127f1f8a

See more details on using hashes here.

File details

Details for the file vbroker-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: vbroker-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.12.5 Linux/6.5.0-1025-azure

File hashes

Hashes for vbroker-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 99f95534fb8f4d16854608b961e1164a0abdf0cf43895b557f9d0feadb333722
MD5 bfe26c51438e6ab5aa51b13bb39a7137
BLAKE2b-256 9f4009f95ffda10230383f7f229bb8011218f46429cde30a0db9932f42865bd1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page