Skip to content

ricardofagodoy/bitcoin-bot

Repository files navigation

Bitcoin Bot

alt text

Bitcoin Bot is a simple, extensible and easy-to-use application to keep track of price and place orders to Bitcoin market through exchanges API integration and pre-defined strategies.

Exchanges (details)

Strategies (details)

Why?

One main purpose for its development is the lack of time/patience to track charts and indicators before taking some decent action.

So, why not create a precise, super-speeded, never-tired robot to suit the job?

How to use

It's extremely easy to use!

You'll need

  • NodeJS (+ NPM)

You might also want to have an account in any of supported exchanges.

Steps

  1. Download or clone project
  2. Rename bot-config.json.default to bot-config.json
  3. Open file bot-config.json in editor and configure it propertly
  4. Run ./run.sh
  5. Grab a coffee and stare at running logs!

Creating new API integrations

All APIs integrations sit at src/apis, in a way each folder inside this path is a diffent integration.

In order to use an API, all you have to do is supply its configs at bot-config.json and choose it by inserting its name on top of config file api field.

To create your own, it's easy:

  1. Create a new folder under path above containing your TypeScript code implementing src/apis/Api.ts interface
  2. Insert a new key to bot-config.json mapping your API name
  3. It's done and ready to use!

Creating new Strategy

All strategies sit at src/strategy, in a way each folder inside this path is a diffent strategy.

In order to use a strategy, all you have to do is supply its configs at bot-config.json and choose it by inserting its name on top of config file strategy field.

To create your own, it's easy:

  1. Create a new folder under path above containing your TypeScript code implementing src/strategy/Strategy.ts interface
  2. Insert a new key to bot-config.json mapping your strategy name
  3. It's done and ready to use!

Comming Up

  • Tests (unit and integration)
  • Notifications
  • Persistence
  • Simulator
  • Remote control
  • More API integrations
  • More strategies

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published