An open API service indexing awesome lists of open source software.

https://github.com/kartax/home-assistant-binance

A Home Assistant Integration for the cryptocurrency trading platform Binance.
https://github.com/kartax/home-assistant-binance

binance bitcoin crypto cryptocurrency dogecoin ethereum home-assistant home-assistant-integration ripp

Last synced: 17 days ago
JSON representation

A Home Assistant Integration for the cryptocurrency trading platform Binance.

Awesome Lists containing this project

README

          

[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg)](https://github.com/hacs/integration)
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=Kartax&repository=home-assistant-binance&category=integration)

![Binance Logo](images/binance_logo.png)

# Binance Integration for Home Assistant
A Home Assistant Integration for the cryptocurrency trading platform [Binance](https://www.binance.com/en).

Features:
- Pull prices for a configurable list of trading pairs (e.g. BTCUSDT, ETHUSDT)
- Optionally pull Spot wallet balances and total USD value (requires API key)
- Optionally pull Simple Earn (flexible + locked) balances and total USD value (requires API key)

### Installation
1. Install via HACS: search for "Binance Integration" in HACS → Download
2. Restart Home Assistant
3. Go to Settings → Integrations → Add Integration → search "Binance" → click it

### Configuration (first setup)
In the setup dialog:
- **API Key**: leave empty for ticker-only, or enter your Binance API key (read-only)
- **API Secret**: enter your Binance API secret (required if API key is set)
- **Decimal places**: default 8
- **Update interval**: default 60 seconds

### Configuration (symbols & assets)
After adding, click the gear icon ⚙️ → Options:
- **Ticker symbols** (required): comma-separated, e.g. `BTCUSDT,ETHUSDT`
- **Spot wallet assets** (optional): comma-separated, e.g. `BTC,ETH,USDT`
- **Earn wallet assets** (optional): comma-separated, e.g. `USDT,BTC`

### Migration note
If you had a `configuration.yaml` entry for Binance (v1.x), it is automatically imported when HA starts after the update. You can then remove the YAML block.

### Sensors created

| Sensor | Created when | Description |
|--------|--------------|-------------|
| Binance Ticker {SYMBOL} | always | Current price of the trading pair |
| Binance Wallet Total (USD) | API key set | Estimated Spot wallet value in USD |
| Binance Wallet {ASSET} | Spot wallet assets configured | Spot balance per asset |
| Binance Earn Total (USD) | API key set | Estimated Earn portfolio value in USD (flexible + locked) |
| Binance Earn {ASSET} | Earn wallet assets configured | Earn balance per asset (flexible + locked combined) |

The API key only needs read permissions — no trading permissions required.