Basic Response¶
The output of every command is an object which contains the results of the request, along with additional information. It is a custom class, VfObject, and always returns with the four attributes listed below:
results: ... # Serializable results parsed by VietFin.
provider: ... # Provider name.
extra: ... # Additional metadata about the command run.
raw_data: ... # Raw data returned from the API call.
There are also additional class methods which are helpers to convert the results to a variety of formats.
to_df(): convertsresultsto a pandas Dataframeto_dict(): converts to a Python dictionaryto_numpy(): converts to a Numpy arrayto_csv(): converts to a CSV fileto_polars(): converts to a Polars DataFrame
Example¶
Let’s start with the command equity.profile() to get familiar with the response of a command.
[3]:
from vietfin import vf
# Get general info of a company by its stock ticker.
vnm = vf.equity.profile(symbol="vnm")
vnm
[3]:
VfObject
results: [{'symbol': 'VNM', 'name': 'VINAMILK', 'legal_name': 'Công ty Cổ phần Sữa ...
provider: tcbs
extra: {'command_run_at': '2024-02-28T05:54:31.539269+00:00', 'symbol': 'VNM', 'rec...
raw_data: {'id': None, 'companyName': 'Công ty Cổ phần Sữa Việt Nam', 'ticker': 'VN...
This command returns an instance of VfObject class. The results attribute of this instance stores the serializable results of the query, which were parsed by VietFin.
The data type of results in this example is List[Data]. Where Data is the Standardized Data Model of VietFin. The Data class is a flexible Pydantic model designed to accommodate various data structures for VietFin’s data processing pipeline as it’s structured to support dynamic field definitions.
[2]:
vnm.results
[2]:
[TcbsEquityProfileData(symbol='VNM', name='VINAMILK', legal_name='Công ty Cổ phần Sữa Việt Nam', stock_exchange='HOSE', long_description='Công ty Cổ phần Sữa Việt Nam (VNM) có tiền thân là Công ty Sữa – Cà Phê Miền Nam,\xa0được thành lập vào năm 1976. Công ty hoạt\xa0động chính trong lĩnh vực\xa0chế biến sản xuất, kinh doanh xuất nhập khẩu các\xa0sản phẩm sữa và các sản phẩm dinh dưỡng khác. VNM chính thức hoạt động theo mô hình công ty cổ phần từ năm\xa02003. VNM là công ty sữa lớn nhất Việt Nam với thị phần là hơn 50% trong ngành sữa Việt Nam.\xa0Sản phẩm của VNM được xuất khẩu trực tiếp đến\xa057\xa0nước trên thế giới. VNM được niêm yết và giao dịch\xa0trên Sở Chứng khoán Thành phố Hồ\xa0Chí Minh (HOSE) từ năm 2006.', company_url=Url('https://www.vinamilk.com.vn/'), employees=9663, industry_category='Thực phẩm và đồ uống')]
The provider attribute stores the provider’s name which was used in the function.
[3]:
vnm.provider
[3]:
'tcbs'
The extra attribute is a dictionary which stores additional metadata about the command run, such as:
command_run_at: the datetime at which the command was executedsymbol: the symbol for which the command is runrecords_count: the number of records returned by the commandapi_url: the API url(s) called by the command
[4]:
vnm.extra
[4]:
{'command_run_at': '2024-02-27T01:47:27.994906+00:00',
'symbol': 'VNM',
'records_count': 1,
'api_url': ['https://apipubaws.tcbs.com.vn/tcanalysis/v1/company/VNM/overview',
'https://apipubaws.tcbs.com.vn/tcanalysis/v1/ticker/VNM/overview']}
The raw_data attribute is a dictionary which stores the raw data returned by the API request, uninterpreted by VietFin. This might be useful for users who are curious, and want to parse the API response themselves.
[4]:
vnm.raw_data
[4]:
{'id': None,
'companyName': 'Công ty Cổ phần Sữa Việt Nam',
'ticker': 'VNM',
'companyProfile': '<div style="FONT-FAMILY: Arial; FONT-SIZE: 10pt;">Công ty Cổ phần Sữa Việt Nam (VNM) có tiền thân là Công ty Sữa – Cà Phê Miền Nam, được thành lập vào năm 1976. Công ty hoạt động chính trong lĩnh vực chế biến sản xuất, kinh doanh xuất nhập khẩu các sản phẩm sữa và các sản phẩm dinh dưỡng khác. VNM chính thức hoạt động theo mô hình công ty cổ phần từ năm 2003. VNM là công ty sữa lớn nhất Việt Nam với thị phần là hơn 50% trong ngành sữa Việt Nam. Sản phẩm của VNM được xuất khẩu trực tiếp đến 57 nước trên thế giới. VNM được niêm yết và giao dịch trên Sở Chứng khoán Thành phố Hồ Chí Minh (HOSE) từ năm 2006.</div>\r\n<quillbot-extension-portal></quillbot-extension-portal><quillbot-extension-portal></quillbot-extension-portal>',
'historyDev': '<div style="FONT-FAMILY: Arial; FONT-SIZE: 10pt;">\r\n<ul>\r\n\t<li>Năm 1976: Tiền thân của công ty là Công ty Sữa – Cà Phê Miền Nam, trực thuộc Tổng Cục thực phẩm được thành lập;</li>\r\n\t<li>Năm 1978: Đổi tên thành Xí nghiệp liên hợp Sữa Cafe và Bánh kẹo I;</li>\r\n\t<li>Năm 1989: Nhà máy sữa bột Dielac đi vào hoạt động;</li>\r\n\t<li>Năm 1991: Cuộc “cách mạng trắng” khởi đầu chương trình xây dựng vùng nguyên liệu sữa tươi. Lần đầu tiên giới thiệu sản phẩm sữa UHT và sữa chua;</li>\r\n\t<li>Tháng 3/1992: Xí Nghiệp liên hiệp Sữa Cafe và Bánh kẹo I chính thức đổi tên thành Công ty Sữa Việt Nam;</li>\r\n\t<li>Năm 1994: Xây dựng thêm một nhà máy sữa Hà Nội;</li>\r\n\t<li>Năm 2003: Xây thêm nhà máy sữa Cần Thơ;</li>\r\n\t<li>Tháng 11/2003: Công ty chuyển sang hình thức cổ phần, chính thức đổi tên là Công ty Cổ phần Sữa Việt Nam (Vinamilk);</li>\r\n\t<li>Tháng 04/2004: Mua nhà máy sữa Sài Gòn (Saigon milk), tăng vốn điều lệ lên 1.590 tỷ đồng;</li>\r\n\t<li>Ngày 19/01/2006: Cổ phiếu của Vinamilk chính thức giao dịch trên HOSE;</li>\r\n\t<li>Tháng 09/2010: Là doanh nghiệp đầu tiên của Việt Nam lọt vào danh sách 200 công ty vừa và nhỏ tốt nhất Châu Á của Forbes;</li>\r\n\t<li>Tháng 06/2012: Nhà máy sữa Đà Nẵng đi vào hoạt động;</li>\r\n\t<li>Ngày 21/10/2013: Sở Kế hoạch và Đầu tư tỉnh Thanh Hóa cấp giấy chứng nhận đăng kí kinh doanh cho công ty TNHH Bò sữa Thống Nhất, Thanh Hóa. Vinamilk nắm giữ 96,33% vốn điều lệ;</li>\r\n\t<li>Năm 2014: Góp 51% vốn thành lập Công ty AngkorMilk tại thị trường Campuchia và góp 100% vốn thành lập công ty con Vinamilk Europe Spostkaz Ograniczona Odpowiedzialnoscia tại Ba Lan;</li>\r\n\t<li>Năm 2016: Tham gia góp 18% vào CTCP APIS nhằm mở rộng và phát triển chuỗi giá trị các sản phẩm của Vinamilk và thành lập Văn phòng đại diện Thái Lan;</li>\r\n\t<li>Năm 2017: Thành lập Trung tâm Sữa tươi nguyên liệu Củ Chi, đầu tư vào ngành đường với việc nắm<br />\r\n\t65% cổ phần của Công ty Cổ phần Đường Việt Nam (tiền thân là Công ty Cổ phần Đường Khánh Hoà) và 25% góp vốn vào Công ty Cổ phần Chế Biến Dừa Á Châu;</li>\r\n\t<li>Ngày 12/10/2018: Tăng vốn điều lệ lên 17.416.877.930.000 đồng;</li>\r\n\t<li>Năm 2019: Đầu tư nắm giữ 75% cổ phần của Công ty Cổ phần GTNFoods, qua đó tham gia điều hành Công ty Cổ phần Sữa Mộc Châu;</li>\r\n\t<li>Ngày 26/10/2020: Tăng vốn điều lệ lên 20.899.554.450.000 đồng;</li>\r\n</ul>\r\n</div>\r\n<quillbot-extension-portal></quillbot-extension-portal><quillbot-extension-portal></quillbot-extension-portal>',
'companyPromise': '<div style="FONT-FAMILY: Arial; FONT-SIZE: 10pt;">\r\n<ul>\r\n\t<li>Theo Tập đoàn nghiên cứu thị trường Euromonitor, doanh thu sữa và các sản phẩm từ sữa của Việt Nam dự kiến sẽ duy trì ở mức 7-8%/năm trong giai đoạn 2021 - 2025, đạt tổng giá trị khoảng 93,8 nghìn tỷ đồng vào năm 2025. Trong đó, sữa chua được kỳ vọng có tốc độ tăng trưởng cao nhất với tốc độ tăng trưởng CAGR là 12%/năm.</li>\r\n\t<li>Thu nhập bình quân đầu người có xu thế gia tăng, kết hợp với xu thế cải thiện thiện sức khỏe và tầm vóc của người Việt Nam khiến cho nhu cầu tiêu thụ các sản phẩm sữa luôn giữ mức tăng trưởng cao. Ngoài ra, sữa được xem là mặt hàng thiết yếu nên ít chịu ảnh hưởng bởi khủng hoảng kinh tế.</li>\r\n</ul>\r\n</div>\r\n<quillbot-extension-portal></quillbot-extension-portal><quillbot-extension-portal></quillbot-extension-portal>',
'businessRisk': '<div style="FONT-FAMILY: Arial; FONT-SIZE: 10pt;">\r\n<ul>\r\n\t<li>Rủi ro biến động giá nguyên liệu: Giá thức ăn chăn nuôi có thể tăng đột ngột do ảnh hưởng của thời tiết hoặc thị trường hàng hóa.</li>\r\n\t<li>Rủi ro sự thay đổi sở thích của người tiêu dùng: Sự thay đổi trong sở thích của người tiêu dùng có thể làm giảm nhu cầu tiêu thụ sản phẩm sữa truyền thống.</li>\r\n</ul>\r\n</div>\r\n<quillbot-extension-portal></quillbot-extension-portal><quillbot-extension-portal></quillbot-extension-portal>',
'keyDevelopments': '<div style="FONT-FAMILY: Arial; FONT-SIZE: 10pt;">\r\n<ul>\r\n\t<li>Sản xuất và kinh doanh bánh, sữa đậu nành, nước giải khát, sữa hộp, sữa bột, bột dinh dưỡng và các sản phẩm từ sữa khác;</li>\r\n\t<li>Sản xuất, mua bán rượu, bia, đồ uống, thực phẩm và nhiều loại cà phê;</li>\r\n\t<li>Chăn nuôi bò sữa, cung cấp giống vật nuôi và kỹ thuật nuôi; </li>\r\n</ul>\r\n</div>\r\n<quillbot-extension-portal></quillbot-extension-portal><quillbot-extension-portal></quillbot-extension-portal>',
'businessStrategies': '<div style="FONT-FAMILY: Arial; FONT-SIZE: 10pt;">\r\n<ul>\r\n\t<li>Tiếp tục duy trì vị trí số 1 trong ngành sữa Việt Nam và tiến tới mục tiêu trở thành 1 trong Top 30 Công ty Sữa lớn nhất thế giới về doanh thu;</li>\r\n\t<li>Tiếp tục nghiên cứu và phát triển nhiều sản phẩm mới với mục đích cách tân và đa dạng hóa danh mục sản phẩm trên cơ sở phù hợp với thị hiếu của người tiêu dùng và nhu cầu của khách hàng;</li>\r\n\t<li>Nâng cấp và xây dựng mới các trang trại tích hợp hệ thống máy móc thiết bị tiên tiến theo hướng phát triển bền vững và phù hợp với biến đổi khí hậu;</li>\r\n\t<li>Tìm kiếm các cơ hội M&A với các công ty sữa tại các quốc gia khác với mục đích mở rộng thị trường và tăng doanh số;</li>\r\n\t<li>Chú trọng đầu tư phát triển hoạt động R&D, phát triển thực phẩm hữu cơ và ứng dụng Công nghệ sinh học tiên tiến nhằm hướng đến mục tiêu trở thành biểu tượng niềm tin hàng đầu Việt Nam về sản phẩm dinh dưỡng và sức khỏe phục vụ cuộc sống con người;</li>\r\n\t<li>Tiếp cận và xúc tiến một cách linh hoạt và đa dạng các loại hình hợp tác kinh doanh với đối tác quốc tế;</li>\r\n</ul>\r\n</div>\r\n<quillbot-extension-portal></quillbot-extension-portal><quillbot-extension-portal></quillbot-extension-portal>',
'exchange': 'HOSE',
'shortName': 'VINAMILK',
'industryID': 218,
'industryIDv2': '3577',
'industryIdLevel2': '3500',
'industryIdLevel4': '3577',
'industry': 'Thực phẩm và đồ uống',
'industryEn': 'Food & Beverage',
'establishedYear': '2003',
'noEmployees': 9663,
'noShareholders': 0,
'foreignPercent': 0.529,
'website': 'https://www.vinamilk.com.vn',
'stockRating': 2.8,
'deltaInWeek': 0.001,
'deltaInMonth': 0.022,
'deltaInYear': -0.187,
'outstandingShare': 2090.0,
'issueShare': 2090.0,
'companyType': 'CT'}