Giter Club home page Giter Club logo

socktrader's Introduction

SockTrader logo

SockTrader v2

Cryptocurrency trading bot

License: GPL v3 Build status

Join the community Slack

What is "SockTrader"?

SockTrader is an open source cryptocurrency trading bot. You can use it to automatically buy and/or sell cryptocurrencies based on a strategy that you've programmed. The strategy basically contains a set of rules that will define when and how the bot should act in the cryptocurrency market. These rules can be based on technical analysis (what is technical analysis?) or you could simply tell the bot to buy/sell at certain price levels. In fact, it's up to you to decide the rules of the game!

The name "SockTrader" comes from websocket based trading bot. Which means that SockTrader will try to make use of a realtime connection with the exchange. This has the advantage that one can act very quickly in a changing market with low latency.

Looking for SockTrader v1?

The dashboard is currently incompatible with SockTrader v2. Use SockTrader v1 instead

Features

  • 🚀 Realtime super-fast websocket trading.
  • 📈 50+ Technical indicators. (docs)
  • 🌈 Written in TypeScript!
  • 🌿 Unit tested source code.
  • 📝 Paper trading a strategy on LIVE exchange data.
  • 🏡 Backtesting engine with local data.
  • 🚢 Run SockTrader inside a docker container.
  • More features soon..

Getting started

Quickstart

  1. Git clone git clone [email protected]:SockTrader/SockTrader.git && cd SockTrader
  2. Install NodeJS dependencies. npm i
  3. Copy config/default.json to config/local.json and edit.
  4. Start postgres database docker-compose up
  5. Run the MovingAverageStrategy on LocalExchange. npm run start:backtest

Connect your Binance account

You feel like your strategy is production ready? Good! We'll help you to connect your SockTrader strategy to your Binance account.

  1. Copy config/default.json to config/local.json
  2. Go to your Binance account under API Management, create a new API key
  3. Provide the apiSecret and apiKey in config/local.json
  4. Don't forget to change the exchange in your strategy to new Binance() and you're good to go!

API key restrictions

By default, the newly created API key does not allow you to place orders, only reads are allowed. To get started:

  1. Go to your Binance account
  2. Under API restrictions enable 'Enable Spot & Margin Trading'

Join the community

Slack

Contributors

DISCLAIMER

Using a trading bot does not mean guaranteed profit.
Also, trading crypto currency is considered high risk.
Losses are possible, which SockTrader cannot be held responsible for.

socktrader's People

Contributors

cwouter avatar thijs-raets avatar dependabot[bot] avatar greenkeeper[bot] avatar semantic-release-bot avatar nathanwaddell121107 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.