MagicMirror² v2.11.0 is available! For more information about this release, check out this topic.
READ THE CHANGELOG BEFORE UPDATING!

MMM-Coinbase



  • MMM-Coinbase

    A module for Michael Teeuw’s MagicMirror project that displays your Bitcoin Coinbase balance.

    How it works

    After installing the module and configuring the Coinbase API with your account, the module displays your Bitcoin 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

    cd ~/MagicMirror/modules
    git clone https://github.com/XC2DN/MMM-Coinbase.git
    cd MMM-Coinbase
    npm install
    

    Step 2 - Create your coinbase API keys

    "Step-1" "Step-2" "Step-3"

    Go to API Access

    Click + New API Key

    Check BTC Wallet and wallet:accounts:read

    "Step-4" "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

    {
        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" // the secret key previously copied
            }
    }
    

    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 wallet ! Enjoy it well !

    Contributing

    If you find any problems, bugs or have questions, please open a GitHub issue in this repository.


  • Moderator

    Looks good. And many thanks for such a well structured module description


  • Module Developer

    @xc2dn Nice work, might be good to add live currency conversion on there too 😉



  • @seann Thank you very much! I discovered MagicMirror yesterday, so this is my first module that will be used for my own mirror! I’ll try to add this feature! Thanks for the advice! 😀



  • This post is deleted!


  • @yawns Thank you ! I love it when things are well detailed, so I had to make a nice description.


Log in to reply