Coinbase Config Flow Docs (#16241)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Tom Brien 2021-06-28 17:53:45 +01:00 committed by GitHub
parent da13299aa4
commit 21bd02bf50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -11,57 +11,24 @@ ha_platforms:
- sensor
---
The `coinbase` integration lets you access account balances and exchange rates from [coinbase](https://coinbase.com).
The `coinbase` integration lets you access account balances and exchange rates from [Coinbase](https://coinbase.com).
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 integration to access relevant data.
You will need to obtain an API key from the API section in Coinbase's [User Settings](https://www.coinbase.com/settings/api) to use this integration. You need to select the account wallet or wallets (e.g. "BTC Wallet") that you wish to show in Home Assistant and give read access to `wallet:accounts` in order for the integration to access relevant data. It is worth noting that once you close the New API Key popup on Coinbase you will not be able to see the API Secret again.
## Configuration
{% include integrations/config_flow.md %}
To set it up, add the following information to your `configuration.yaml` file:
{% configuration_basic %}
API Key:
description: Your API key generated by Coinbase, this is required.
API Secret:
description: Your API secret generated by Coinbase, this is required.
{% endconfiguration_basic %}
```yaml
# Example configuration.yaml entry
coinbase:
api_key: YOUR_API_KEY
api_secret: YOUR_API_SECRET
```
{% include integrations/option_flow.md %}
{% configuration %}
api_key:
description: Your API key to access coinbase.
required: true
type: string
api_secret:
description: Your API secret to access coinbase.
required: true
type: string
account_balance_currencies:
description: List of currencies to create account wallet sensors for.
required: false
type: list
default: all account wallets
exchange_rate_currencies:
description: List of currencies to create exchange rate sensors for.
required: false
type: list
{% endconfiguration %}
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).
## Full configuration example
A full configuration sample including optional variables:
```yaml
# Example configuration.yaml entry
coinbase:
api_key: YOUR_API_KEY
api_secret: YOUR_API_SECRET
account_balance_currencies:
- EUR
- BTC
exchange_rate_currencies:
- BTC
- ETH
- LTC
```
{% configuration_basic %}
Wallet balances to report:
description: List of currency codes to create account wallet sensors for. This is optional, if left blank the integration will create sensors for all currencies you configured the API key for.
Exchange rates to report:
description: Optional list of currencies to create exchange rate sensors for.
{% endconfiguration_basic %}