{"id":24290523,"url":"https://github.com/dutu/xbalance","last_synced_at":"2025-09-25T13:31:19.879Z","repository":{"id":74504682,"uuid":"85878799","full_name":"dutu/xBalance","owner":"dutu","description":"your accounts balance from multiple cryptocurency exchanges. Free, open source","archived":false,"fork":false,"pushed_at":"2017-04-18T07:23:40.000Z","size":1149,"stargazers_count":12,"open_issues_count":5,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-15T00:42:34.052Z","etag":null,"topics":["account-balance","bitfinex","bitstamp","crypto","cryptocurrency","poloniex"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dutu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-03-22T21:40:15.000Z","updated_at":"2022-12-05T18:34:06.000Z","dependencies_parsed_at":"2023-03-25T14:18:17.733Z","dependency_job_id":null,"html_url":"https://github.com/dutu/xBalance","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FxBalance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FxBalance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FxBalance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FxBalance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dutu","download_url":"https://codeload.github.com/dutu/xBalance/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234195792,"owners_count":18794357,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["account-balance","bitfinex","bitstamp","crypto","cryptocurrency","poloniex"],"created_at":"2025-01-16T11:53:05.161Z","updated_at":"2025-09-25T13:31:19.407Z","avatar_url":"https://github.com/dutu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"xBalance - get your accounts balance from multiple cryptocurency exchanges\n====================\n\n**xBalance** is a node.js app for getting your accounts balance from multiple cryptocurency exchanges.\n\nThe application code is shared on github at https://github.com/dutu/xBalance/\n\n### Contents\n* [How it works](#how-it-works)\n\t* Why using statistical calculation is more efficient\n* [Setting up the application](#setting-up-the-application)\n    * Running locally\n    * Running on Heroku\n* [Updating the application](#updating-the-application)\n    * Running locally\n    * Running on Heroku\n* [FAQ](#faq)\n* [License](#license) \n\n\n# How it works\n\nxBalance is:\n\n- an **open source** application\n- runs on [node.js](http://nodejs.org/)\n- can either run locally on your computer or can be hosted on a cloud platform (e.g. [Heroku](http://www.heroku.com \"Heroku\")).\n\nThe application gets the balance of your accounts from multiple cryptocurency exchanges. \n\n### Example screenshot:\n\n![](http://i.imgur.com/HiX3yz4.jpg)\n\n\n# Supported exchanges\n\n|Exchange name or wallet | slug \u003csup\u003e[1]\u003c/sup\u003e | Authentication               |\n| ---\t                 |    ---             |    ---                       |\n| Bitfinex               | `\"bitfinex\"`       | `key`, `secret`              |\n| Bitstamp               | `\"bitstamp\"`       | `key`, `secret`, `username`  |\n| BitX                   | `\"bitx\"`           | `key`, `secret`              |\n| Gdax                   | `\"gdax\"`           | `key`, `secret`, `passphrase`|\n| Poloniex               | `\"poloniex\"`       | `key`, `secret`              |\n| BTC wallet             | `\"BTC wallet\"`     | -                            |\n\n\u003e\u003csup\u003e[1]\u003c/sup\u003e values to be used for `exchange` in the `account.js` file (see step 5 below)\n\n\n# Setting up the application\n\n## Running locally\n\n1. [Download and install node.js](http://nodejs.org/)\n\n2. [Download and install the latest version of Git](http://git-scm.com/downloads \"Download and install the latest version of Git\")\n\n3. Clone `xBalance` application source code from github:\n\n    ```\n    $ git clone https://github.com/dutu/xBalance.git\n    $ cd xBalance\n    ```\n4. Install the dependencies, preparing your system for running the app locally:\n\n    ```\n    npm install\n    ```\n\n5. Setup accounts name and API keyes for your accounts :\n    Rename the file `accounts-template.js` to `accounts.js`, then update the file with your own values\n    \n6. Start the app locally:\n\n    ```\n    npm start\n    ```\n\n7. Get your balances by opening http://localhost:4000/ with your internet browser\n\n8. Get your balances raw data by opening http://localhost:4000/api/getBalances with your internet browser\n\n    \n## Running on Heroku\n\n\n1. [Create a Heroku account]([https://signup.heroku.com/dc] \"Create a Heroku account\") if you don't have one already](http://www.heroku.com)\n\n2. [Download and install the Heroku Toolbelt](https://toolbelt.heroku.com/ \"Download and install the Heroku Toolbelt\")\nOnce installed, you'll have access to the heroku command from your command shell.\n\n3. Log into Heroku:\n\n    ```\n    $ heroku login\n    ```\n \n4. Clone `xBalance` application source code from github:\n\n    ```\n    $ git clone https://github.com/dutu/xBalance.git\n    $ cd xBalance\n    ```\n\n5. Setup accounts name and API keyes for your accounts :\n    Rename the file `accounts-template.js` to `accounts.js`, then update the file with your own values\n\n6. Create an app on Heroku and deploy the code\n    \n    ```\n    $ heroku create\n    $ git push heroku master\n    $ heroku ps:scale web=0 xBalance=0\n    ```\n    \n7. Provision the [papertrail](https://devcenter.heroku.com/articles/papertrail) logging add-on\n    ```\n    $ heroku addons:create papertrail\n    ```\n    \n    Note: To help with abuse prevention, Heroku requires account verification for provisioning an add-on . If your account has not been verified, you will be directed to visit the verification site.\n\n\n7. Open the papertrail console to see the log messages. \n    ```\n    $ heroku addons:open papertrail\n    ```\n\u003e Note: Keep the papertrail console open to monitor progress\n    \n8. Start the application\n    ```\n    heroku ps:scale xBalance=1\n    ```\n\n10. [Upgrade your application to Hobby](https://dashboard.heroku.com/) (optional)\n\u003e **Note**: By default the Heroku applications run on Free dyno. See: https://www.heroku.com/pricing \n\n\n# Updating the application\n\nUpdating the application when xBalance code is updated on github\n\n## Running locally\n\n1. Stop the xBalance application with `CTRL+C` \n\n3. Update the local clone from github\n    ```\n    $ cd xBalance\n    $ git pull origin master\n    ```\n\n4. Update dependencies:\n\n    ```\n    npm update\n    ```\n\n5. Start the app locally:\n\n    ```\n    npm start\n    ```\n\n\u003e **Note**: If you are requested to update node.js version, please do so by downloading and installing the applicable version. Go to [https://nodejs.org](https://nodejs.org/).\n\n\n## Running on Heroku\n\n1. Update the local clone from github\n    ```\n    $ cd xBalance\n    $ git pull origin master\n    ```\n\n2. Open the papertrail console to see the log messages \n    ```\n    $ heroku addons:open papertrail\n    ```\n\n3. Deploy updated code to heroku \n    ```\n    $ git push heroku master\n    ```\nThe application will restart automatically with the newly deployed code \n\n     \n# FAQ\n\n**Q1: Can you add support for new exchnges**\n\n**A1:** Yes, please contact me by e-mail or [raise an issue on github](https://github.com/dutu/xBalance/issues).\n\n\n# License #\n\n[MIT](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutu%2Fxbalance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdutu%2Fxbalance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutu%2Fxbalance/lists"}