Skip to content

Commit beb2941

Browse files
tjorimfabaff
authored andcommitted
Update coinbase.markdown with new docs (home-assistant#7412)
* Update coinbase.markdown Delete trailing spaces Keep example configuration minimal Add new `account_balance_currencies` option * Added a full configuration example
1 parent 4baaa23 commit beb2941

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

source/_components/coinbase.markdown

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ ha_release: 0.61
1313
ha_iot_class: "Cloud Polling"
1414
---
1515

16-
1716
The `coinbase` component lets you access account balances and exchange rates from [coinbase](https://coinbase.com).
1817

1918
You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data.
@@ -25,12 +24,8 @@ To set it up, add the following information to your `configuration.yaml` file:
2524
```yaml
2625
# Example configuration.yaml entry
2726
coinbase:
28-
api_key: YOUR_API_KEY
29-
api_secret: YOUR_API_SECRET
30-
exchange_rate_currencies:
31-
- BTC
32-
- ETH
33-
- LTC
27+
api_key: YOUR_API_KEY
28+
api_secret: YOUR_API_SECRET
3429
```
3530
3631
{% configuration %}
@@ -42,8 +37,33 @@ api_secret:
4237
description: Your API secret to access coinbase.
4338
required: true
4439
type: string
40+
account_balance_currencies:
41+
description: List of currencies to create account wallet sensors for.
42+
required: false
43+
type: list
44+
default: all account wallets
4545
exchange_rate_currencies:
4646
description: List of currencies to create exchange rate sensors for.
4747
required: false
4848
type: list
4949
{% endconfiguration %}
50+
51+
Possible currencies are codes that conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code (e.g. BTC). A list of values can be obtained via https://api.coinbase.com/v2/currencies, for more information visit [the Coinbase API documentation](https://developers.coinbase.com/api/v2#get-currencies).
52+
53+
## {% linkable_title Full configuration example %}
54+
55+
A full configuration sample including optional variables:
56+
57+
```yaml
58+
# Example configuration.yaml entry
59+
coinbase:
60+
api_key: YOUR_API_KEY
61+
api_secret: YOUR_API_SECRET
62+
account_balance_currencies:
63+
- EUR
64+
- BTC
65+
exchange_rate_currencies:
66+
- BTC
67+
- ETH
68+
- LTC
69+
```

0 commit comments

Comments
 (0)