# @socktrader/core

> SockTrader core is a realtime websocket based trading bot framework focused on trading cryptocurrencies

Latest version **2.0.3** (published 2022-05-08) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @socktrader/core
pnpm add @socktrader/core
yarn add @socktrader/core
bun add @socktrader/core
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2022-05-08 |
| First published | 2022-04-17 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 123.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 470 |
| Maintainers | cwouter |
| Keywords | tradingbot, algorithmic-trading, cryptocurrencies, binance, trading-algorithms, trading-bot, quantitative, finance, financial, analysis, statistics, trading, crypto, bitcoin |

## Links

- npm: https://www.npmjs.com/package/@socktrader/core
- Repository: https://github.com/SockTrader/SockTrader
- Homepage: https://github.com/SockTrader/SockTrader.git
- Issues: https://github.com/SockTrader/SockTrader/issues
- npm.io page: https://npm.io/package/@socktrader/core

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 2.0.3 (latest) — 2022-05-08
- 2.0.2 — 2022-05-07
- 2.0.1 — 2022-04-24
- 2.0.0 — 2022-04-23
- 1.0.15 — 2022-04-23
- 1.0.14 — 2022-04-23
- 1.0.13 — 2022-04-22
- 1.0.12 — 2022-04-22
- 1.0.11 — 2022-04-22
- 1.0.10 — 2022-04-22
- 1.0.9 — 2022-04-20
- 1.0.8 — 2022-04-20
- 0.0.1 — 2022-04-17

## README

<p align="center"><img width="160" height="160" src="https://raw.githubusercontent.com/SockTrader/SockTrader/master/docs/assets/socktrader_logo.png" alt="SockTrader logo" /></p>

<h1 align="center">@socktrader/core</h1>

<p align="center">
  <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPL%20v3-blue.svg" alt="License: GPL v3"></a>
  <a href="https://codecov.io/gh/SockTrader/SockTrader"><img src="https://codecov.io/gh/SockTrader/SockTrader/branch/master/graph/badge.svg" /></a>
  <a href="https://sonarcloud.io/dashboard?id=SockTrader_SockTrader"><img src="https://sonarcloud.io/api/project_badges/measure?project=SockTrader_SockTrader&metric=reliability_rating" /></a>
  <a href="https://sonarcloud.io/dashboard?id=SockTrader_SockTrader"><img src="https://sonarcloud.io/api/project_badges/measure?project=SockTrader_SockTrader&metric=sqale_rating" /></a>
  <a href="https://circleci.com/gh/SockTrader"><img src="https://circleci.com/gh/SockTrader/SockTrader/tree/master.svg?style=shield" alt="Build status"></a>
  <a href="https://codeclimate.com/github/SockTrader/SockTrader/maintainability"><img src="https://api.codeclimate.com/v1/badges/19589f9237d31ca9dcf6/maintainability" /></a>
</p>

<p align="center"><b>Join the community <a href="https://join.slack.com/t/socktrader/shared_invite/zt-12ncj65l3-T7cacrk7~cEacjZUyxnamA"><img valign="middle" src="https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack" alt="Slack"></a></b></p>

## 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?](https://www.investopedia.com/terms/t/technicalanalysis.asp))
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 web**sock**et 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.

## Sounds interesting?
We have 2 easy options to get you started, choose below:

### Start quick demo app
1. Git clone `git clone git@github.com: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`

### Run SockTrader in your own project
Start using the SockTrader CLI. More info can be found on [@socktrader/cli](https://www.npmjs.com/package/@socktrader/cli) or on the main [SockTrader GitHub page](https://github.com/SockTrader/SockTrader)

---
_Source: https://npm.io/package/@socktrader/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._