- Make sure that HACS is installed
- Add the URL for this repository as a custom repository in HACS
- Install via
HACS -> Integrations
In order to use this integration, you need to first Register an account with Binance, and then generate an API key from the "API Management" settings section.
To use this component in your installation, add the following to your configuration.yaml file:
binance:
api_key: !secret binance_api_key
api_secret: !secret binance_api_secret| Key | Type | Required | Description | Default |
|---|---|---|---|---|
name |
string | No | Name for the created sensors | Binance |
domain |
string | No | Binance domain to query | us |
native_currency |
string | No | Native currency for price calculations | USD |
api_key |
string | Yes | Binance API key | - |
api_secret |
string | Yes | Binance API secret | - |
balances |
array | No | List of coins for wallet balances | - |
exchanges |
array | No | List of pairs for exchange rates | - |
binance:
name: My Binance
domain: us
native_currency: USD
api_key: !secret binance_api_key
api_secret: !secret binance_api_secret
balances:
- USD
- BTC
- ETH
exchanges:
- BTCUSC
- ETHUSDThis configuration will create the following entities in your Home Assistant instance:
- My Binance USD Balance (
sensor.my_binance_usd_balance) - My Binance BTC Balance (
sensor.my_binance_btc_balance) - My Binance ETH Balance (
sensor.my_binance_eth_balance) - My Binance BTCUSD Exchange (
sensor.my_binance_btcusd_exchange) - My Binance ETHUSD Exchange (
sensor.my_binance_ethusd_exchange)
The name you specify will be used as a prefix for all the sensors this integration creates. By default, the prefix is simply "Binance".
This integration is set up to query Binance.us by default. If you've registered your Binance account with a different domain, like Binance.com, make sure to set this key in your configuration accordingly.
An API key and secret from Binance are required for this integration to function. It is highly recommended to store your API key and secret in Home Assistant's secrets.yaml file.
Each balance sensor this integration creates will have a state attribute named native_balance, which represents the current value of the represented balance, converted to the currency specified by native_currency. The default native currency used for balance conversions is USD.
A list of coins (or currencies) can be specified here, and this integration will create a sensor for your current balance in each of them. By default (without adding this key), a sensor will be created for every coin that Binance offers (54 unique coins/currencies from Binance.us at this time). If one of the given coins isn't available from the specified domain, a sensor won't be created.
A list of exchange pairs can be specified here, and this integration will create a sensor for the current exchange rate between each of them. By default (without adding this key), a sensor will be created for every exchange pair that Binance offers (109 pairs from Binance.us at this time). If one of the given pairs isn't available from the specified domain, a sensor won't be created.
type: vertical-stack
cards:
- type: entities
entities:
- entity: sensor.binance_vet_balance
type: 'custom:multiple-entity-row'
name: Cardano Balance
secondary_info:
attribute: native_balance
- entity: sensor.binance_doge_balance
type: 'custom:multiple-entity-row'
name: Dogecoin Balance
secondary_info:
attribute: native_balance
- type: horizontal-stack
cards:
- type: 'custom:mini-graph-card'
entities:
- entity: sensor.binance_vetusd_exchange
name: VET/USD
smoothing: false
decimals: 7
points_per_hour: 12
hours_to_show: 8
show:
fill: fade
extrema: true
- type: 'custom:mini-graph-card'
entities:
- entity: sensor.binance_dogeusd_exchange
name: DOGE/USD
smoothing: false
decimals: 7
points_per_hour: 12
hours_to_show: 8
show:
fill: fade
extrema: true