Updates website with degiro documentation (#2413)

* add degiro docs to website

* update main

* remove testing files from portfolios

* Delete .html

Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
This commit is contained in:
montezdesousa
2022-08-26 18:11:57 +01:00
committed by GitHub
parent b6a6b7127a
commit 25c24ddb9e
14 changed files with 146 additions and 0 deletions

View File

@@ -0,0 +1,37 @@
# Degiro
This menu aims to contain several commands that are available to a user through his Degiro account.
In order to be able to use these, just ensure you connect to your degiro account by typing `login` first.
## Credentials
In order to login you need to update [config file](/openbb_terminal/config_terminal.py) with the following credentials:
| Parameter | Description |
| :--- | :--- |
| DG_USERNAME | Username used to log into Degiro's website. |
| DG_PASSWORD | Password used to log into Degiro's website. |
This can either be done manually or through the `keys` menu.
## 2FA
In order to use 2FA you need to update [config file](/openbb_terminal/config_terminal.py).
We provide 2 alternatives:
1. Manually typing the `OneTimePassword` each time you login. To do this, after setting your credentials as explained above, go to sub-menu `portfolio/bro/degiro` and type `login -otp OneTimePassword`. `OneTimePassword` is the secret key generated by your authenticator.
2. Automatically generate your `OneTimePassword`. No need to manually input it again.
| Parameter | Description |
| :--- | :--- |
| DG_TOTP_SECRET | This secret key will let OpenBB terminal generate the `OneTimePassword` for you. |
If you provide your `DG_TOTP_SECRET`, you won't have to type your `OneTimePassword`, OpenBB terminal will generate it for you
at each connection.
`DG_TOTP_SECRET` is the text representation of the `QRCODE` that Degiro's provide you when you enable 2FA.
More information on 2FA credentials, in the documentation of the [degiro-connector library](https://github.com/Chavithra/degiro-connector).

View File

@@ -0,0 +1,3 @@
```text
usage: cancel ORDER_ID
```

View File

@@ -0,0 +1,6 @@
```text
usage: companynews NL0000235190
```
You need to provide the `ISIN` number of the company.
You can get this `ISIN` using the `dglookup` command for instance.

View File

@@ -0,0 +1,3 @@
```text
usage: create [-a {buy,sell}] (-prod PRODUCT | -sym SYMBOL) -p PRICE (-s SIZE | -up UP_TO) [-d {gtd,gtc}] [-t {limit,market,stop-limit,stop-loss}] [-h]
```

View File

@@ -0,0 +1,5 @@
```text
usage: hold
```
Displays current holdings to the console.

View File

@@ -0,0 +1,8 @@
```text
usage: lastnews [-l LIMIT] [-h]
optional arguments:
-l LIMIT, --limit LIMIT
Number of news to display.
-h, --help show this help message
```

View File

@@ -0,0 +1,10 @@
```text
usage: login [-otp ONE_TIME_PASSWORD] [-h]
optional arguments:
-otp ONE_TIME_PASSWORD, --one-time-password ONE_TIME_PASSWORD
One-time-password for 2FA.
-h, --help show this help message
For more information and examples, use 'about login' to access the related guide.
```

View File

@@ -0,0 +1,3 @@
```text
usage: logout
```

View File

@@ -0,0 +1,19 @@
```text
usage: lookup TESLA
```
It will display a result like this :
```text
name isin symbol productType currency closePrice closePriceDate
0 Tesla US88160R1014 TSLA STOCK USD 571.690 2021-05-13
1 Tesla Inc US88160R1014 TL0 STOCK EUR 478.000 2021-05-13
2 Tesla Inc US88160R1014 TL0 STOCK EUR 467.650 2021-05-13
3 TurboC O.End Tesla 535,04 DE000VQ1S3R3 None WARRANT EUR 3.740 2021-05-13
4 TurboC O.End Tesla 591,4 DE000VQ5R6T9 None WARRANT EUR 0.001 2021-05-13
5 TurboP O.End Tesla 685,29 DE000VQ7HWU6 None WARRANT EUR 9.870 2021-05-13
6 TurboC O.End Tesla 448,63 DE000VQ1KYG8 None WARRANT EUR 10.890 2021-05-13
7 Call 17.12.21 Tesla 392 DE000VP53547 DE000VP53547 WARRANT EUR 8.960 2021-05-13
8 Call 20.01.23 Tesla 720 DE000VQ68691 None WARRANT EUR 1.160 2021-05-13
9 Leverage Shares 1x Tesla ETP IE00BKT6ZH01 STSL ETF GBX 135.550 2021-05-13
```

View File

@@ -0,0 +1,16 @@
Allows you to export your transactions to a file. The file will be available to load into portfolio menu `load -f` command.
```text
usage: paexport -s START [-e END] [-c CURRENCY] [-h] [--export EXPORT]
optional arguments:
-s START, --start START
Start date.
-e END, --end END End date.
-c CURRENCY, --currency CURRENCY
Used currency.
-h, --help show this help message
--export EXPORT Export raw data into csv, json, xlsx
For more information and examples, use 'about paexport' to access the related guide.
```

View File

@@ -0,0 +1,3 @@
```text
usage: pending
```

View File

@@ -0,0 +1,3 @@
```text
usage: topnews
```

View File

@@ -0,0 +1,3 @@
```text
usage: update ORDER_ID -p PRICE
```

View File

@@ -1245,6 +1245,33 @@ main:
ref: "/terminal/portfolio/bro/coinbase/history"
- name: orders
ref: "/terminal/portfolio/bro/coinbase/orders"
- name: degiro
ref: "/terminal/portfolio/bro/degiro"
sub:
- name: login
ref: "/terminal/portfolio/bro/degiro/login"
- name: logout
ref: "/terminal/portfolio/bro/degiro/logout"
- name: hold
ref: "/terminal/portfolio/bro/degiro/hold"
- name: lookup
ref: "/terminal/portfolio/bro/degiro/lookup"
- name: create
ref: "/terminal/portfolio/bro/degiro/create"
- name: update
ref: "/terminal/portfolio/bro/degiro/update"
- name: cancel
ref: "/terminal/portfolio/bro/degiro/cancel"
- name: pending
ref: "/terminal/portfolio/bro/degiro/pending"
- name: companynews
ref: "/terminal/portfolio/bro/degiro/companynews"
- name: lastnews
ref: "/terminal/portfolio/bro/degiro/lastnews"
- name: topnews
ref: "/terminal/portfolio/bro/degiro/topnews"
- name: paexport
ref: "/terminal/portfolio/bro/degiro/paexport"
- name: robinhood
ref: "/terminal/portfolio/bro/robinhood"
sub: