GithubHelp home page GithubHelp logo

samturner / btcmarkets_dca Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 5.42 MB

Example implementation of daily buys (Dollar Cost Averaging) with BTCMarkets API written in Node.JS

JavaScript 100.00%

btcmarkets_dca's Introduction

BTCMarkets DCA

This repository is an example showing how to implement Dollar-Cost Averaging (DCA) using the BTCMarkets API in Node.js.

The strategy here is to purchase a number of cryptocurrencies at the same time every day regardless of the price.

Disclaimer

I'm not a financial advisor. This is not financial advice. Never invest more than you're willing to lose. This code is provided as an example only and may contain bugs. Make sure you understand how it works before running it yourself.

Getting Started

  1. Run npm install to ensure dependencies are installed.

  2. Get your API keys for BTCMarkets and add them to keys.json. DO NOT PUBLISH YOUR KEYS ANYWHERE.

  3. Update the variables in the customisation section to match your investment strategy. It's best to test this with a very small DAILY_SPEND first.

  4. Run with node buy.js. To keep the script running indefinitely you can use something like Forever.

Customisation

There are a few variables that you may want to customise in order to tailor this to your own portfolio and investment strategy:

FIAT_CURR - The currency you want to buy in, I'm using AUD, you might want to use something else. Must be supported by BTCMarkets

DAILY_SPEND - The total amount that you want to spend each day, in FIAT_CURR

TOKEN_PERCENT - Contains the coin ticker you want to purchase and the amount (as a percentage) of your daily spend you want to assign to it. Always ensure this adds to 100%. Remove rows if you don't want to purchase them.

You can also customise the schedule.scheduleJob method call to change how often buys are made.

License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Dependencies

  • btc-markets - Node wrapper for the BTCMarkets API.
  • async - Trying to avoid callback hell
  • lodash - Collection manipulation
  • node-schedule - Schedule the buy method to run at the same time every day

btcmarkets_dca's People

Contributors

samturner avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.