Available translations

User Manual

foundations.png
Summary: The User Manual covers Superalgos from A to Z, starting with a comprehensive conceptual introduction. The book covers functionality and features, along with the description of each hierarchy. It is organized for continuous reading and will take you from the starter to the advanced Superalgos user level.
I->Foundations->Topic->Introduction->Superalgos is a comprehensive platform integrating all the crucial elements that make up trading intelligence. This chapter offers a conceptual introduction explaining some of the main design principles and the fundamental concepts behind their implementation.

Chapter I - Introduction

Superalgos is a comprehensive platform integrating all the crucial elements that make up trading intelligence. This chapter offers a conceptual introduction explaining some of the main design principles and the fundamental concepts behind their implementation.

Table of Contents

1. Fundamental Superalgos Concepts

2. Bots In Superalgos

3. Hierarchies

4. Workflows

5. Workspaces

6. Nodes and Structures of Nodes

7. References

II->Foundations->Topic->Design Space->The Design Space is the place where all hierarchies live, that is, where you have access to all data structures. This is where you create and control what Superalgos does, and how.

Chapter II - Design Space

The Design Space is the place where all hierarchies live, that is, where you have access to all data structures. This is where you create and control what Superalgos does, and how.

Table of Contents

1. Design Space Hierarchy

2. Basic Navigation

3. Nodes Menu

4. Keyboard Shortcuts to Nodes

III->Foundations->Topic->LAN Network->The Network hierarchy organizes the infrastructure to run bots and store data. It is the hierarchy you will use the most to operate the system.

Chapter III - LAN Network

The Network hierarchy organizes the infrastructure to run bots and store data. It is the hierarchy you will use the most to operate the system.

Table of Contents

1. LAN Network Hierarchy

2. Organization of Tasks

3. Data Tasks Section

4. Indicator and Sensor Bot Instances

5. Testing Trading Tasks Section

6. Production Trading Tasks Section

7. Trading Bot Instance and Trading Sessions

8. Trading Session References

9. Trading Session Parameters

10. Data Storage Section

11. Data Mines Data Section

12. Trading Mines Data Section

13. Data and Trading Mine Products

14. How to Safely Close Superalgos

IV->Foundations->Topic->Charting Space->Because data visualization is a key contributor to trading intelligence, Superalgos features a built-in charting system. Discover the ins and outs of how to configure charts to suit your particular needs.

Chapter IV - Charting Space

Because data visualization is a key contributor to trading intelligence, Superalgos features a built-in charting system. Discover the ins and outs of how to configure charts to suit your particular needs.

Table of Contents

1. Fundamental Charting Space Concepts

2. Charting Space Hierarchy

3. Time Machines and Timeline Charts

4. Scales

5. Layer Managers

V->Foundations->Topic->Data Mining->Data Mines deal with bots that process data and feature a visual scripting framework that solves most all of the infrastructure intricacies of building indicators and plotters.

Chapter V - Data Mining

Data Mines deal with bots that process data and feature a visual scripting framework that solves most all of the infrastructure intricacies of building indicators and plotters.

Table of Contents

1. Data Mining - Introduction

2. Data Mining - Workflows

3. Data Mining - Dataset Types

4. Data Mining - Datasets Type Conversions

5. Data Mining - Indicator Frameworks

6. Data Mining - Data Mine Hierarchy

7. Data Mining - Managing Execution

8. Data Mining - Data Dependencies

9. Data Mining - Status Reports

10. Data Mining - Status Dependencies

11. Data Mining - Deployments

12. Data Mining - Products

13. Data Mining - Plotting

14. Data Mining - Fetching Data From APIs

15. Data Mining - Consuming Data From Strategies

16. Data Mining - Indicator Bots

17. Data Mining - Indicator Bots - Process Definition

18. Data Mining - Indicator Bots - Product Definition

19. Data Mining - Indicator Bots - Data Mining Workflow

20. Data Mining - Indicator Bots - Coding the Indicator's Logic

21. Data Mining - Plotters

22. Data Mining - Plotters - Shapes

23. Data Mining - How to Build an Indicator - Video Series

