diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/roi.json b/Projects/Superalgos/Schemas/Docs-Nodes/roi.json index 710b5f514..7450790ca 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/roi.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/roi.json @@ -4,9 +4,75 @@ "text": "ROI is a ratio that compares the profit loss with the cost of the investment, expressed as a percentage." }, "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1611332841853 + }, { "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "text": "In general financial terms, ROI is equal to the Net Return on Investment divided by the Cost of Investment, expressed as a percentage." + }, + { + "style": "Text", + "text": "In Superalgos, the Net Return on Investment is the profit loss, as defined elsewhere. The Cost of Investment is solely the begin balance, as the fees are subtracted from the balance to calculate the profit loss, so we don’t need to account for them in the divisor side of the ratio." + }, + { + "style": "Text", + "text": "That is:" + }, + { + "style": "Javascript", + "text": "ROI = profit loss / begin balance * 100" + }, + { + "style": "Text", + "text": "In the context of the episode base asset and episode quoted asset, the calculation is done relative to the corresponding assets, and the overall context." + }, + { + "style": "Text", + "text": "The formula:" + }, + { + "style": "Javascript", + "text": "tradingEngine.current.episode.episodeBaseAsset.ROI.value =\n tradingEngine.current.episode.episodeBaseAsset.profitLoss.value /\n tradingEngine.current.episode.episodeBaseAsset.beginBalance.value * 100 \n \ntradingEngine.current.episode.episodeQuotedAsset.ROI.value =\n tradingEngine.current.episode.episodeQuotedAsset.profitLoss.value /\n tradingEngine.current.episode.episodeQuotedAsset.beginBalance.value * 100", + "updated": 1611332768337 + }, + { + "style": "Text", + "text": " " + }, + { + "style": "Text", + "text": "In the context of the position base asset and position quoted asset, the size filled is used instead of the balance, so that ROI may be properly calculated for complex execution algorithms.", + "updated": 1611332787435 + }, + { + "style": "Text", + "text": "The formula:" + }, + { + "style": "Javascript", + "text": "tradingEngine.current.position.positionBaseAsset.ROI.value =\n tradingEngine.current.position.positionBaseAsset.profitLoss.value * 100 /\n tradingEngine.current.strategyOpenStage.stageBaseAsset.sizeFilled.value\n \ntradingEngine.current.position.positionQuotedAsset.ROI.value =\n tradingEngine.current.position.positionQuotedAsset.profitLoss.value * 100 /\n tradingEngine.current.strategyOpenStage.stageQuotedAsset.sizeFilled.value", + "updated": 1611332799800 + }, + { + "style": "Text", + "text": "In the context of the episode statistics, the calculation is done using the consolidated balance, as explained in the profit loss definition.", + "updated": 1611332810457 + }, + { + "style": "Text", + "text": " Note: When the context does not refer to either of the assets in particular, then both asset balances are consolidated, and denominated in the quoted asset." + }, + { + "style": "Text", + "text": "The formula:" + }, + { + "style": "Javascript", + "text": "tradingEngine.current.episode.episodeStatistics.ROI.value =\n (\n tradingEngine.current.episode.episodeBaseAsset.profitLoss.value * \n tradingEngine.current.episode.endRate.value +\n tradingEngine.current.episode.episodeQuotedAsset.profitLoss.value\n ) / (\n tradingEngine.current.episode.episodeBaseAsset.beginBalance.value * \n tradingEngine.current.episode.beginRate.value +\n tradingEngine.current.episode.episodeQuotedAsset.beginBalance.value\n ) * 100", + "updated": 1611332824026 }, { "style": "Block", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-009-distance-to-events.json b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-009-distance-to-events.json new file mode 100644 index 000000000..f3712aae0 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-009-distance-to-events.json @@ -0,0 +1,30 @@ +{ + "topic": "Trading Engine", + "pageNumber": "9", + "type": "Distance to Events", + "definition": { + "text": "Track the number of periods that have passed since the last occurrence of each type of event. On this page: Trigger On, Trigger Off, Take Position, Close Position, Next Phase, Move to Phase, Create Order, Cancel Order, Close Order.", + "updated": 1611327154424 + }, + "paragraphs": [ + { + "style": "Include", + "text": "Superalgos->Node->Distance To Event->Definition", + "updated": 1611327304404 + }, + { + "style": "Include", + "text": "Superalgos->Node->Distance To Event->Content", + "updated": 1611327325113 + }, + { + "style": "Include", + "text": "Superalgos->Concept->Reusable Snippets->Note for Hierarchy Tables No Discussion" + }, + { + "style": "Hierarchy", + "text": "Superalgos->Distance To Event->2", + "updated": 1611327347651 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-010-balances.json b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-010-balances.json new file mode 100644 index 000000000..50e375fe7 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-010-balances.json @@ -0,0 +1,69 @@ +{ + "topic": "Trading Engine", + "pageNumber": "10", + "type": "Balances", + "definition": { + "text": "Keep track of the balances of each asset, at different points in time. On this page: Balance, Begin Balance, and End Balance.", + "updated": 1611331647405 + }, + "paragraphs": [ + { + "style": "Text", + "text": "Balances are the basis of the account-keeping features, by which you may know exactly how much of each asset there is on the account at any given point in time.", + "updated": 1611331659066 + }, + { + "style": "Text", + "text": "The system keeps track of balances in multiple contexts, but also saves snapshots of what the balance was at key moments in time, so that such information may be available both to study the results of operations, and so that it may be used form within trading strategies." + }, + { + "style": "Callout", + "text": "It is important to understand that balances are an internal concept managed by the trading engine, and are calculated based on the information processed by the trading bot. Balances do not necessarily reflect the actual amount of assets at the exchange." + }, + { + "style": "Title", + "text": "Balance", + "updated": 1611331710709 + }, + { + "style": "Include", + "text": "Superalgos->Node->Balance->Definition", + "updated": 1611331715062 + }, + { + "style": "Include", + "text": "Superalgos->Node->Balance->Content", + "updated": 1611331718713 + }, + { + "style": "Title", + "text": "Begin Balance", + "updated": 1611331731595 + }, + { + "style": "Include", + "text": "Superalgos->Node->Begin Balance->Definition", + "updated": 1611331735070 + }, + { + "style": "Include", + "text": "Superalgos->Node->Begin Balance->Content", + "updated": 1611331738675 + }, + { + "style": "Title", + "text": "End Balance", + "updated": 1611331749501 + }, + { + "style": "Include", + "text": "Superalgos->Node->End Balance->Definition", + "updated": 1611331752868 + }, + { + "style": "Include", + "text": "Superalgos->Node->End Balance->Content", + "updated": 1611331756749 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-011-common-metrics-hits-fails-hit-ratio-profit-loss-roi annualized rate of return.json b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-011-common-metrics-hits-fails-hit-ratio-profit-loss-roi annualized rate of return.json new file mode 100644 index 000000000..21256f093 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-011-common-metrics-hits-fails-hit-ratio-profit-loss-roi annualized rate of return.json @@ -0,0 +1,101 @@ +{ + "topic": "Trading Engine", + "pageNumber": "11", + "type": "Common Metrics - Hits, Fails, Hit Ratio, Profit Loss, ROI, Annualized Rate of Return", + "definition": { + "text": "These metrics are available in different contexts, for instance, at the level of the Episode, the Position or the Position, and both for the base and quoted assets.", + "updated": 1611333971023 + }, + "paragraphs": [ + { + "style": "Title", + "text": "Hits", + "updated": 1611331909747 + }, + { + "style": "Include", + "text": "Superalgos->Node->Hits->Definition", + "updated": 1611331919409 + }, + { + "style": "Include", + "text": "Superalgos->Node->Hits->Content", + "updated": 1611331922558 + }, + { + "style": "Title", + "text": "Fails", + "updated": 1611331934877 + }, + { + "style": "Include", + "text": "Superalgos->Node->Fails->Definition", + "updated": 1611331939264 + }, + { + "style": "Include", + "text": "Superalgos->Node->Fails->Content", + "updated": 1611331942803 + }, + { + "style": "Title", + "text": "Hit Ratio", + "updated": 1611331974360 + }, + { + "style": "Include", + "text": "Superalgos->Node->Hit Ratio->Definition", + "updated": 1611331977537 + }, + { + "style": "Include", + "text": "Superalgos->Node->Hit Ratio->Content", + "updated": 1611331980968 + }, + { + "style": "Title", + "text": "Profit Loss", + "updated": 1611332640555 + }, + { + "style": "Include", + "text": "Superalgos->Node->Profit Loss->Definition", + "updated": 1611332643604 + }, + { + "style": "Include", + "text": "Superalgos->Node->Profit Loss->Content", + "updated": 1611332647277 + }, + { + "style": "Title", + "text": "ROI", + "updated": 1611332671387 + }, + { + "style": "Include", + "text": "Superalgos->Node->ROI->Definition", + "updated": 1611332674792 + }, + { + "style": "Include", + "text": "Superalgos->Node->ROI->Content", + "updated": 1611332677943 + }, + { + "style": "Title", + "text": "Annualized Rate Of Return", + "updated": 1611332963859 + }, + { + "style": "Include", + "text": "Superalgos->Node->Annualized Rate Of Return->Definition", + "updated": 1611332970973 + }, + { + "style": "Include", + "text": "Superalgos->Node->Annualized Rate Of Return->Content", + "updated": 1611332975434 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-012-accounts-specific-to-the-open-and-close-stages.json b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-012-accounts-specific-to-the-open-and-close-stages.json new file mode 100644 index 000000000..1053f9738 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-012-accounts-specific-to-the-open-and-close-stages.json @@ -0,0 +1,71 @@ +{ + "topic": "Trading Engine", + "pageNumber": "12", + "type": "Accounts Specific to the Open and Close Stages", + "definition": { + "text": "Learn about accounts specific to the context of the open and close stages. On this page: Target Size, Size Placed, Size Filled, and Fees Paid.", + "updated": 1611335734722 + }, + "paragraphs": [ + { + "style": "Title", + "text": "Target Size", + "updated": 1611335751425 + }, + { + "style": "Include", + "text": "Superalgos->Node->Target Size->Definition", + "updated": 1611335756518 + }, + { + "style": "Include", + "text": "Superalgos->Node->Target Size->Content", + "updated": 1611335759648 + }, + { + "style": "Title", + "text": "Size Placed", + "updated": 1611335767899 + }, + { + "style": "Include", + "text": "Superalgos->Node->Size Placed->Definition", + "updated": 1611335798845 + }, + { + "style": "Include", + "text": "Superalgos->Node->Size Placed->Content", + "updated": 1611335806225 + }, + { + "style": "Title", + "text": "Size Filled", + "updated": 1611335816288 + }, + { + "style": "Include", + "text": "Superalgos->Node->Size Filled->Definition", + "updated": 1611335820275 + }, + { + "style": "Include", + "text": "Superalgos->Node->Size Filled->Content", + "updated": 1611335823030 + }, + { + "style": "Title", + "text": "Fees Paid", + "updated": 1611335839409 + }, + { + "style": "Include", + "text": "Superalgos->Node->Fees Paid->Definition", + "updated": 1611335846433 + }, + { + "style": "Include", + "text": "Superalgos->Node->Fees Paid->Content", + "updated": 1611335849981 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-013-accounts-specific-to-orders.json b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-013-accounts-specific-to-orders.json new file mode 100644 index 000000000..614a434bb --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-013-accounts-specific-to-orders.json @@ -0,0 +1,101 @@ +{ + "topic": "Trading Engine", + "pageNumber": "13", + "type": "Accounts Specific to Orders", + "definition": { + "text": "Learn about accounts specific to the context of orders. On this page: Rate, Actual Rate, Size, Percentage Filled, Fees Paid, and Lock.", + "updated": 1611336548381 + }, + "paragraphs": [ + { + "style": "Title", + "text": "Rate", + "updated": 1611336589519 + }, + { + "style": "Include", + "text": "Superalgos->Node->Rate->Definition", + "updated": 1611336592312 + }, + { + "style": "Include", + "text": "Superalgos->Node->Rate->Content", + "updated": 1611336595025 + }, + { + "style": "Title", + "text": "Actual Rate", + "updated": 1611336604269 + }, + { + "style": "Include", + "text": "Superalgos->Node->Actual Rate->Definition", + "updated": 1611336607169 + }, + { + "style": "Include", + "text": "Superalgos->Node->Actual Rate->Content", + "updated": 1611336610243 + }, + { + "style": "Title", + "text": "Size", + "updated": 1611336619074 + }, + { + "style": "Include", + "text": "Superalgos->Node->Size->Definition", + "updated": 1611336621768 + }, + { + "style": "Include", + "text": "Superalgos->Node->Size->Content", + "updated": 1611336624678 + }, + { + "style": "Title", + "text": "Percentage Filled", + "updated": 1611336634683 + }, + { + "style": "Include", + "text": "Superalgos->Node->Percentage Filled->Definition", + "updated": 1611336637426 + }, + { + "style": "Include", + "text": "Superalgos->Node->Percentage Filled->Content", + "updated": 1611336641053 + }, + { + "style": "Title", + "text": "Fees Paid", + "updated": 1611336663062 + }, + { + "style": "Include", + "text": "Superalgos->Node->Fees Paid->Definition", + "updated": 1611336665926 + }, + { + "style": "Include", + "text": "Superalgos->Node->Fees Paid->Content", + "updated": 1611336669591 + }, + { + "style": "Title", + "text": "Lock", + "updated": 1611336682293 + }, + { + "style": "Include", + "text": "Superalgos->Node->Lock->Definition", + "updated": 1611336685521 + }, + { + "style": "Include", + "text": "Superalgos->Node->Lock->Content", + "updated": 1611336688288 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-014-market-data.json b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-014-market-data.json new file mode 100644 index 000000000..beba2c4c2 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-014-market-data.json @@ -0,0 +1,98 @@ +{ + "topic": "Trading Engine", + "pageNumber": "14", + "type": "Market Data", + "definition": { + "text": "Write a summary for this topic page." + }, + "paragraphs": [ + { + "style": "Title", + "text": "Begin", + "updated": 1611336944906 + }, + { + "style": "Include", + "text": "Superalgos->Node->Begin->Definition", + "updated": 1611336947757 + }, + { + "style": "Include", + "text": "Superalgos->Node->Begin->Content", + "updated": 1611336952843 + }, + { + "style": "Title", + "text": "End", + "updated": 1611336959587 + }, + { + "style": "Include", + "text": "Superalgos->Node->End->Definition", + "updated": 1611336962371 + }, + { + "style": "Include", + "text": "Superalgos->Node->End->Content", + "updated": 1611336966142 + }, + { + "style": "Title", + "text": "Begin Rate", + "updated": 1611336976107 + }, + { + "style": "Include", + "text": "Superalgos->Node->Begin Rate->Definition", + "updated": 1611336978830 + }, + { + "style": "Include", + "text": "Superalgos->Node->Begin Rate->Content", + "updated": 1611336981597 + }, + { + "style": "Title", + "text": "End Rate", + "updated": 1611336991778 + }, + { + "style": "Include", + "text": "Superalgos->Node->End Rate->Definition", + "updated": 1611336994931 + }, + { + "style": "Include", + "text": "Superalgos->Node->End Rate->Content", + "updated": 1611336998261 + }, + { + "style": "Title", + "text": "Candle", + "updated": 1611337007474 + }, + { + "style": "Text", + "text": "" + }, + { + "style": "Include", + "text": "Superalgos->Node->Candle->Definition", + "updated": 1611337017053 + }, + { + "style": "Include", + "text": "Superalgos->Node->Candle->Content", + "updated": 1611337019761 + }, + { + "style": "Include", + "text": "Superalgos->Concept->Reusable Snippets->Note for Hierarchy Tables No Discussion" + }, + { + "style": "Hierarchy", + "text": "Superalgos->Candle->2", + "updated": 1611337398702 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-015-identity-and-status.json b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-015-identity-and-status.json new file mode 100644 index 000000000..b5cb7a586 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/trading-engine-015-identity-and-status.json @@ -0,0 +1,161 @@ +{ + "topic": "Trading Engine", + "pageNumber": "15", + "type": "Identity and Status", + "definition": { + "text": "Keep track of information related to the identity or status of the particular object, in the corresponding context. On this page: Index, Serial Number, Identifier, Exchange Id, Status, Exit Type, Situation Name, Situation Name, Algorithm Name, and Algorithm Name.", + "updated": 1611337690744 + }, + "paragraphs": [ + { + "style": "Text", + "text": "This page compiles nodes common to many different contexts and which have a relationship with the identity, status, or similar properties of the object.", + "updated": 1611337706400 + }, + { + "style": "Title", + "text": "Index", + "updated": 1611338005986 + }, + { + "style": "Include", + "text": "Superalgos->Node->Index->Definition", + "updated": 1611338008928 + }, + { + "style": "Include", + "text": "Superalgos->Node->Index->Content", + "updated": 1611338011615 + }, + { + "style": "Title", + "text": "Serial Number", + "updated": 1611338019622 + }, + { + "style": "Include", + "text": "Superalgos->Node->Serial Number->Definition", + "updated": 1611338022203 + }, + { + "style": "Include", + "text": "Superalgos->Node->Serial Number->Content", + "updated": 1611338024711 + }, + { + "style": "Title", + "text": "Identifier", + "updated": 1611338034234 + }, + { + "style": "Include", + "text": "Superalgos->Node->Identifier->Definition", + "updated": 1611338037288 + }, + { + "style": "Include", + "text": "Superalgos->Node->Identifier->Content", + "updated": 1611338041111 + }, + { + "style": "Title", + "text": "Exchange Id", + "updated": 1611338051756 + }, + { + "style": "Include", + "text": "Superalgos->Node->Exchange Id->Definition", + "updated": 1611338054763 + }, + { + "style": "Include", + "text": "Superalgos->Node->Exchange Id->Content", + "updated": 1611338057839 + }, + { + "style": "Title", + "text": "Status", + "updated": 1611338066340 + }, + { + "style": "Include", + "text": "Superalgos->Node->Status->Definition", + "updated": 1611338069198 + }, + { + "style": "Include", + "text": "Superalgos->Node->Status->Content", + "updated": 1611338075010 + }, + { + "style": "Title", + "text": "Exit Type", + "updated": 1611338088984 + }, + { + "style": "Include", + "text": "Superalgos->Node->Exit Type->Definition", + "updated": 1611338091878 + }, + { + "style": "Include", + "text": "Superalgos->Node->Exit Type->Content", + "updated": 1611338095878 + }, + { + "style": "Title", + "text": "Situation Name", + "updated": 1611338259000 + }, + { + "style": "Include", + "text": "Superalgos->Node->Situation Name->Definition", + "updated": 1611338261763 + }, + { + "style": "Include", + "text": "Superalgos->Node->Situation Name->Content", + "updated": 1611338265343 + }, + { + "style": "Title", + "text": "Strategy Name", + "updated": 1611338279553 + }, + { + "style": "Include", + "text": "Superalgos->Node->Strategy Name->Definition", + "updated": 1611338282513 + }, + { + "style": "Title", + "text": "Algorithm Name", + "updated": 1611338404013 + }, + { + "style": "Include", + "text": "Superalgos->Node->Algorithm Name->Definition", + "updated": 1611338523928 + }, + { + "style": "Include", + "text": "Superalgos->Node->Algorithm Name->Content", + "updated": 1611338526964 + }, + { + "style": "Title", + "text": "Order Name", + "updated": 1611338535849 + }, + { + "style": "Include", + "text": "Superalgos->Node->Order Name->Definition", + "updated": 1611338538713 + }, + { + "style": "Include", + "text": "Superalgos->Node->Order Name->Content", + "updated": 1611338541890 + } + ] +} \ No newline at end of file