sensor.avanza_stock

Custom component to get stock data from Avanza for Home Assistant.

Installation

The easiest way is to install it with HACS. First install HACS if you don't have it yet. After installation you can find this custom component in the HACS store under integrations.
Alternatively, you can install it manually. Just copy paste the content of the sensor.avanza_stock/custom_components folder in your config/custom_components directory. As example, you will get the sensor.py file in the following path: /config/custom_components/avanza_stock/sensor.py.

Configuration

key	type	description
platform (Required)	string	`avanza_stock`
stock (Required)	number / list of stocks	The stock id or list of stocks, see below how to define the list. Also see below how to find the id.
name (Optional)	string	Custom name for the sensor. Default `avanza_stock_{stock}`. Redundant if stock is defined as a list.
shares (Optional)	number	The number of shares you own of this stock, can be fractional. Redundant if stock is defined as a list.
purchase_price (Optional)	number	The price paid when stock was purchased.
conversion_currency (Optional)	number	The index id used for currency conversion. Also see below how to find the id.
monitored_conditions (Optional)	list	Defines the attributes of the sensor, see below.

Stock configuration

key	type	description
id (Required)	number	The stock id, see below how to find it.
name (Optional)	string	Custom name for the sensor. Default `avanza_stock_{stock}`.
shares (Optional)	number	The number of shares you own of this stock, can be fractional.
purchase_price (Optional)	number	The price paid when stock was purchased.
conversion_currency (Optional)	number	The index id used for currency conversion, see below how to find it.

Monitored conditions

The following attributes are tracked if monitored_conditions is not defined.

change
changePercent
name

Full list of available attributes.

change
changePercent
country
currency
description
directYield
dividends
flagCode
hasInvestmentFees
highestPrice
id
isin
lastPrice
lastPriceUpdated
loanFactor
lowestPrice
marketCapital
marketList
marketMakerExpected
marketPlace
marketTrades
morningStarFactSheetUrl
name
numberOfOwners
orderDepthReceivedTime
priceAtStartOfYear
priceEarningsRatio
priceFiveYearsAgo
priceOneMonthAgo
priceOneWeekAgo
priceOneYearAgo
priceSixMonthsAgo
priceThreeMonthsAgo
priceThreeYearsAgo
pushPermitted
quoteUpdated
sector
shortSellable
superLoan
tickerSymbol
totalNumberOfShares
totalValueTraded
totalVolumeTraded
tradable
volatility

Finding stock or index id

Got to Avanza and search for the stock you want to track. In the resulting url there is a number, this is the stock id needed for the configuration. Even though it is a Swedish bank it is possible to find stocks from the following countries:

Sweden
USA
Denmark
Norway
Finland
Canada
Belgium
France
Italy
Netherlands
Portugal
Germany

Example

Configuration with default settings:

sensor:
  - platform: avanza_stock
    stock: 5361

Configuration with custom settings:

sensor:
  - platform: avanza_stock
    name: Avanza Bank Holding
    stock: 5361
    monitored_conditions:
      - totalVolumeTraded
      - totalValueTraded

Configuration with multiple stocks:

sensor:
  - platform: avanza_stock
    stock:
      - id: 5361
        name: Avanza Bank Holding
      - id: 8123
        name: Home Assistant
    monitored_conditions:
      - totalVolumeTraded
      - totalValueTraded

Usage

Automation to send summary at 18:00 using telegram:

# Telegram Stock Summary
- alias: 'Telegram Stock Summary'
  initial_state: true

  trigger:
    - platform: time
      at: '18:00:00'

  action:
    - service: notify.telegram
      data:
        message: '
<b>Stock Summary </b>
<code>
{{ states.sensor.avanza_stock_5361.attributes.name }} : {{ states.sensor.avanza_stock_5361.attributes.changePercent }}
</code>
'

Changelog

1.0.4 - Configure conversion currency and define purchase price
1.0.3 - Allow to define multiple stocks
1.0.2 - Async update
1.0.1 - Allow fractional shares, add more change attributes
1.0.0 - Add number of shares as optional configuration
0.0.10 - Clean up monitored conditions
0.0.9 - Compare payment date with today's date, ignore time
0.0.8 - Ignore dividend if amount is zero, add resources.json and manfiest.json
0.0.7 - Changed to async setup
0.0.6 - Make sure dividend payment date has not passed
0.0.5 - Add dividends information
0.0.4 - Add companny information (description, marketCapital, sector, totalNumberOfShares)
0.0.3 - Add key ratios (directYield, priceEarningsRatio, volatility)
0.0.2 - Configure monitored conditions
0.0.1 - Initial version

fabir-git/sensor.avanza_stock