vDatafeed: A Python wrapper for Viet Nam Datafeed API
Project description
vDatafeed
vDatafeed: A Python wrapper for Viet Nam Datafeed API
Installation
pip install vdatafeed
Usage
Financial data
from vdatafeed import Datafeed, Config, EnumDatafeed
datafeed = Datafeed(
datafeed=EnumDatafeed.SSI.value,
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, EnumDatafeed
datafeed = Datafeed(
datafeed=EnumDatafeed.SSI.value,
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
Built Distribution
File details
Details for the file vdatafeed-1.1.4.tar.gz
.
File metadata
- Download URL: vdatafeed-1.1.4.tar.gz
- Upload date:
- Size: 12.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.12.6 Linux/6.8.0-1014-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 996075cdf09914c9aa6f7d6494c70b7075736481b04517ea9d317c3e07ca7140 |
|
MD5 | 9ec17691614ccc980fc7fc9622b89efe |
|
BLAKE2b-256 | e8f43e6369a751119689529dd72268ddb5b6e6802cfc621f1791cee13a900d22 |
File details
Details for the file vdatafeed-1.1.4-py3-none-any.whl
.
File metadata
- Download URL: vdatafeed-1.1.4-py3-none-any.whl
- Upload date:
- Size: 16.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.12.6 Linux/6.8.0-1014-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f767162f231458188e98646b682fea85faee0966534f090b4e94d88ab49bb2b |
|
MD5 | b4663a4525a95ecab1c0e582c1f8eb5e |
|
BLAKE2b-256 | 742d7af90cb002c8e4c46ceb61fdafb33449dab7ff22854f708f4e321b37abe2 |