Metadata-Version: 2.1
Name: XTBApi
Version: 1.0a6
Summary: Api for XBT trading platform
Home-page: https://github.com/federico123579/XTBApi.git
Author: Federico Lolli
Author-email: federico123579@gmail.com
License: MIT
Description: 
        # XTBApi
        
        > Api for XTB trading platform.
        
        A python based API for XTB trading using _websocket_client_.
        
        # Installing / Getting started
        
        To install the API, just clone the repository.
        
        ```bash
        git clone git@github.com:federico123579/XTBApi.git
        cd XTBApi/
        python3 -m venv env
        . env/bin/activate
        pip install .
        ```
        
        Then you can use XTBApi like this simple tutorial.
        ```python
        from XTBApi.api import Client
        # FIRST INIT THE CLIENT
        client = Client()
        # THEN LOGIN
        client.login("{user_id}", "{password}", mode={demo,real})
        # CHECK IF MARKET IS OPEN FOR EURUSD
        client.check_if_market_open([EURUSD])
        # BUY ONE VOLUME (FOR EURUSD THAT CORRESPONDS TO 100000 units)
        client.open_trade('buy', EURUSD, 1)
        # SEE IF ACTUAL GAIN IS ABOVE 100 THEN CLOSE THE TRADE
        trades = client.update_trades() # GET CURRENT TRADES
        trade_ids = [trade_id for trade_id in trades.keys()]
        for trade in trade_ids:
            actual_profit = client.get_trade_profit(trade) # CHECK PROFIT
            if actual_profit >= 100:
                client.close_trade(trade) # CLOSE TRADE
        # CLOSE ALL OPEN TRADES
        client.close_all_trades()
        # THEN LOGOUT
        client.logout()
        ```
        
        # Api Reference
        REQUIRED - **SOON**
        
        _Documentation still in progess_
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
Provides-Extra: test
