Glimpse is an open source bundle of systems and algorithms that together automate strategies and signals in brokers.
Currently IQ Option is the only broker implemented. You can check the API in this link.
Table of content:
Main method of communication between servers and applications, it contains all routes and functions necessary for communication between Glimpse systems.
Scripts that receive commands from users and perform operations.
Scripts that perform checks and data acquisition regarding assets and/or currency pairs.
Web/Android application where the user can configure, command and analyze remote operations.
Web application to manage users, operations and extra settings.
Main method of storing data and information.
All commands and information managed in apps are send though the API to the database where the operational scripts wait for instructions.
The auxiliary scripts constantly collect data via the broker's API and store/update this data in the database.
Upon receiving some instruction, the operational scripts compare the data collected by the auxiliary scripts and, according to the command sent by the user, it executes the operations via the broker's API.
The operational script collects the results of operations and stores them in the database, thus providing information to display in web and mobile applications.
This guide will provide the basics for all the Glimpse system to run.
In order to run the Glimpse bundle you need to download and install the following programs:
- Make sure you've installed MongoDB Community and open MongoDB Compass.
- Create a new connection or press
Ctrl + Nand paste the connection stringmongodb://localhost:27017then click Connect. - Click in the green button called Create Database. In the Database Name type
Glimpseand in the Collection Name typeAccounts. - After creating the collection named Accounts, you will need to create the following collections inside the Glimpse database you just created:
- ActivesSchedule
- AllSignals
- Auxiliar
- Codes
- ManagerAccounts
- ManagerAudit
- OpenedActives
- Operations
- RealtimeCandles
- Servers
- Signals
- Strategies
- After creating all the needed collections you will need to import the base data into every collection. For this step, select a collection, click on the green button ADD DATA, click on Import File, Select a file... and navigate to the folder Collections inside the project, select the corresponding file name for the collection you've selected and then click Open. After click on the green button IMPORT.
- Do the same thing for all the collections. Be cautious to not import twice.
- You will notice that there's some default data inside the Account collection that we've just imported. You can change the "email" and "password" fields to access the app later on. Note that this procedure is not needed after the account creation process.
- After importing all the collection files we're done with the database and you can proceed to the next step.
With Python installed, now we need to install some modules. Open your command prompt and type the following commands:
pip install flaskFlask to create our API.pip install flask-corsFlask CORS to allow Cross Origin Resource Sharing.pip install pymongoMongoDB module to connect to our database.pip install dnspythonA required module for pymongo to work.pip install pytzModule for calculating timezones.pip install git+git://github.com/iqoptionapi/iqoptionapi.gitIQ Option API its our broker bridge.pip install websocket-client==0.56Module required for connecting to the IQ Option API.
After installing all the packages above, open your MongoDB Compass and inside your Auxiliar collection, edit the value field of the document with your computer's IP Address where name is equal to apiAddress. This will allow you apps and scripts to connect to your API.
Now edit the document where name is equal to analysisAccount. Set the value to a working IQ Option account with a slash / between email and password. ie.: email/password. This account will be used to connect to the broker's API and collect data. You can use a non verified account.
Inside the folder API is located the routes.py and actions.py, the main scripts for our API.
Run the file routes.py and our API should now be working.
Keep in mind that some other scripts and files would want to connect to your API like app connection file, operational server, as well as the auxiliar and candles scripts, so you have to set your API's IP Address on that files for it to work.
Before we run the operational server scripts, we need to run the auxiliar scripts. They will provide important data to our algorithms analyze.
The auxiliar scripts are composed for the following scripts:
lister.pyScript used to list opened currency pairs and its payouts.serverAssigner.pyScript that assign a waiting user to a waiting operational server.candlesStarter.pyScript that will start the candles stream for all the currency pairs located at/auxiliar/candles/.
The lister.py script will connect to the broker's api and save on the database informations about currently opened currency pairs and its payouts. To work properly, you need to set the analysisAccount on the Auxiliar collection. Inside this script you can set the interval of its functions.
The serverAssigner.py script its responsible for await operating commands from users watching its values from the database and assigning the commands to the not in use operational server. You can set its intervals inside the script.
The candleStarter.py script iterate inside the folder /auxiliar/candles and start all the scripts. Each script inside the candles folder start a candle stream of a currency pair and save the data gathered into the database.
In order to work properly, all the 3 auxiliar scripts must be running.
The operational server is composed of two scripts, the main one server.py and the auxiliar sequenceFinder.py.
The server.py script is the main cause it awaits for the user commands, analyze the data coming from the database and place orders in the broker's api.
The server.py also is responsible for place signal orders.
The sequenceFinder.py, as its name suggests, is a script capable of compare the candles provided by the auxiliar scripts and send back an information to the server.py script to proceed with the orders.
To start your operational server, simply run the server.py script.
The web and mobile app are the main way to send commands and/or view informations about the orders placed as well as results and settings.
The app was developed with Ionic framework using React and you will need to install the Ionic CLI in order to configure or run the app.
To do so, open your command prompt and type npm install -g @ionic/cli then press enter.
To further understand or know more about Ionic, visit this page.
After installing the Ionic CLI, inside your command prompt, navigate into the app folder located at /app/. Once there, execute the command npm install. This command will install all the dependencies for the app project.
After running npm install inside the app folder, if some errors appear, it might be needed to install the types for the Ionic and React. Usually the types are installed with the frameworks but if you still have errors type in your command prompt npm install @types/ionic @types/react and now the errors should be fixed. If the errors persists and you can't find a way to fix it, you're welcome to open an issue in this repository and I'll be more than happy to help.
Now, with our packages installed, you can simply run ionic serve inside the app folder and your development server will start. You can access it visiting http://localhost:8100. You can make further changes in the development server if you wish, to do so, visit the ionic documentation to learn how.