VI->Foundations->Topic->Trading Systems->Trading systems are a robust implementation of a professional trading framework. They are flexible enough to support virtually any kind of trading logic, and still, they are structured enough to allow building strategies without coding. That said, if you can code, you are King.

Chapter VI - Trading Systems

Trading systems are a robust implementation of a professional trading framework. They are flexible enough to support virtually any kind of trading logic, and still, they are structured enough to allow building strategies without coding. That said, if you can code, you are King.

Table of Contents

1. Trading System Hierarchy

2. Trading Strategies

3. The Trigger Stage

4. Open Stage Initial Targets

5. Open Stage Execution

6. Order Definitions

7. The Manage Stage

8. Position Management Phases

9. The Close Stage

VII->Foundations->Topic->Trading Logic->While the framework proposed by trading systems and trading strategies carry a fair bit of trading logic in and of themselves, it is how you define market situations along with the instructions passed to the Trading Bot that determine how strategies work.

Chapter VII - Trading Logic

While the framework proposed by trading systems and trading strategies carry a fair bit of trading logic in and of themselves, it is how you define market situations along with the instructions passed to the Trading Bot that determine how strategies work.

Table of Contents

1. Situations, Conditions, and Formulas

2. Syntax Overview

3. Accessing Runtime Data

4. Accessing Trading System Definitions and Session Parameters

VIII->Foundations->Topic->Low-Frequency Trading Bot->In Superalgos, the Trading Bot plays no part in the definition of the trading logic. Instead, it is the program that executes the trading logic, interacts with the exchange, and keeps track of orders.

Chapter VIII - Low-Frequency Trading Bot

In Superalgos, the Trading Bot plays no part in the definition of the trading logic. Instead, it is the program that executes the trading logic, interacts with the exchange, and keeps track of orders.

Table of Contents

1. Trading Bots in Superalgos

2. Why Low-Frequency

3. Data Products Visualization

IX->Foundations->Topic->LF Trading Bot Available Data Structures->This chapter describes the three main data structures made available by the Trading Bot.

Chapter IX - LF Trading Bot Available Data Structures

This chapter describes the three main data structures made available by the Trading Bot.

Table of Contents

1. LF Trading Bot - Chart Data Structure

2. LF Trading Bot - Market Data Structure

3. LF Trading Bot - Exchange Data Structure

X->Foundations->Topic->Order Management->One of the crucial aspects of trading automation is the management of orders. The system operates with assumptions that must be verified and synchronized with the exchange. Learning how the Low-Frequency Trading Bot manages orders will help you understand the life cycle of orders and how your definitions in the Open Stage and the Close Stage affect the results.

Chapter X - Order Management

One of the crucial aspects of trading automation is the management of orders. The system operates with assumptions that must be verified and synchronized with the exchange. Learning how the Low-Frequency Trading Bot manages orders will help you understand the life cycle of orders and how your definitions in the Open Stage and the Close Stage affect the results.

Table of Contents

1. Overview of the Management Issue

2. Reviewing Defined Orders

3. Opening Orders

4. Maintaining Live Orders

5. Checking Exchange Events

6. Syncing With the Exchange

7. Canceling Orders

8. Maintaining Simulated Orders

9. Simulating Check of Events

10. Simulating Sync With the Exchange

11. Simulating Order Cancellations

12. Accounting

XI->Foundations->Topic->Trading Engine->The trading engine is about making the data processed by the Trading Bot accessible. Use it while debugging strategies to visually track every piece of information processed by the trading bot at any point in time. Use it from within trading systems to feed strategies with the details of what happens at runtime.

Chapter XI - Trading Engine

The trading engine is about making the data processed by the Trading Bot accessible. Use it while debugging strategies to visually track every piece of information processed by the trading bot at any point in time. Use it from within trading systems to feed strategies with the details of what happens at runtime.

Table of Contents

1. Trading Engine Hierarchy

2. Monitoring Runtime Data

3. Trading Bot Output

4. Temporal Context - Current and Last

5. Conceptual Context - Episode, Strategy, Position, Strategy Stages

6. Base Asset and Quoted Asset

7. Counters

8. Statistics

9. Distance-To-Trading-Events

10. Balances

11. Common Metrics - Hits, Fails, Hit Ratio, Profit Loss, ROI, Annualized Rate of Return

