Skip to main content

Python package to fetch Vietnam stock market data

Project description

VietFin

VietFin

A python library to fetch Vietnam stock market data.

License Documentation Status PyPI - Version
» Explore the docs »


Table of Contents

  1. Why VietFin?
  2. Installation
  3. Usage
  4. Contributing
  5. Attributions
  6. Disclaimer
  7. Contacts

1. Why VietFin?

Heavily inspired by OpenBB, VietFin is a Python package which provides a wrapper around the publicly available APIs from multiple brokerage firms.

This package aims to reproduce the hierarchical structure of commands used in OpenBB, but for Vietnamese market data.

VietFin is intended for personal use, research and educational purposes.

2. Installation

VietFin is available on PyPI. To use the package:

  1. Install VietFin in your project's virtual environment.

    $ pip install vietfin
    

    Or using Poetry, my preferred dependency manager:

    $ poetry add vietfin
    
  2. Import the package then use the package

    from vietfin import vf
    

Requirements:

3. Usage

from vietfin import vf
# Get list of all stocks
vf.equity.search()

# Get general info of a stock
vf.equity.profile(symbol='vnm')

# Get historical price of a stock
vf.equity.historical(symbol='vnm')

# Get the historical dividends data of a company
vf.equity.fundamental.dividends(symbol='vnm')

# Get list of key executives of a company
vf.equity.fundamental.management(symbol='vnm')

# Get the key financial ratios of a company
vf.equity.fundamental.ratios(symbol='vnm')

# Get the report on the income statement of a company
vf.equity.fundamental.income(symbol='vnm')

# Get the historical events of a stock ticker
vf.equity.calendar.events(symbol='vnm')

# Get the list of available mutual funds
vf.funds.search()

# Get the list of available ETFs
vf.etf.search()

# Get the list of constituents of an index
vf.index.constituents(symbol='vn30')

# Get the list of available futures contract
vf.derivatives.futures.search()

4. Contributing

More information on our Contributing Guidelines and Code of Conduct.

VietFin relies on community to investigate bugs and contribute code.

Before creating a ticket, please check our Issues tracker to avoid duplicates.

Feel free to reach out to us in our GitHub Discussions for other feedbacks (e.g. Q&A, ideas, etc.).

5. Attributions

VietFin is built on top of the inspiration and work of the following projects:

6. Disclaimer

VietFin is not affiliated, endorsed, or vetted by any of the brokerage firms or research entities which provide the data. It's an open-source tool which fetches data from the publicly available APIs of these firms. VietFin is intended for personal use, research and educational purposes.

You should refer to each of the data provider's terms of use for details on your rights to use the actual data downloaded.

The data retrieved by the VietFin package is not necessarily accurate.

VietFin and any provider of the data contained in this website will not accept liability for any loss or damage as a result of your trading, or your reliance on the information displayed.

7. Contacts

If you have any questions about VietFin or just to say hi, feel free to open a new public discussion in our GitHub repo, or send an email to vietfin.numbness179(at)simplelogin.fr.

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

vietfin-0.2.0.tar.gz (58.3 kB view details)

Uploaded Source

Built Distribution

vietfin-0.2.0-py3-none-any.whl (112.2 kB view details)

Uploaded Python 3

File details

Details for the file vietfin-0.2.0.tar.gz.

File metadata

  • Download URL: vietfin-0.2.0.tar.gz
  • Upload date:
  • Size: 58.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Windows/10

File hashes

Hashes for vietfin-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ce16ee202603fd9ab167bf89f772a42e4abc913812977da4cb5ec4a043fc8691
MD5 ed7f2a180f7e98cb30ccb90008eefa2e
BLAKE2b-256 d68c430b17496458bbbf0dd335ab460c8fb1ffa8b4c8037dcfca1e4c6854721a

See more details on using hashes here.

File details

Details for the file vietfin-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: vietfin-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 112.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Windows/10

File hashes

Hashes for vietfin-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae1fb8418a09c2afbbe3f7b957b49e13cb9f826e94b856666c56cb5d83505fa4
MD5 bed3be6f90ba85493fa6835f6e7b7661
BLAKE2b-256 a46ba323d6962262d7f72a331d79e9838ff750a6dcf8a16f3869ca95fa0218c1

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