A custom component to display stock information from Yahoo finance.
Currency details can be presented in an different currency than what is reported (target_currency). Data is downloaded at regular intervals (scan_interval) but a retry is attempted after 20 seconds in case of failure.
This can be installed through HACS or by copying all the files from custom_components/yahoofinance/ to <config directory>/custom_components/yahoofinance/.
Define the symbols to be tracked and optional parameters in configuration.yaml.
# Example configuration.yaml entry
yahoofinance:
symbols:
- ISTNXThe above configuration will generate an entity with the id sensor.yahoofinance_istnx and current value as the state along with these attributes:
state_class: measurement
attribution: Data provided by Yahoo Finance
currencySymbol: $
symbol: ISTNX
quoteType: MUTUALFUND
quoteSourceName: Delayed Quote
marketState: PRE
averageDailyVolume10Day: 0
averageDailyVolume3Month: 0
regularMarketChange: 0.35
regularMarketChangePercent: 0.5
regularMarketDayHigh: 0
regularMarketDayLow: 0
regularMarketPreviousClose: 69.93
regularMarketPrice: 70.28
regularMarketVolume: 0
regularMarketTime: 2024-05-10T19:00:27-05:00
dividendDate: null
forwardPE: 0
trailingPE: 0
fiftyDayAverage: 69.79
fiftyDayAverageChange: 0.49
fiftyDayAverageChangePercent: 0.7
preMarketChange: 0
preMarketChangePercent: 0
preMarketTime: 0
preMarketPrice: 0
postMarketChange: 0
postMarketChangePercent: 0
postMarketPrice: 0
postMarketTime: 0
twoHundredDayAverage: 62.94
twoHundredDayAverageChange: 7.34
twoHundredDayAverageChangePercent: 11.67
fiftyTwoWeekLow: 53.81
fiftyTwoWeekLowChange: 16.47
fiftyTwoWeekLowChangePercent: 30.61
fiftyTwoWeekHigh: 72.44
fiftyTwoWeekHighChange: -2.16
fiftyTwoWeekHighChangePercent: -2.98
trending: up
unit_of_measurement: USD
icon: mdi:trending-up
friendly_name: Ivy Science & Technology Fund C
- The attributes can be null if there is no data present.
- The
dividendDateis in ISO format (YYYY-MM-DD).
-
Data fetch interval can be adjusted by specifying the
scan_intervalsetting whose default value is 6 hours and the minimum value is 30 seconds.scan_interval: hours: 4
You can disable automatic update by passing
manualforscan_interval. -
Trending icons (trending-up, trending-down or trending-neutral) can be displayed instead of currency based icon by specifying
show_trending_icon.show_trending_icon: true
-
All numeric values are by default rounded to 2 places of decimal. This can be adjusted by the
decimal_placessetting. A value of 0 will return in integer values and -1 will suppress rounding.decimal_places: 3
-
The fifty_day, post, pre and two_hundred attributes can be suppressed as following. They are included by default.
include_fifty_day_values: false include_fifty_two_week_values: false include_post_values: false include_pre_values: false include_two_hundred_day_values: false
-
An alternate target currency can be specified for a symbol using the extended declaration format. Here, the symbol EMIM.L is reported in USD but will be presented in EUR. The conversion would be based on the value of the symbol USDEUR=X.
symbols: - symbol: EMIM.L target_currency: EUR
If data for the target currency is not found, then the display will remain in original currency. The conversion is only applied on the attributes representing prices.
-
The data fetch interval can be fine tuned at symbol level. By default, the
scan_intervalfrom the integration is used. The minimum value is still 30 seconds. Symbols with the samescan_intervalare grouped together and loaded through one data coordinator.If conversion data needs to be loaded, then that too will get added to the same coordinator. However, if conversion symbol is found in another coordinator, then that will get used.
scan_interval: hours: 4
scan_interval: minutes: 5
scan_interval: 300
-
The
unit_of_measurementcan be suppressed by settingno_unit: true. This could be used for index symbols if no currency unit is desired to be displayed.- Note: Using this setting will generate a warning like
The unit of sensor.yahoofinance_gspc cannot be converted to the unit of previously compiled statistics (USD). Generation of long term statistics will be suppressed unless the unit changes back to USD or a compatible unit.You will have to manually resolve it as mentioned in the message otherwise new data might not show in cards.
- Note: Using this setting will generate a warning like
-
The symbol can also represent a financial index such as this.
symbols: - ^SSMI
-
Yahoo also provides currency conversion as a symbol.
symbols: - GBPUSD=X
-
A complete sample
yahoofinance:
include_post_values: false
include_pre_values: false
show_trending_icon: true
decimal_places: 2
scan_interval:
hours: 4
symbols:
- USDINR=X
- UNP
-
The trending icons themselves cannot be colored but colors can be added using lovelace-card-mod. Here auto-entities is being used to simplify the code.
- type: custom:auto-entities card: type: entities title: Financial filter: include: - group: group.stocks options: entity: this.entity_id style: | :host { --paper-item-icon-color: {% set value=state_attr(config.entity,"trending") %} {% if value=="up" -%} green {% elif value=="down" -%} red {% else %} var(--paper-item-icon-color)) {% endif %};
The component exposes the service yahoofinance.refresh_symbols which can be used to refresh all the data.
-
As of version 1.2.5,
scan_intervalcan bemanualto suppress automatic update. -
As of version 1.1.0, the entity id has changed from
yahoofinance.symboltosensor.yahoofinance_symbol. -
As of version 1.0.0, all the configuration is now under
yahoofinance. If you are upgrading from an older version, then you would need to adjust the configuration. -
As of version 1.0.1, the minimum
scan_intervalis 30 seconds.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent