0.1.0

Author: harrytwigg

README.md

@@ -4,7 +4,7 @@
 
 # Viaduct | A Trading212 Python REST API
 
-Viaduct is a Python REST API wrapper that utilises Trading212's REST API that normally communciates exclusively with first party apps. This has not been offically released publicly but can be reverse engineered.
+Viaduct is a Python REST API wrapper that utilises Trading212's REST API that normally communciates exclusively with first party apps. This has not been offically released publicly but can be reverse-engineered.
 
 Selenium is used to scrape required cookies and customer data from the web app but is no longer required after this point. REST network calls are used enabling greater functionallity and speed than pure web scraping.
 
@@ -15,17 +15,17 @@ The use of a wrapper ensures any API changes in the future will not impact pre-e
 - Firefox if not in default location, an error will be returned upon runtime.
 - The Selenium Gecko driver will automatically install if not in system path, no manual installation is requried!
 
-Pip install coming soon!
+## Installation
 
-## Import and Usage
-
-If Firefox is not installed in default folder, make sure you pass it upon initialisation for example:
+Pip install out now!
 
-```python
-instance = viaduct.ISA(email, password, Reality.Real, browserPath=r"C:\Program Files\Mozilla Firefox\firefox.exe")
+```console
+pip install viaduct
 ```
 
-Currently only ISA  and public modes are supported, more are coming soon. Responses are returned python dictionaries, see the root tree images for more information. Selenium web scrapping modes extend the public class so it does not need to be recreated.
+## Import and Usage
+
+Viaduct is an API wrapper. API responses are returned python dictionaries, see the root tree images for more information. Selenium web scrapping modes extend the public class so it does not need to be recreated.
 
 Examples are the payloads that the Rest API returns, these are returned as Python dictionaries for your convenience
 
@@ -37,13 +37,13 @@ See below for currently implemented API class methods, these are explained furth
 
 | Method | Public | ISA | Equity | CFD |
 | --- | --- | --- | --- | --- |
-| 1 - getInstrument() | X | X |  |  |
-| 2 - getAllInstruments() | X | X |  |  |
-| 3 - getFundamentals() | X | X |  |  |
-| 4 - getMinMax() |  | X |  |  |
-| 5 - getSettings() |  | X |  |  |
-| 6 - getChartData() | X | X |  |  |
-| 7 - getPortfolioPerformance() |  | X |  |  |
+| 1 - getInstrument() | X | X | X | X |
+| 2 - getAllInstruments() | X | X | X | X |
+| 3 - getFundamentals() | X | X | X | X |
+| 4 - getMinMax() |  | X | X |  |
+| 5 - getSettings() |  | X | X |  |
+| 6 - getChartData() | X | X | X | X |
+| 7 - getPortfolioPerformance() |  | X | X |  |
 
 ## Public Mode
 
@@ -61,19 +61,33 @@ instance = Public(loadSymbols=False)
 
 Selenium powered wrapper for management of an ISA account, real mode only
 
-Browser path may need to be manually specified
+If Firefox is not installed in default folder, make sure you pass the installed path upon initialisation:
 
 ```python
