Skip to main content

vDatafeed: A Python wrapper for Viet Nam Datafeed API

Project description

vDatafeed

vDatafeed: A Python wrapper for Viet Nam Datafeed API

PyPI - Version Python Version PyPI - Downloads License: MIT

Installation

pip install vdatafeed

Usage

Financial data

from vdatafeed import Datafeed, Config


datafeed = Datafeed(
    datafeed='ssi',
    config=Config(
        ssi_datafeed_id="<SSI_DATAFEED_ID>",
        ssi_datafeed_secret="<SSI_DATAFEED_SECRET>"
    )
)

# Get list of instruments
datafeed.api.get_instruments()
# Get instrument details
datafeed.api.get_instrument_details("SSI")
# Get list of indices
datafeed.api.get_indices()
# Get list of instruments in an index
datafeed.api.get_indices_instruments("VN30")
# Get daily instruments info
datafeed.api.get_daily_instruments_info(instrument="SSI", from_date="2024-09-01", to_date="2024-09-10")
# Get daily all instruments info
datafeed.api.get_daily_instruments_info(from_date="2024-09-10", to_date="2024-09-10")
# Get daily indices info
datafeed.api.get_daily_indices_info(index="VN30", from_date="2024-09-01", to_date="2024-09-10")
# Get end of day OHLCV
datafeed.api.get_endofday_ohlcv(instrument="SSI", from_date="2024-09-01", to_date="2024-09-10")
# Get intraday OHLCV
datafeed.api.get_intraday_ohlcv(instrument="SSI", from_date="2024-09-01", to_date="2024-09-10")

Streaming data

import asyncio
from vdatafeed import Datafeed, Config


datafeed = Datafeed(
    datafeed='ssi',
    config=Config(
        ssi_datafeed_id="<SSI_DATAFEED_ID>",
        ssi_datafeed_secret="<SSI_DATAFEED_SECRET>"
    )
)



def on_trade_message(msg):
    """
    Handle the incoming trade message.
    Args:
        msg (str): The message received.
    Returns:
        None
    """
    print(f"TRADE: {msg}")


def on_quote_message(msg):
    """
    Handle the incoming quote message.
    Args:
        msg (str): The message received.
    Returns:
        None
    """
    print(f"QUOTE: {msg}")


asyncio.run(
    datafeed.hub.listen(
        input("Please select Symbol(SSI)/Index(VNINDEX/VN30) or list(SSI,VCB): "),
        on_trade_message,
        on_quote_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

vdatafeed-1.1.2.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

vdatafeed-1.1.2-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file vdatafeed-1.1.2.tar.gz.

File metadata

  • Download URL: vdatafeed-1.1.2.tar.gz
  • Upload date:
  • Size: 12.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 vdatafeed-1.1.2.tar.gz
Algorithm Hash digest
SHA256 bbcccd5e0317b7c43790bd0349b3c6dce994820145af05f83c9cb5fa8c8b3f3b
MD5 16d1bea8b290ae7ec6fb42b04f3cc12b
BLAKE2b-256 9a931bbfaa12e7e5618607b4c8c25ed07daeea66d29e90a709b86ce859f3cb4f

See more details on using hashes here.

File details

Details for the file vdatafeed-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: vdatafeed-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 16.2 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 vdatafeed-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 620c005b3f622be18ff22ae9f42313f27dd96ef5a4813a151f2c10c83fc0195e
MD5 91c4dd8b8ade4b9b3dabbf2a7b5c5f2b
BLAKE2b-256 ae49d774c887158353baae20a97515ba8d956724da6705d55dda552bcad6bc2c

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