Stock Card

Features

• Two cards: a full Stock Card and a compact Stock Mini Card
• Automatic discovery of the Yahoo Finance sensors, or your own list of quotes, mixing Yahoo Finance and any price sensor
• Price in its currency, formatted for your language, and the change of the day in value and percentage, green or red
• Sparkline of each quote over 24 hours, 5 days, 1 month, 3 months or 1 year, from the recorder's statistics (or the state history of a sensor without statistics), coloured by its own trend
• Optional portfolio: give a quantity (and a purchase price) per quote to get the value of each position, the portfolio total, its change of the day and your gain, one total per currency or all in the currency of your choice (currency)
• Market status chip (open, pre-market, after hours, closed) from Yahoo Finance
• Sort menu in the card: card order, name, change or position value (sort_by sets the default)
• A new price flashes in the colour of its move
• Click any quote to open its Home Assistant history (more-info dialog)
• Detail button at the top right of the mini card: it switches to the full card and back; a click anywhere outside the card brings the compact view back
• Visual editor in the dashboard UI for both cards, quantities, purchase prices, currency and exchange rate sensors included (no YAML needed)
• Light and dark mode; English, French, German, Spanish, Serbian (Cyrillic and Latin), Italian, Dutch, European Portuguese, Polish, Romanian, Danish, Swedish, Bulgarian, Russian, Ukrainian, Hungarian, Slovak, Czech, Slovenian, Latvian and Greek
• Single file, no external dependency

Supported integrations

Integration	What the cards show
Yahoo Finance (Marketplace)	Everything: symbol and company name, price in its currency, change of the day (regularMarketChange, regularMarketChangePercent), market status (marketState), sparkline
Any numeric sensor with a price	Name, price with its unit (an ISO currency code such as EUR is shown with its symbol), sparkline; the change is the change over the sparkline's period, from the sensor's history (· 24 h after it), unless the sensor has change / change_percent or previous_close attributes

Prerequisites

Home Assistant 2024.8 or later, and the Yahoo Finance integration (available in the Marketplace) or any sensor holding a price. The sparklines need the recorder (on by default).

Configuration

Visual editor#

Edit a dashboard, click Add card and search for Stock Card or Stock Mini Card. With no quote selected, the card lists every Yahoo Finance sensor; pick quotes in the list to choose them and their order. On the full card, the Portfolio section takes a quantity and a purchase price per quote. The preview updates live, and options left at their default are kept out of the generated YAML.

Minimal#

type: custom:stock-card

type: custom:stock-mini-card

Full options#

type: custom:stock-card
title: Investments
url: https://finance.yahoo.com/portfolios
entities:
  - entity: sensor.yahoofinance_air_pa
    quantity: 40
    purchase_price: 128.5
  - entity: sensor.yahoofinance_mc_pa
    name: LVMH
    quantity: 6
    purchase_price: 702
  - sensor.yahoofinance_fchi
  - entity: sensor.bitcoin_price
    quantity: 0.12
history_period: 1m
sort_by: value
change_display: both
decimals: 2
show_title: true
show_subtitle: true
show_name: true
show_history: true
show_total: true
show_market_state: true
currency: EUR
exchange_rates:
  USD: sensor.yahoofinance_eurusd_x
language: fr

type: custom:stock-mini-card
title: Stocks
max_items: 5
history_period: 1d
show_history: true
show_total: true
zoom: true

Options reference#

Portfolio

Give a quantity to the quotes you hold (and, optionally, the purchase_price paid per share): each row then shows the number held and the position value, and a total sits above the list with the change of the day and, when purchase prices are set, the gain against them.

Totals are made per currency: a portfolio holding euros and dollars shows two totals, unless currency converts them into one (see below). The day change only adds the quotes that know it (Yahoo Finance); a sensor whose change comes from its history counts in the value and the gain, not in the day change.

Currency of the total#

Set currency to show the portfolio total, its change of the day and the gain in one currency, for instance in euros for a portfolio of US stocks. The prices and the position values of the rows stay in each quote's own currency.

The rates are taken, in this order:

