vnfinancialdata

Python interface for Vietnamese listed-company financial statement data.

Current Development Status

Package version:

0.1.0

Dataset revision:

v1.0.0

The dataset is currently hosted as a private Hugging Face dataset.

Installation

For local development:

pip install -e .

Authentication

Access to the private dataset requires Hugging Face authentication.

Run:

hf auth login

before accessing the dataset.

Basic Usage

import vnfinancialdata as vnf

vnf.check_access()

df = vnf.load(
    exchange="HSX",
    statement="balance_sheet"
)

print(df.head())

Supported Exchanges

• HSX
• HNX

Supported Financial Statements

• balance_sheet
• cash_flow
• income_statement

Dataset Versioning

The package version and dataset revision are managed separately.

Current package version:

0.1.0

Current dataset revision:

v1.0.0

Current dataset schema version:

1.0

Data Source

The package retrieves financial-statement data from a version-pinned Hugging Face dataset repository.

The dataset is stored in Parquet format and organized by:

• exchange
• financial statement type

Current Access Status

The dataset is currently private.

Users must have permission to access the Hugging Face dataset repository and must authenticate locally before using the package.