Skip to content

Latest commit

 

History

History
96 lines (72 loc) · 4.69 KB

README.md

File metadata and controls

96 lines (72 loc) · 4.69 KB

pyvietstock

Overview

pyvietstock is a Python library aimed at providing tools and functionalities for working with Vietstock Finance data (https://finance.vietstock.vn/). The library is currently under construction and is intended to offer a comprehensive suite of features for data retrieval, analysis, and visualization tailored for the Vietnamese stock market.

Features (Planned)

  • Retrieve historical data from Vietstock
  • Fetch detailed information about stock symbols
  • Support for various financial indicators and metrics

Implemented Functions Checklist

The function prototypes can be found under pyvietstock/finance.py. The response schemas are under pyvietstock/schema.py.

Data Retrieval

  • historical_data: Fetches historical price and volume data for a stock symbol within a specified date range.
  • trading_info: Retrieves detailed trading information for a stock symbol, including various financial metrics and market status.
  • market_prices: Retrieves current market prices for various financial instruments like VN-Index, HNX-Index, etc.
  • stock_deal_detail: Fetches detailed stock deal information from the current trading day.

Statistics

  • statistics_by_date_range: Fetches statistical data by date range for a specific stock symbol, including price changes, trading volumes, and extrema.
  • statistics_by_period: Retrieves statistical data by predefined periods (weekly, monthly, etc.) for a specific stock symbol.

Company Information

  • company_relation_filter: Retrieves filtered company relations based on the provided stock symbol, including financial metrics and market performance.
  • event_transfer_data: Retrieves event transfer data for a stock symbol, including various event details and transfers.
  • bond_related: Fetches bond-related data for a stock, including details like release date, due date, and interest rates.
  • documents: Fetches documents related to a stock symbol, such as financial reports or disclosures.

News

  • header_news: Fetches headline news from Vietstock, providing titles, URLs, and publication timestamps.
  • news_by_code: Fetches news related to a specific stock code, providing titles, URLs, and publication timestamps.
  • news_by_channel: Fetches news related to a specific channel, providing titles, URLs, and publication timestamps.
  • events_by_type: Retrieves events of a specific type for a stock symbol.
  • events_same_industry: Retrieves events related to the same industry as a stock symbol.

Financial Statements

  • [] financial_summary: Fetches a summary of financial data for a stock symbol, including revenue, profit, and other key metrics.
  • [] income_statement: Fetches income statement data for a stock symbol, audit, including revenue, expenses, and net income.
  • [] balance_sheet: Fetches balance sheet data for a stock symbol, including assets, liabilities, and equity.
  • [] cash_flow_statement: Fetches cash flow statement data for a stock symbol, including operating, investing, and financing activities.
  • [] financial_ratios: Fetches financial ratios for a stock symbol, including profitability, liquidity, and solvency ratios.

Installation

The library is not yet available for installation as it is still under active development. Once completed, it will be available via PyPI. You can install the library locally by running the following command:

pip install .

Usage

Use must login to Vietstock Finance to access full functionalities of the library. If you don't have an account, you can create one at https://finance.vietstock.vn/. A free account is restricted to access trading data only. Or you can set login environment variables in your system.

VIETSTOCK_LOGIN_EMAIL=
VIETSTOCK_LOGIN_PASSWORD=
from pyvietstock.finance import VietStockFinance
import os


vf = VietStockFinance() \
      .set_user_name(os.environ['VIETSTOCK_LOGIN_EMAIL']) \
      .set_password(os.environ['VIETSTOCK_LOGIN_PASSWORD']) \
      .login()

Example usage:

from pyvietstock.finance import VietStockFinance

vf = VietStockFinance().login()
print(vf.documents("FPT"))
print(vf.historical_data("FPT"))
print(vf.event_transfer_data("FPT"))
print(vf.bond_related("VIC"))

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For any questions or feedback, please open an issue or contact us directly at [[email protected]].

Project Status

Note: This project is currently under construction. Please check back later for updates.

Acknowledgments

  • Thanks to the contributors and the open-source community for their support.