Merge pull request #14 from ejtraderLabs/dev

Refactoring

Author: traderpedroso

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 110

.github/workflows/update_contributors.yml

@@ -4,4 +4,8 @@ dist/
 *.egg-info/
 .vscode/
 __pycache__
-.DS_Store
+.DS_Store
+fix.ipynb
+examples/test
+.app.py
+.env

.gitignore

@@ -5,65 +5,85 @@
 
 # Python Ctrader Fix API
 
-### ToDo
+`ejtraderCT` is a Python library to access the Ctrader trading platform's FIX API.
+
+## Features
 
-- [ ] Account Information "not possible fix limitation"
 - [x] Market Position buy and sell
-- [x] Peding orders limit and stop 
-- [x] Partial close
-- [x] Stop loss & Take profit
-- [x] Modify Orders 
-- [x] Modify position 
-- [x] real time bid & ask
+- [x] Pending orders limit and stop (No SL and TP)
+- [x] Partial close (No SL and TP)
+- [x] Stop loss & Take profit Only Position
+- [x] Real-time bid & ask
+- [x] Check connection status
+- [x] Custom Client ID and commend in Position
+- [ ] Rest API server (in development)
+- [ ] Webhook for Tradingviewer (in development)
+
+## Prerequisites
 
+The library has been tested on Python 3.7 to 3.9.
 
 ## Installation
-#### Tested on python 3.7 to 3.9
-```
+
+To install the latest version of `ejtraderCT`, you can use pip:
+
+```shell
 pip install ejtraderCT -U
 ```
-#### Or install from source
-
+Or if you want to install from source, you can use:
+```shell
+pip install git+https://github.com/ejtraderLabs/ejtraderCT.git
 ```
-git clone https://github.com/ejtraderLabs/ejtraderCT
-cd ejtraderCT
-python setup.py install
 
-```
+## Accessing the Ctrader FIX API
 
-### Import libraries
 
-```python
-from ejtraderCT import Ctrader
+To access your API, follow these simple steps:
+
+1. Open the cTrader desktop or web platform.
+2. In the bottom left corner of the platform, you will find the **Settings** option. Click on it.
+3. A popup window will appear. In the menu of the popup, look for the last option: **FIX API**.
+4. First, click on the **Change Password** button. Make sure to add a numeric password of at least 8 digits.
+5. After changing the password, click on the **Copy to Clipboard** button from  **Trade Connection**.
+6. Now, let's move to the **Trade Connection** section. Here, you will receive your data in the following format (this is an example with IC Markets for a real account):
+
+   - Host name: (Current IP address 168.205.95.20 can be changed without notice)
+   - Port: 5212 (SSL), 5202 (Plain text)
+   - Password: (a/c 1104928 password)
+   - SenderCompID: live.icmarkets.1104926 or demo.icmarkets.1104926  or live2.icmarkets.1104926 
+   - TargetCompID: cServer
+   - SenderSubID: TRADE
 
-import time
-import logging
-from datetime import datetime
 
-logging.getLogger().setLevel(logging.INFO)
 
 
+
+### Import libraries
+
+```python
+from ejtraderCT import Ctrader
 ```
 
 ### Fix account login and details
 
 ```python
-server="h8.p.c-trader.cn" # Host name
-broker="icmarkets" 
-account="3152339"
-password="393214"
-currency="EUR"
+server="168.205.95.20" # - Host name: (Current IP address 168.205.95.20 can be changed without notice)
+account="live.icmarkets.1104926" #  - SenderCompID: live.icmarkets.1104926
+password="12345678" # - The password you configured
 
-api = Ctrader(server,broker,account,password,currency)
+api = Ctrader(server,account,password)
 
 ```
-
-##### To disconnect and logout from the account
+##### Check the connection status
+```python
+api.isconnected()
+```
+##### Logout 
 ```python
 api.logout()
 ```
 
-### Real-time quote
+#### Real-time quote
 
 ##### Subscribe to symbols
 ```python
