diff --git a/README.md b/README.md index 4090363..ffc0768 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,32 @@ Python library for automatic fetching of personal asset depo information. -Supports: +## Supported services -- **Kraken**: Uses their [publicly documented API](https://docs.kraken.com/rest/). -- **Kucoin**: Uses their [publicly documented API](https://www.kucoin.com/docs/beginners/introduction). -- **Partisia Blockchain Account**: Uses a reader node to check the account - state. -- **Nordnet**: Through 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 a lot. +[**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. -## TODO +[**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 +utilities](https://github.com/helmstedt/nordnet-utilities), which helped with +implementing this functionality. Exposes the same data as the home page. + +## Future extension - [ ] Investment Bank: Saxo Bank OpenAPI - [ ] Personal Bank: Personal Bank Account (Open Banking) Maybe use AIIA? diff --git a/setup.py b/setup.py index f85c092..e218898 100644 --- a/setup.py +++ b/setup.py @@ -15,19 +15,32 @@ PACKAGE_DESCRIPTION = """ Python library for automatic fetching of personal asset depo information. -Supports: +## Supported services -- **Kraken**: Uses their [publicly documented API](https://docs.kraken.com/rest/). -- **Kucoin**: Uses their [publicly documented API](https://www.kucoin.com/docs/beginners/introduction). -- **Partisia Blockchain Account**: Uses a reader node to check the account - state. -- **Nordnet**: Through 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 a lot. +[**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. -## TODO +[**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 +utilities](https://github.com/helmstedt/nordnet-utilities), which helped with +implementing this functionality. Exposes the same data as the home page. + +## Future extension - [ ] Investment Bank: Saxo Bank OpenAPI - [ ] Personal Bank: Personal Bank Account (Open Banking) Maybe use AIIA?