-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME_client_MQL4.md
133 lines (80 loc) · 8.53 KB
/
README_client_MQL4.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# Singularity: MQL4 Client
Periodically sends orders status, account status and market information as a pending evaluation request to a singularity node, and later request the evaluation result containing the explicit actions the client must perform for a list of currency pairs (max one order per symbol for now).
[](https://travis-ci.org/harveybc/singularity)
[](https://harveybc-singularity.readthedocs.io/en/latest/)
[](https://bettercodehub.com/)
[](https://github.com/harveybc/singularity/blob/master/LICENSE)
## Description
Sends with a configurable periodicity, the following Web requests consecutively to a configurable URL:
### 1. Input Data Upload Request (POST /inputs)
It is a POST request in the /inputs route of the configured URL. It is used to upload the data to be evaluated to a singularity node where it can be fetched by an evaluator for processing.
The folowing are the _parameters_ of the request:
* __api_key__ : string provided to a client for authentication when created with the client role in a node of a singualrity network.
* __json_contents__ : data that will be stored in the nodes in a singularity network.
The following are the JSON_contents fields:
* __order_status__: The status (profit, buy_or_sell ,open_price, open_date, sl, tp) of all open orders for a configurable list of symbols.
* __account_status__: The current balance and equity.
* __market_info__: An array of price (high,low,open,close), volume, and a configurable list of technical indicators optionally for 3 configurable timeframes.
The following are the _response_ fields if the request was successful:
* __input_id__: identification of the input data, to be used from the following request.
The information transmitted to a singularity node is flagged as pending for evaluation, an evaluator in the network that is using the most optimized agent fetches the evaluation data, pre-process the information and evaluates the agent wich generate a trading action as result.
### 2. Pending Evaluation Request (POST /evaluations)
It is a POST request in the /evaluations route of the configured URL. It is used to create a new pending evaluation in a singularity node, it must contain as a parameter the __input_id__ of the data to be evaluated.
The folowing are the parameters of the request:
* __api_key__ : string provided to a client for authentication when created with the client role in a node of a singualrity network.
* __input_id__: identification of the input data, found on the response to an Input Data Upload request.
The following are the _response_ fields if the request was successful:
* __evaluation_id__: identification of the pending evaluation, to be used from the following request.
After a successful request (HTTP response code:200), after a period of time, the client should start querying if the evaluation hasbeen done using the following request.
### 3. Evaluation Status Request (GET /evaluations/<evaluation_id>)
It is a GET request in the /evaluations/<evaluation_id> route of the configured URL. It is used to verify if a pending evaluation has been already processed and to get the id of the output (__output_id__), required to retrieve the results with the next request, it must be performed periodically after a pending evaluation request until its status is 2 (done).
The folowing are the parameters of the request:
* __api_key__ : string provided to a client for authentication when created with the client role in a node of a singualrity network.
The following are the _response_ fields if the request was successful:
* __status__: it can be 0 = pending, 1 = being processed by an evaluator, 2 = results generated and uploaded to the outputs table of singularity
* __output_id__: identification of the pending evaluation, to be used from the following request. It is void if the status is different from 2.
### 4. Evaluation Results Request (GET /outputs/<output_id>)
It is a GET request in the /outputs/<output_id> route of the configured URL. It us used to retrieve the results from an evaluation, the output_id parameter is obtained when a pending evaluation gets to status 2.
The folowing are the parameters of the request:
* __api_key__ : string provided to a client for authentication when created with the client role in a node of a singualrity network.
The following are the _response_ fields if the request was successful:
* __json_results__ : JSON containing the results.
The json_contents variable contains an array of the size of the number of symbols configured, each array element contains the following fields for each symbol:
* __close_order__: boolean, if true, close existing order in this symbol
* __open_buy__: boolean, if true, opens a buy order
* __open_sell__: boolean, if true, opens a sell order
* __order_volume__: oder volume (if open_buy or open_sell)
* __open_price__: order open price (if open_buy or open_sell)
* __take_profit__: take profit in pips
* __stop_loss__: stop loss in pips
### 5. Removal of Input, Evaluation and Output Data from database (DELETE /inputs/<input_id> , DELETE /evaluations/<evaluation_id> , DELETE /outputs/<output_id>)
It is the consecutive execution of 3 requests with the HTTP DELETE method on the routes: /inputs/<input_id>, /outputs/<output_id>, /evaluations/<evaluation_id>
It deletes the input, output and evaluation registers from the singularity database to save space unless an historic of evaluation data is required.
The only parameter of the requests are the __api_key__, and they respond a code 200 if ok.
The client is implemented in the [singularity_client.mql4](https://github.com/harveybc/singularity/blob/master/clients/singularity_client.mql4).
## Installation
The module is installed with the singularity package, the instructions are described in the [singularity README](../master/README.md).
### Execution
The singularity_client MQL4 expert must be copied or linked from the clients folder in the singlarity repo, to the experts folder of Metatrader 4 from where it can be loaded as any other expert.
### MQL4 Expert Parameters
The following are the expert's parameters:
### General Expert Parameters
These parameters configure the connectivity parameters and the main timeframe.
* __node_url__: (Default: localhost) URL of a singularity node.
* __api_key__: (Def: "test") string provided to a singularity client for authentication when created with the client role in a node of a singualrity network.
* __period_main__: (Def: PERIOD_H1) period between request sequences in minutes, also is the timeframe for candles and tech indicators.
* __period_status__: (Def: 5) period between evaluation status requests in seconds.
* __window_size__: (Def: 15) sliding-window size, the number of previous values to the current one for each feature calculated (ie. for period_main = PERIOD_H1, window_size+15, includes prices for the latest 15 hours as adyacent columns to the current prices, tech indicators for the last 15 hours, volumes for the last 15 hours, etc..)
### json_content.market_info Related Expert Parameters
The following parameters configure the contents of the market information inside json_contents that is going to be transmitted to the server via web requests to be used as observations by an agent (after being preprocessed in the server).
* __short_term__: (Def: false) if true, add technical indicators with period = tech_period/short_term_divisor
* __long_term__: (Def: false) if true, add technical indicators with period = tech_period*long_term_multiplier
* __short_term_divisor__: (Def: 3) see parameter __short_term__
* __long_term_multiplier__: (Def: 3) see parameter __long_term__
* __symbols__: (Def: "EURUSD,USDJPY,GBPUSD") list of symbols.
* __tech_period__: (Def: 15) main period for technical indicators (is not the same as the common timeframe parameter in technincal indicators which must be set to __period_main__)
* __variation__: (Def: false) if true, include in market_info the variation of all values values (current-previous) additional to the current values in an adyacent column?.
* __prices__:(Def: true) if true, include high, low and close for each symbol
* __volumes__:(Def: true) if true, include the volume for each symbol.
* __tech_indicators__:(Def: "iMA,iRSI,iADX,iMACD,iOBV") list of technical indicators.
* __timestamp__: (Def:true) include the current candle timestamp.