An unofficial API for the trading platform DeGiro written in Python
Project description
DegiroAPI
An unofficial API for the trading platform Degiro written in Python with the ability to get real time data and historical data for products.
Credits
This project is a fork from DegiroAPI by lolokrauz. It was not actively maintained anymore, hence the creation of this repository.
Added changes
Over the original repository the following things were added:
- Pre-commit hooks.
- Style and type checking.
- Dependencies handled by the setup instead of the user.
- Typing information all over the code.
- Removed logic from
__init__
. - Renaming of function, parameters and variables to adhere to pythons snake_case.
Getting Started
Installing
pip install degiroapi
Logging in
frmo degiroapi.degiro import DeGiro
degiro = DeGiro()
degiro.login("username", "password")
Logging out
degiro.logout()
Available Functions
- login
- logout
- get_data
- search_products
- product_info
- transactions
- orders
- delete_order
- real_time_price
- get_stock_list
- buy_order
- sell_order
get_data
Printing your current cash funds:
from degiroapi.data_type import DataType
cashfunds = degiro.get_data(DataType.CASHFUNDS)
for data in cashfunds:
print(data)
Printing your current portfolio, argument True to filter out products with a size of 0, False or no Argument to show all:
from degiroapi.data_type import DataType
portfolio = degiro.get_data(DataType.PORTFOLIO, True)
for data in portfolio:
print(data)
search_products
Searching for a product:
products = degiro.search_products('Pfizer')
print(Product(products[0]).id)
product_info
Printing info for a specified product ID:
info = degiro.product_info(331823)
print(info["id"], info["name"], info["currency"], info["closePrice"])
transactions
Printing your transactions in a given time interval:
from datetime import datetime, timedelta
transactions = degiro.transactions(datetime(2019, 1, 1), datetime.now())
print(pretty_json(transactions))
orders
Printing your order history(the maximum timespan is 90 days) With argument True, this function only returns open orders
from datetime import datetime, timedelta
orders = degiro.orders(datetime.now() - timedelta(days=90), datetime.now())
print(pretty_json(orders))
orders = degiro.orders(datetime.now() - timedelta(days=90), datetime.now(), True)
print(pretty_json(orders))
delete_order
Deleting an open order with the orderId
orders = degiro.orders(datetime.now() - timedelta(days=1), datetime.now(), True)
degiro.delete_order(orders[0]['orderId'])
degiro.delete_order("f278d56f-eaa0-4dc7-b067-45c6b4b3d74f")
real_time_price
Get the real time price and the historical data of a stock:
from degiro.interval_type import IntervalType
products = degiro.search_products('nrz')
# Interval can be set to One_Day, One_Week, One_Month, Three_Months, Six_Months, One_Year, Three_Years, Five_Years, Max
realprice = degiro.real_time_price(Product(products[0]).id, IntervalType.One_Day)
# getting the real time price
print(realprice[0]['data']['lastPrice'])
print(pretty_json(realprice[0]['data']))
# getting historical data
print(realprice[1]['data'])
get_stock_list
Get the symbols of the S&P500 stocks:
sp5symbols = []
products = degiro.get_stock_list(14, 846)
for product in products:
sp5symbols.append(Product(product).symbol)
Get the symbols of the german30 stocks:
daxsymbols = []
products = degiro.get_stock_list(6, 906)
for product in products:
daxsymbols.append(Product(product).symbol)
buy_order
Placing a buy order is dependent on the order Type:
Limit order
You have to set a limit order price to which the order gets executed. arguments: order type, product id, execution time type (either 1 for "valid on a daily basis", or 3 for unlimited, size, limit(the limit price)
from degiroapi.order_type import OrderType
degiro.buy_order(OrderType.LIMIT, Product(products[0]).id, 3, 1, 30)
StopLimit order
Sets a limit order when the stoploss price is reached (not bought for more than the limit at the stop loss price): arguments: order type, product id, execution time type (either 1 for "valid on a daily basis", or 3 for "unlimited"), size, limit(the limit price), stop_loss(stop loss price)
from degiroapi.order_type import OrderType
degiro.buy_order(OrderType.STOPLIMIT, Product(products[0]).id, 3, 1, 38, 38)
Market order
Bought at the market price: arguments: order type, product id, execution time type (either 1 for "valid on a daily basis", or 3 for "unlimited"), size
from degiroapi.order_type import OrderType
degiro.buy_order(OrderType.MARKET, Product(products[0]).id, 3, 1)
StopLoss order
The stop loss price has to be higher than the current price, when current price reaches the stoploss price the order is placed: arguments: order type, product id, execution time type (either 1 for "valid on a daily basis", or 3 for "unlimited"), size
from degiroapi.order_type import OrderType
degiro.buy_order(OrderType.STOPLOSS, Product(products[0]).id, 3, 1, None, 38)
sell_order
Placing a sell order is dependent on the order Type: Equivalent to the buy orders:
from degiroapi.order_type import OrderType
degiro.sell_order(OrderType.LIMIT, Product(products[0]).id, 3, 1, 40)
from degiroapi.order_type import OrderType
degiro.sell_order(OrderType.STOPLIMIT, Product(products[0]).id, 3, 1, 37, 38)
from degiroapi.order_type import OrderType
degiro.sell_order(OrderType.MARKET, Product(products[0]).id, 3, 1)
from degiroapi.order_type import OrderType
degiro.sell_order(OrderType.STOPLOSS, Product(products[0]).id, 3, 1, None, 38)
Usage
For documented examples see examples.py
Contributing
How great this project will turn out to be, totally depends on you.
If you think you have a great addition, please create a PR :).
If you are unfamilar with pull requests
, please take a look here.
Requirements
In order for your commit to be accepted, please install pre-commit. This will run a couple of tools to make sure the formatting of the code is good and there are no obvious mistakes.
Installing pre-commit
pre-commit install
Now everytime you will commit, it will automatically run the pre-commit hooks.
If you are using Pycharm, the errors appear in git(left bottom) -> console
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file python-degiro-0.0.2.tar.gz
.
File metadata
- Download URL: python-degiro-0.0.2.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01beba326f5426a280584eda4f006709d4787ed664877282b0e823971dbf706c |
|
MD5 | dccb6442aa488fc69eda6b36b06e5ddc |
|
BLAKE2b-256 | 31b5d50ba958cd5d7bfe7edf0a1a7f8d86ebeaebb08407fbc70b5d9bc50056c2 |
File details
Details for the file python_degiro-0.0.2-py3-none-any.whl
.
File metadata
- Download URL: python_degiro-0.0.2-py3-none-any.whl
- Upload date:
- Size: 11.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7ac5c2b5b5ef3817c3ccb6d0da2dc75a4ff2628c2150a3994b34a7d7ab4b887 |
|
MD5 | cc7db5798bd7523e53ce389e2ba324ce |
|
BLAKE2b-256 | ca179546d8aaee7f3a5e2a4d374791b2fe426f6fcc89677999f55a2c3703f21a |