Merge pull request #473 from julian-molina/develop
Contribution: How To Pages
This commit is contained in:
5 files changed
+215
No files matched your search
+16
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"topic": "Crypto Ecosystem",
|
||||
"pageNumber": "2",
|
||||
"type": "How to Install a New Market",
|
||||
"definition": {
|
||||
"text": "To install a new market, select Install Market on the menu of the market you wish to install. If the market is not set up, then you must set it up first.",
|
||||
"updated": 1611651225966
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "For the details, please follow the Install New Market tutorial on the Getting Started Workspace.",
|
||||
"updated": 1611651240216
|
||||
}
|
||||
]
|
||||
}
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"topic": "Crypto Ecosystem",
|
||||
"pageNumber": "3",
|
||||
"type": "How to Uninstall an Existing Market",
|
||||
"definition": {
|
||||
"text": "To uninstall an existing market, select Uninstall Market on the menu of the market you wish to uninstall.",
|
||||
"updated": 1611650874487
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "1. Expand the exchange markets node of your preferred crypto exchange in the crypto ecosystem hierarchy.",
|
||||
"updated": 1611650884837
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "2. Select Uninstall Market on the menu of the market you wish to uninstall."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "The function deletes all the infrastructure associated with the market that may have been created using the Install Market function.",
|
||||
"updated": 1611650909369
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
+49
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"topic": "Crypto Ecosystem",
|
||||
"pageNumber": "4",
|
||||
"type": "How to Set Up a New Exchange",
|
||||
"definition": {
|
||||
"text": "To set up a new exchange, find it in the Untested crypto exchanges node and bring it to a less crowded crypto exchanges node to make room for the new setup. Then add the assets and the markets you wish to work with, and finally, install the markets.",
|
||||
"updated": 1611651356918
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Not all tested exchanges are set up in the default workspace. If you wish to use an exchange that is not set up in the workspace, you may set it up yourself following the instructions below.",
|
||||
"updated": 1611651386757
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Start Here",
|
||||
"updated": 1611651407421
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "1. Expand the Untested crypto exchanges node in the crypto ecosystem hierarchy."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "2. Locate the desired exchange, detach it from its parent, and attach it to the Testing Queue crypto exchanges node. You may choose to attach your select exchange node to any other crypto exchanges node, or even add a new one. This is merely for organizational purposes and to keep the workspace tidy."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "If the exchange you are looking for is not available there, it means it can not be setup in Superalgos at this point, likely for either or both of the following reasons: 1. The exchange does not provide one-minute candles; 2. The exchange does not provide a list of markets. Not all exchanges supported by the CCXT library comply in full with the standards proposed.",
|
||||
"updated": 1611651421882
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "There are over 60 exchanges complying with the CCXT library API standard, an open-source effort to standardize communications with crypto exchanges, to the level required by Superalgos. If your exchange is not among those 60 plus exchanges, you may want to consider trading somewhere else. This is why: automating trading at your exchange requires building and maintaining a custom connector to speak with their API. It is unlikely that you will find an open-source project—or even a commercial solution—willing to do that, unless your exchange is in the top-10 list of exchanges in the world by volume traded.",
|
||||
"updated": 1611651429157
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "Alternative approach 1: Convince your exchange to comply with the standard.",
|
||||
"updated": 1611651439395
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "Alternative approach 2: Develop your own connector. We’ll be happy to guide you and help you along the way!",
|
||||
"updated": 1611651447177
|
||||
}
|
||||
]
|
||||
}
|
||||
+80
@@ -0,0 +1,80 @@
|
||||
{
|
||||
"topic": "Crypto Ecosystem",
|
||||
"pageNumber": "6",
|
||||
"type": "How to Test New Exchanges",
|
||||
"definition": {
|
||||
"text": "While only a few exchanges have been tested by the team, you may wish to test other exchanges you may be interested in. This is how.",
|
||||
"updated": 1611651607248
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Testing new exchanges is a technical endeavor that requires a good understanding of how Superalgos works with data. These are a few logical steps you should take to test the OHLCV and trading capabilities…",
|
||||
"updated": 1611651621128
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Start Here"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "1. Set up the exchange you wish to test."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "2. Install the market you wish to test."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "3. Run the Sensor Bot task and monitor the console for errors. If everything seems to be working fine, then proceed."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "4. Run the indicator bot tasks required to run a trading session with the trading system of your choice."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "5. Run a backtesting session."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "6. Run a paper trading session."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "7. Run a live trading session."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "What to Do If You Encounter Problems"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You may encounter all sorts of issues while testing a new exchange, at any one of the steps listed above. If you are really interested in working with the exchange and are willing to put some time and effort into investigating the issues, we will be happy to work with you and develop fixes that may help overcome any problems you may run into. Superalgos is prepared to send arbitrary parameters to API calls, so solving the issue may be quite easy. All we need from you is to point us in the right direction by contributing the initial research."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "These are a few things we’ve learnt while testing exchanges, that may help you in the process:"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Study the exchange’s API documentation."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Be aware that exchanges may publish more than one API, or an API with mutliple versions."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "There may be more than one way to make a certain request and Superalgos may be making it in the non-optimal way for that particular exchange. For example, we may be querying the wrong API."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Some exchanges may behave differently when the user is authenticated with API keys, even when retrieving data. For example, Binance allows downloading up to one-day worth of historical trades information when the user is not authenticated, but allows downloading trades spanning the whole market when authenticated."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"topic": "Network",
|
||||
"pageNumber": "14",
|
||||
"type": "How to Safely Close Superalgos",
|
||||
"definition": {
|
||||
"text": "The correct way to close Superalgos is to stop all tasks in the data-mining and trading operations, wait a few seconds until the tasks stop, and only then close the browser. Before closing the console, you must wait around a minute until there is no further activity.",
|
||||
"updated": 1611650579593
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The backend application runs independently from the frontend browser-based application. You may close the browser at any point without affecting your data-mining operation or the bots you may be running in your testing or prodution environments. Once you restart the browser and navigate to the correct URL, the frontend app reconnects with the backend and you regain control over the whole operation.",
|
||||
"updated": 1611650588719
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "If you wish to completely close Superalgos and stop all operations, there is a safe way to do this while preventing the corruption of files that may be processing at any point.",
|
||||
"updated": 1611650597554
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Start Here"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "1. Close all data-mining tasks. Select Stop All Exchange Data Tasks on the data mining node menu."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "2. Close all tasks in the testing environment and the production environment. Select Stop All Task Managers in the testing and production environment nodes menus."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "3. Wait a few seconds until all tasks are stopped and close the browser."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "4. Wait for about one minute until all activity stops in the console, then close it."
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user