-instance = ISA("email", "password", Reality.Real, browserPath=r"C:\Program Files\Mozilla Firefox\firefox.exe")
+instance = ISA("email", "password", browserPath=r"C:\Program Files\Mozilla Firefox\firefox.exe")
 ```
 
 ## Equity Mode
 
-Coming soon!
+Selenium powered wrapper for management of an Equity account, real or demo modes are supported
+
+If Firefox is not installed in default folder, make sure you pass the installed path upon initialisation:
+
+```python
+instance = Equity("email", "password", reality=Reality.Real, browserPath=r"C:\Program Files\Mozilla Firefox\firefox.exe")
+```
 
 ## CFD Mode
 
-Coming soon!
+Selenium powered wrapper for management of CFD account, real or demo modes are supported
+
+Custom methods for CFD are not yet supported and only return Public API calls
+
+If Firefox is not installed in default folder, make sure you pass the installed path upon initialisation:
+
+```python
+instance = CFD("email", "password", reality=Reality.Real, browserPath=r"C:\Program Files\Mozilla Firefox\firefox.exe")
+```
 
 ## API Class Methods
 

dist/viaduct-0.0.12.tar.gz

@@ -3,7 +3,7 @@
 setup(
     name='viaduct',         # How you named your package folder (MyLib)
     packages=['viaduct'],   # Chose the same as "name"
-    version='0.0.12',      # Start with a small number and increase it with every change you make
+    version='0.1.0',      # Start with a small number and increase it with every change you make
     # Chose a license from here: https://help.github.com/articles/licensing-a-repository
     license='gpl-3.0',
     # Give a short description about your library
@@ -14,7 +14,7 @@
     # Provide either the link to your github or to your website
     url='https://github.com/harrytwigg/Viaduct-Trading212-Python-API',
     # I explain this later on
-    download_url='https://github.com/harrytwigg/Viaduct-Trading212-Python-API/archive/0.0.12.tar.gz',
+    download_url='https://github.com/harrytwigg/Viaduct-Trading212-Python-API/archive/0.1.0.tar.gz',
     keywords=['python', 'api', 'rest', 'api-wrapper', 'viaduct', 'trading212',
               'trading212-api'],   # Keywords that define your package best
     install_requires=[            # I get to this in a second

setup.py

@@ -0,0 +1,6 @@
+from viaduct.isa import *
+from viaduct.equity import *
+from viaduct.cfd import *
+
+from viaduct.public import *
+from viaduct.utils import *

tests.py

@@ -0,0 +1,18 @@
+from viaduct.core import *
+from viaduct.utils import *
+
+
+class CFD(CoreModule):
+    def __init__(self, email, password, reality, browserPath, headless=False, timeout=2):
+        super().__init__(email, password, TradingType.CFD,
+                         reality, headless, browserPath, timeout)
+        self.reality = reality
+
+    # Format url on whether is live
+    def urlf(self, url):
+        if (self.reality == Reality.Real):
+            return ("https://live.trading212.com" + url)
+        elif (self.reality == Reality.Practice):
+            return ("https://demo.trading212.com" + url)
+        else:
+            raise Exception("Invalid reality " + self.reality)

viaduct/__init__.py

@@ -0,0 +1,33 @@
+from viaduct.core import *
+from viaduct.utils import *
+
+
+class Equity(CoreModule):
+    def __init__(self, email, password, reality, browserPath, headless=False, timeout=2):
+        super().__init__(email, password, TradingType.Equity,
+                         reality, headless, browserPath, timeout)
+        self.reality = reality
+
+    # Format url on whether is live
+    def urlf(self, url):
+        if (self.reality == Reality.Real):
+            return ("https://live.trading212.com" + url)
+        elif (self.reality == Reality.Practice):
+            return ("https://demo.trading212.com" + url)
+        else:
+            raise Exception("Invalid reality " + self.reality)
+
+    # Gets min and max buy and sell value in £, max sell quantity is number of shares
+    # Not sure what sellThreshold is
+    # The sell parameters only appear for UK stocks for some reason
+    def getMinMax(self, code):
+        return super().get(self.urlf("/rest/v1/equity/value-order/min-max?instrumentCode=" + code), cookies=self.cookiePayload)
+
+    # Takes instrument code, returns maxBuy and maxSell in shares for the account and max buy and sell that is technically
+    # possible on the exchange, also has minTrade and if suspended
+    def getSettings(self, code):
+        return super().post(self.urlf("/rest/v2/account/instruments/settings"), cookies=self.cookiePayload, payload=[code])
+
+    # Gets the account performance graph data
+    def getPortfolioPerformance(self, historyPeriod):
+        return super().get(self.urlf("/rest/v2/portfolio?period=" + historyPeriod), cookies=self.cookiePayload)

viaduct/cfd.py

@@ -129,7 +129,7 @@ def getChartData(self, code, chartPeriod, size, includeFake=False):
             "candles": [
                 {
                     "ticker": code,
-                    "period": "ONE_DAY",
+                    "period": chartPeriod,
                     "size": size,
                     "includeFake": includeFake
                 }