Dividends¶
Get the historical dividends data of a company.
Example:
Use equity.fundamental.dividends() with default parameters: provider (TCBS), limit (100).
from vietfin import vf
# Get the historical dividends data of company FPT
vf.equity.fundamental.dividends(symbol="fpt")
Parameters¶
param_name |
type |
description |
default_value |
is_required |
|---|---|---|---|---|
symbol |
str |
Symbol to get data for. |
TRUE |
|
limit |
int |
|
100 |
FALSE |
provider |
Literal[“tcbs”] |
The provider to use for the query |
tcbs |
FALSE |
Data Model¶
field_name |
type |
description |
|---|---|---|
symbol |
str |
Symbol representing the entity requested in the data. |
dividend_type |
str |
Type of the dividend, i.e. “cash”, “stock”. |
payment_date |
datetime |
The payment date of the dividend. |
cash_dividend_percentage |
float |
NOTE: I don’t know the description of this field. |