@@ -95,22 +115,28 @@ print(quote)
 
 ```python
 # Buy position
+price = api.quote()
+price = price['EURUSD']['bid'] 
 
 symbol = "EURUSD"
 volume = 0.01 # position size:
-stoploss =  1.18
-takeprofit = 1.19
+stoploss =  round(price - 0.00010,6)
+takeprofit = round(price + 0.00010,6)
 
-api.buy(symbol, volume, stoploss, takeprofit)
+id = api.buy(symbol, volume, stoploss, takeprofit)
+print(f"Position: {id}")
 
 # sell position 
+price = api.quote()
+price = price['EURUSD']['bid'] 
 
 symbol = "EURUSD"
 volume = 0.01 # position size
-stoploss = 1.19
-takeprofit = 1.18
+stoploss =  round(price + 0.00010,6)
+takeprofit = round(price - 0.00010,6)
 
-api.sell(symbol, volume, stoploss, takeprofit)
+id = api.sell(symbol, volume, stoploss, takeprofit)
+print(f"Position: {id}")
 ```
 
 ##### Limit Orders
@@ -120,23 +146,21 @@ api.sell(symbol, volume, stoploss, takeprofit)
 # Buy limit order
 
 symbol = "EURUSD"
-volume = 0.01 # position size
-stoploss = 1.17
-takeprofit = 1.19
+volume = 0.01 # order size
 price = 1.18 # entry price 
 
-api.buyLimit(symbol, volume, stoploss, takeprofit, price)
+id = api.buyLimit(symbol, volume, price)
+print(f"Order: {id}")
 
 
 # Sell limit order
 
 symbol = "EURUSD"
-volume = 0.01 # position size
-stoploss = 1.23
-takeprofit = 1.17
+volume = 0.01 # Order size
 price = 1.22 # entry price 
 
-api.sellLimit(symbol, volume, stoploss, takeprofit, price)
+id = api.sellLimit(symbol, volume, price)
+print(f"Order: {id}")
 ```
 
 #### Stop Orders
@@ -146,22 +170,19 @@ api.sellLimit(symbol, volume, stoploss, takeprofit, price)
 # Buy stop order
 
 symbol = "EURUSD"
-volume = 0.01 # position size
-stoploss = 1.20
-takeprofit = 1.24
+volume = 0.01 # order size
 price = 1.22 # entry price
 
-api.buyStop(symbol, volume, stoploss, takeprofit, price)
+id = api.buyStop(symbol, volume, price)
+print(f"Order: {id}")
 
 # Sell stop order
 
 symbol = "EURUSD"
-volume = 0.01 # position size
-stoploss = 1.19
-takeprofit = 1.17
+volume = 0.01 # order size
 price = 1.18 # entry price 
 
-api.sellStop(symbol, volume, stoploss, takeprofit, price)
+api.sellStop(symbol, volume, price)
 
 ```
 
@@ -206,31 +227,28 @@ api.cancel_all()
 ```python
 api.close_all()
 ```
-#### Modify position SL and TP
+#### Parcial Close position 
+
 ```python
-id = "position id "
-stoploss = "stop loss price""
-takeprofit "stop gain price"
+api.positionPartialClose(id, volume) 
+```
 
-api.positionModify(id, stoploss, takeprofit)
+### Disclosure
 
-```
+Due to certain limitations of the FIX API, there's a specific issue that arises when both the Stop Loss (SL) and Take Profit (TP) features are used concurrently. This issue occurs when one of them is triggered, the other remains open and will execute when the price reaches the specified level again, causing it to open another order. This issue needs to be addressed either within the ejtraderCT library or the application itself.
 
-#### Modify order SL and TP and entry price
-```python
-id = "order id "
-stoploss = "stop loss price""
-takeprofit= "stop gain price"
-price = "limit or stop entry price"
+However, you can avoid this problem by using either the SL or TP, but not both simultaneously.
 
-api.orderModify(id, stoploss, takeprofit, price)
+## Contributing
 
-```
-## Contributors:
+We welcome any contribution to `ejtraderCT`. Here are some ways to contribute:
+
+1. Report issues or suggest improvements by opening an [issue](https://github.com/ejtraderLabs/ejtraderCT/issues).
+2. Contribute with code to fix issues or add features via a [Pull Request](https://github.com/ejtraderLabs/ejtraderCT/pulls).
 
-<!-- CONTRIBUTORS:START -->
-<!-- CONTRIBUTORS:END -->
+Before submitting a pull request, please make sure your codes are well formatted and tested.
 
 ## Acknowledgements
 
 I would like to express my gratitude to [@HarukaMa](https://github.com/HarukaMa) for creating the initial project. Their work has been an invaluable starting point for my modifications and improvements.
+