1. from exchange_rates, a number or a sensor per currency (USD: 0.92: 1 USD = 0.92 EUR) or per pair (EURUSD: sensor.eur_usd: 1 EUR = 1.0862 USD, the market's way of quoting it). A Yahoo Finance pair sensor (EURUSD=X) is read the right way round whatever key it is given under;
2. else from the Yahoo Finance currency pairs of Home Assistant: add the symbol EURUSD=X (or USDEUR=X) to the integration and nothing else is needed.

type: custom:stock-card
title: US stocks
currency: EUR
entities:
  - entity: sensor.yahoofinance_aapl
    quantity: 12
    purchase_price: 168.4
  - entity: sensor.yahoofinance_msft
    quantity: 5
    purchase_price: 377
  - entity: sensor.yahoofinance_nvda
    quantity: 30
    purchase_price: 118.2
# Optional with a Yahoo Finance EURUSD=X sensor, found on its own:
exchange_rates:
  EURUSD: sensor.yahoofinance_eurusd_x

The rate used is shown next to Portfolio (1 USD = €0.9206, a click opens its sensor). A currency with no rate is not converted: it keeps its own total, marked no rate to EUR. Prices in pence (GBp, London) are converted through pounds, and cents (ZAc) and agorot (ILA) likewise.

Amounts are converted at the current rate: the day change and the gain are those of the stocks, without the move of the currency itself (purchase prices are in the quote's currency).

Other price sensors

Any sensor holding a price can be listed next to the Yahoo Finance quotes: a crypto-currency, a commodity, a fund from another integration, a template sensor. Its unit is shown after the price (an ISO currency code such as EUR or USD is shown with its symbol). With no change attributes, the change shown is the change over the sparkline's period, from the sensor's first value in that period, followed by the period (+4.17% · 5 days).

type: custom:stock-card
title: Commodities
history_period: 5d
entities:
  - sensor.bitcoin_price
  - sensor.gold_price

How it works

Yahoo Finance sensors are found through the entity registry (platform yahoofinance), or by their quote attributes (symbol and regularMarketPrice) when they have no registry entry. The price is the sensor's state; the change of the day, the previous close and the market status come from its attributes.

The sparklines read the recorder's long-term statistics (recorder/statistics_during_period, mean of each period), which Yahoo Finance sensors have (state_class: measurement). A sensor without statistics falls back to its state history. They are fetched again every 5 minutes, and each curve ends on the live price. A quote with no data in the period has no curve.

Market status, from the most active of the card's Yahoo Finance quotes:

The header icon is tinted by the day's move: of the portfolio total when there is one, else of the quotes on average.

Support

If you find this project useful, you can support its development:

Features

• Currency of the portfolio total (currency): the total, its change of the day and the gain in one currency, such as euros for a portfolio of US stocks, through the rates of exchange_rates (a number or a sensor, per currency or per pair) or, with none given, the Yahoo Finance currency pairs (EURUSD=X). The rate used is shown next to the total; a currency with no rate keeps its own total, marked as such. Pence (GBp) go through pounds. Both visual editors offer the currency and a rate sensor per currency to convert (#5, suggested by @mielikki33).

Fixes

• Folding back on a tap elsewhere now works on iOS (Safari and the companion app): a tap on something that is not clickable sent no click to the page, so the detailed view of the mini card stayed open. The press and the release are caught instead; a slider dragged out of the card and a scroll do not fold anything.
• Leaving the card (another dashboard view, a conditional card hidden) brings it back in its default state.

Features

• Stock Card and Stock Mini Card: stock and market quotes with their price, change of the day and sparkline.
• Automatic discovery of the Yahoo Finance sensors; any other price sensor can be listed too, its change then taken from its history.
• Sparklines over 24 hours, 5 days, 1 month, 3 months or 1 year (history_period), from the recorder's statistics or the state history.
• Optional portfolio: quantity and purchase price per quote, position values, total per currency with the day's change and the gain.
• Market status chip, sort menu (sort_by), price ticks, detail button on the mini card.
• Visual editor for both cards, quantities and purchase prices included.
• 22 languages, English in the bundle and the others loaded on demand.