From e2f0374db1699eba121c9422310e2e8963f19879 Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Sat, 20 Jul 2024 22:11:59 +0200 Subject: [PATCH] Improved documentation v2 --- fin_depo/__init__.py | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/fin_depo/__init__.py b/fin_depo/__init__.py index 856dc59..d22a4b1 100644 --- a/fin_depo/__init__.py +++ b/fin_depo/__init__.py @@ -2,28 +2,26 @@ Python library for automatic fetching of personal asset depo information. -## Supported services +## Supported websites/services -[**Kraken**](https://www.kraken.com/) crypto-currency exchange -(`KrakenDepoFetcher`): Uses their [publicly documented -API](https://docs.kraken.com/rest/). This provides the same data as the -homepage. - -[**Kucoin**](https://www.kucoin.com/) crypto-currency exchange -(`KucoinDepoFetcher`): Uses their [publicly documented +- [**Kraken**](https://www.kraken.com/) crypto-currency exchange +(`KrakenDepoFetcher`): +Uses their [publicly documented API](https://docs.kraken.com/rest/). This +provides the same data as the homepage. +- [**Kucoin**](https://www.kucoin.com/) crypto-currency exchange +(`KucoinDepoFetcher`): +Uses their [publicly documented API](https://www.kucoin.com/docs/beginners/introduction). This provides the same data as is available on the Assets Overview Page. This fetcher also allows for placing market orders, but be careful with this functionality. - -[**Partisia Blockchain**](https://browser.partisiablockchain.com/) wallet -balances (`PartisiaBlockchainAccountDepoFetcher`): Uses a public reader node to -check the account state. This is the same data as can be found in the Partisia -Browser Assets page. - -[**Nordnet**](https://www.nordnet.dk) nordic investment bank -(`NordnetDepoFetcher`): Uses their -[API](https://www.nordnet.dk/externalapi/docs/api). Thanks to [Morten -Helmstedt](https://helmstedt.dk/) for sharing his [Nordnet +- [**Partisia Blockchain**](https://browser.partisiablockchain.com/) wallet +balances (`PartisiaBlockchainAccountDepoFetcher`): +Uses a public reader node to check the account state. This is the same data as +can be found in the Partisia Browser Assets page. +- [**Nordnet**](https://www.nordnet.dk) nordic investment bank +(`NordnetDepoFetcher`): +Uses their [API](https://www.nordnet.dk/externalapi/docs/api). Thanks to +[Morten Helmstedt](https://helmstedt.dk/) for sharing his [Nordnet utilities](https://github.com/helmstedt/nordnet-utilities), which helped with implementing this functionality. Exposes the same data as the home page.