Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mlbonniec/MMM-Coinbase

A module for Michael Teeuw's MagicMirror project that displays your crypto-currencies Coinbase balance.
https://github.com/mlbonniec/MMM-Coinbase

bitcoin coinbase coinbase-api crypto-currencies cryptocurrency magic-mirror magic-mirror-modules magicmirror mmm-coinbase

Last synced: 3 months ago
JSON representation

A module for Michael Teeuw's MagicMirror project that displays your crypto-currencies Coinbase balance.

Host: GitHub
URL: https://github.com/mlbonniec/MMM-Coinbase
Owner: mlbonniec
License: mit
Archived: true
Created: 2019-02-10T17:49:44.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2021-10-16T11:56:37.000Z (about 3 years ago)
Last Synced: 2024-06-29T09:35:48.099Z (5 months ago)
Topics: bitcoin, coinbase, coinbase-api, crypto-currencies, cryptocurrency, magic-mirror, magic-mirror-modules, magicmirror, mmm-coinbase
Language: JavaScript
Homepage: https://magicmirror.builders/
Size: 802 KB
Stars: 12
Watchers: 4
Forks: 11
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-mmm - **MMM-Coinbase**

README

# MMM-Coinbase
A module for Michael Teeuw's MagicMirror project that displays your crypto-currency Coinbase balance.
The module is now compatible with all crypto-currencies available on Coinbase.
However, only Bitcoin and Ethereum icons are available. For the other crypto-currencies, the currency symbol is displayed. (e.g. LTC for Litecoin)

## How it works
After installing the module and configuring the Coinbase API with your account, the module displays your crypto-currency balance in real time. It is updated every 5 seconds.

## Screenshot

## Prerequisites
* MagicMirror2
* Node.js
* npm
* Coinbase account

## Installing
Installing the module is quite straight forward
### Step 1 - Install the module
```javascript
cd ~/MagicMirror/modules
git clone https://github.com/mlbonniec/MMM-Coinbase.git
cd MMM-Coinbase
npm install
```
### Step 2 - Create your coinbase API keys
|!["Step-1"](https://github.com/mlbonniec/MMM-Coinbase/blob/master/img/readme/Step-1.png "Step-1")|!["Step-2"](https://github.com/mlbonniec/MMM-Coinbase/blob/master/img/readme/Step-2.png "Step-2")|!["Step-3"](https://github.com/mlbonniec/MMM-Coinbase/blob/master/img/readme/Step-3.png "Step-3")|
|-------------|-------------|-------------|
|

Go to API Access

Click `+ New API Key`

Check `BTC Wallet` (or `LTC Wallet`, `ETH` ...) and `wallet:accounts:read`

|!["Step-4"](https://github.com/mlbonniec/MMM-Coinbase/blob/master/img/readme/Step-4.png "Step-4")|!["Step-5"](https://github.com/mlbonniec/MMM-Coinbase/blob/master/img/readme/Step-5.png "Step-5")|
|-------------|-------------|
|

Click `Create`

Copy `API Key` and `API Secret Key`

### Step 3 - Add module to `~MagicMirror/config/config.js`
Add this configuration into `config.js` file's
```javascript
{
module: "MMM-Coinbase",
position: "top_left", // put it where you want it
header: "Coinbase", // optional
config: {
apiKey: "YOUR API KEY", // the key previously copied
apiSecret: "YOUR API SECRET KEY",
wallet: ["BTC", "LTC"], // list of currencies to display
icons: true, // currently only Ethereum and Bitcoin supported
label: false // shows currency labels (e.g. BTC, ETH and so on)
}
}
```
## Updating
Go to the module’s folder inside MagicMirror modules folder and pull the latest version from GitHub and install:
```
git pull
npm install
```
## Configuring
Here is the configurable part of the module

|Option|Description|
|------|-----------|
|`apiKey`|API Key from Coinbase.

**Type:** `string` **REQUIRED**
**Example:**`1iO5VjY2bdC3HucJ`
**Default value:** none|
|`apiSecret`|API Secret Key from Coinbase.

**Type:** `string` **REQUIRED**
**Example:**`OwABcDaA5fxK3QTV3gjwvOk358juuXti`
**Default value:** none|

## Use
Now you can fully use MagicMirror and the MMM-Coinbase module to display your wallets ! Enjoy it well !

## Contributing
If you find any problems, bugs or have questions, please [open a GitHub issue](https://github.com/mlbonniec/MMM-Coinbase/issues) in this repository.

## Contributors
* [nabbl](https://github.com/nabbl) thank you for your great work!