Skip to content

Latest commit

 

History

History
55 lines (31 loc) · 1.6 KB

README.md

File metadata and controls

55 lines (31 loc) · 1.6 KB
Raw

StockPros

StockPros is an interface for implementing custom trading strategies. Users can backtest their strategies, paper trade, and live trade. It runs in Node.js and uses a few external services.

Services

  • PostgreSQL - SQL database.
  • Redis - in-memory data store.
  • Alpaca - live/paper trading.
  • Polygon - market data.
    • Polygon data is free with a live Alpaca trading account. If you set a Polygon API key in the environment variables (see below), it be used, otherwise the live Alpaca API key will be used.

Installation

Use the .env.example file to configure the environment variables for a given environment e.g. .env.local, .env.development, .env.staging, or .env.production.

Set the environment

$ export NODE_ENV=local

Install the dependencies

$ npm install

Run the DB migrations

$ knex migrate:latest

Run the DB seeders

$ knex seed:run

Unit Testing

$ npm test

Start the server

$ npm start

On start, StockPros will load the watched symbols into the DB, including up to 15 years of historical OHLC (open-high-low-close) data, and then begin running all active strategies for these symbols.

Running with Docker Compose

$ docker-compose build

$ docker-compose up

API

For each API, view the docs and try the requests in Postman.