12. Accounts Specific to the Open and Close Stages

13. Accounts Specific to Orders

14. Market Data

15. Identity and Status

XII->Foundations->Topic->Trading Farms->Superalgos may coordinate Data Tasks and Trading Tasks across different machines on a network. Trading farms provide a robust environment for smart and scalable deployments.

Chapter XII - Trading Farms

Superalgos may coordinate Data Tasks and Trading Tasks across different machines on a network. Trading farms provide a robust environment for smart and scalable deployments.

Table of Contents

1. Trading Farms - Fundamental Concepts

2. Trading Farms - Set Up a Network of Nodes

3. Trading Farms - Operating a Trading Farm

XIII->Foundations->Topic->Crypto Ecosystem->The crypto ecosystem manages the interactions with parties external to Superalgos, primarily exchanges.

Chapter XIII - Crypto Ecosystem

The crypto ecosystem manages the interactions with parties external to Superalgos, primarily exchanges.

Table of Contents

1. Crypto Ecosystem Hierarchy

2. How to Install a New Market

3. How to Uninstall an Existing Market

XIV->Foundations->Topic->Integrations->Superalgos integrates with Telegram Bots to broadcast announcements emerging from trading sessions. On the other hand, Superalgos supports receiving webhook messages, enabling automated actions originating from messages sent from third-party services, like TradingView.

Chapter XIV - Integrations

Superalgos integrates with Telegram Bots to broadcast announcements emerging from trading sessions. On the other hand, Superalgos supports receiving webhook messages, enabling automated actions originating from messages sent from third-party services, like TradingView.

Table of Contents

1. Telegram Announcements

2. Webhook Notifications

XV->Foundations->Topic->Productivity Tools->This chapter discusses a collection of tools that help optimize productivity.

Chapter XV - Productivity Tools

This chapter discusses a collection of tools that help optimize productivity.

Table of Contents

1. Backups

2. Clones

3. Shares

4. Screen Capture and Sharing

XVI->Foundations->Topic->Troubleshooting->Superalgos is a vast system and you will run into confusing situations while learning it. You must acquire the knowledge on how to analyze the issues that you may encounter. There usually is a good explanation for what is going on. This chapter helps you in that process.

Chapter XVI - Troubleshooting

Superalgos is a vast system and you will run into confusing situations while learning it. You must acquire the knowledge on how to analyze the issues that you may encounter. There usually is a good explanation for what is going on. This chapter helps you in that process.

Table of Contents

1. How to Troubleshoot an Issue

2. How to Report an Issue

3. How to Upgrade Your Existing Installation

4. Initial Setup - Node is not Recognized as an Internal or External Command

5. Initial Setup - Superalgos Failed to Connect Via Websockets

6. Perception Issues - My System Gets Slow

7. Perception Issues - There Are No Candles on The Charts

8. Perception Issues - Market Data or Indicators Seem to be Outdated

9. Perception Issues - Indicator Data Seems Wrong

10. Investigating Issues - I Think I Broke Something... How Do I Start Over?

11. Investigating Issues - On-Screen Errors and Warnings

12. Investigating Issues - Check for Errors at the Browser

13. Investigating Issues - Check the Integrity of Your Data

14. Debugging a Task

15. Debugging a New Indicator

16. Browser Compatibility

17. Problems Saving The Workspace or Plugins

18. Problems With Computer Time

XVII->Foundations->Topic->Contributing to Superalgos->Superalgos is a Community project. Everything you build with Superalgos is susceptible to be contributed to the project. Contributing to the project earns you Superalgos (SA) tokens! This chapter covers how you may contribute some of the intelligence you build for yourself, and also how you may get involved with the project at a deeper level.

Chapter XVII - Contributing to Superalgos

Superalgos is a Community project. Everything you build with Superalgos is susceptible to be contributed to the project. Contributing to the project earns you Superalgos (SA) tokens! This chapter covers how you may contribute some of the intelligence you build for yourself, and also how you may get involved with the project at a deeper level.

Table of Contents

1. How to Contribute to Superalgos

2. How to Contribute a Trading System

3. How to Contribute Icons

4. How to Contribute to the Docs

5. How to Contribute Translations

6. How to Contribute Tutorials

7. How to Contribute Themes