quantconnect-client

QuantConnect JS REST Client

Important

This is not an official API maintained by the QuantConnect team, and is in (VERY) early stages of development.

General

An open-source wrapper over the REST API described in QuantConnect's documentation

The API works both in Node.JS environment and browser environment.

Installation

Using yarn:

yarn add quantconnect-client

Using NPM:

npm install quantconnect-client

Usage

Authentication

In order to authenticate you'll need an API key and token from QuantConnect, you can get these through your QuantConnect account page, similar to using LEAN CLI

Usage Example

import quantconnect from "quantconnect-client";

// Keep these in a safe place
const userId = '';
const token = ''

const { live } = quantconnect({ userId: this.userId, token: this.token });

// result is your live running algorithms
const result = live.read({ status: "Running" })

Supported endpoints

See full reference in modules

• Authenticate
• Projects
  • Create
  • Read
  • Update
  • Delete
• Files
  • Create
  • Read
  • Update
  • Delete
• Live
  • Create
  • Read
  • Logs
  • Liquidate
  • Stop

Roadmap

• [ ] Tests tests tests
• [ ] Full return types from endpoints
• [ ] More endpoints support:
  • [ ] Backtest management and reports
  • [ ] Compiling code
  • [ ] Downloading data