Package: vistafetch
VistaFetchVistaFetch is a simple and lightweight Python library for financial asset data retrieval (stocks, ETFs, etc.) from onvista.de.[!WARNING]The API used by this package is not public. Therefore, users should assume that using this package may violate the site's terms of use.
The author of this package takes no responsibility for how individuals use the code. It is important to use the code respectfully and judiciously, keeping in mind the potential consequences of violating the terms of service and applicable laws.
Users are encouraged to read the API Terms and Conditions, Acceptable Use Policy, and License Agreements before using any API. These agreements outline the legal, business, and technical considerations that apply to the use of an API.⚡️ QuickstartPlease ensure thatvistafetchis installed on your machine by running the following command:pipinstallvistafetchThe first step is to initiate the client (VistaFetchClient):fromvistafetchimportVistaFetchClientclient=VistaFetchClient()🔎 Exploratory searchThe client now enables you to search for assets and allows you to investigate the results:result=client.search_asset(search_term="S&P",)result.visualize()This produces the following console output:Financialassetsdiscovered┏━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓
┃Index┃Name┃AssetType┃ISIN┃
┡━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━┩
│0│S&P500│INDEX│US78378X1072│
│1│SiemensEnergy│STOCK│DE000ENER6Y0│
│2│Silberpreis│PRECIOUS_METAL│XC0009653103│
│3│SAP│STOCK│DE0007164600│
│4│EUROSTOXX50│INDEX│EU0009658145│
└───────┴────────────────┴────────────────┴──────────────┘One now can access the asset of choice:asset=result.get(3)# returns SAP in this case# in case one simply wants the first one, the following shorthand takes you thereasset=result.get()One can now access several parameters of the asset or convert them to a JSON string as show below.print(asset.isin)print(asset.as_json())DE0007164600{"display_type":"Aktie","entity_type":"STOCK","isin":"DE0007164600","name":"SAP","tiny_name":"SAP","wkn":"716460",}As a final step, the asset provides some recent price-related data:print(asset.get_latest_price_data().as_json()){"currency_symbol":"EUR","datetime_high":"2023-08-25T14:17:15Z","datetime_last":"2023-08-25T15:37:14Z","datetime_low":"2023-08-25T15:02:12Z","datetime_open":"2023-08-25T07:00:26.999000Z","high":127.24,"last":126.16,"low":125.66,"open":126.2,}In addition, you directly access the individual values, e.g., price valuelast:asset.get_latest_price_data().last126.16[!WARNING]Price data are currently not supported for indexes.
Feel free to send me a feature request if you'd like to see this feature
supported for other asset types as well:https://github.com/bossenti/vistafetch/issues/new.
As an alternative, contributions are welcome at any time.🎯 Targeted searchIn case you already know the identifier for your asset (both ISIN and WKN are supported),
you can directly query them. This returns then only one result:result=client.search_asset(search_term="DE0007164600",# alternatively pass the WKN here)sap_stock=result.get()🐛 Facing problemsFeel free to open anissueif you experience strange behavior or bugs when usingvistafetch.If you are not sure if your problem should be considered a bug or if you have a question in general, reach out viadiscussions.💻 ContributingWe welcome and appreciate contributions of any size.
or smaller or straightforward changes, feel free to create a pull request directly.
If you plan to make significant improvements or extensions, please open anissueordisussionbeforehand.Initial SetupFor your convenience, please ensure that you have Poetry and Just installed. You can read more on them by following the links below:poetryjustTo get all required dependencies installed, simply start with:justpoetry-installAdditionally, we make use ofpre-commit. To set it up, run the following command:pre-commitinstallTo verify that everything is set up correctly, execute the test suite:justunit-testsCode ConformanceOnce you implemented your changes, please run the following commands:justpretty# formats the code and applies automatic linting fixesjustcheck# checks code for conformanceOpening PRPlease be aware that this repository followsconventional commit.
So please choose a PR title corresponding to the following:<scope>(#<IssueID>): <description>  # supported scopes can be found here: https://github.com/commitizen/conventional-commit-types/blob/master/index.json# e.g.docs(#8): provide extensive project readme# issue id is optional, so the following si valid as welldocs:provideextensiveprojectreadme