## another unofficial api for [finviz.com](https://finviz.com)
[](https://www.python.org/downloads/)
[](https://pypi.org/project/finavis/)
[](https://pypi.org/project/finavis/)
[](https://pypi.org/project/finavis/)
[](https://github.com/rdnve/finavis/blob/master/LICENSE)
### installation
```bash
# via pypi (recommended)
$ python -m pip install -U finavis
# or using github w/ pip
$ python -m pip install git+https://github.com/rdnve/finavis.git
# or using github w/ poetry
$ poetry add git+https://github.com/rdnve/finavis.git
```
### getting a single quote
```python
import typing as ty
from finavis import get_quote
from finavis.library import Quote
quote: Quote = get_quote(ticker="AAPL")
# accessing to attributes: type help(quote) for more
print(f"Ticker: {quote.ticker}, price: {quote.price}, w/ EPS {quote.eps_ttm}")
# extract attributes to dictionary
data: ty.Dict[str, str] = quote.to_dict()
```
### getting a several quotes
```python
import typing as ty
from finavis import get_quotes
tickers: ty.Tuple[str, ...] = ("AAPL", "INTC", "QCOM")
for quote in get_quotes(tickers=tickers):
print(f"Ticker: {quote.ticker}, price: {quote.price}, w/ EPS {quote.eps_ttm}")
```
### getting a screener w/ objects
```python
from finavis import Screener
from finavis.library import Exchange, Index, Order
screener: Screener = Screener(
exchange=Exchange.NASDAQ,
index=Index.SP500,
order_by=Order.CHANGE_ASC,
)
for index, overview in enumerate(screener()):
print(f"Ticker: {overview.ticker}, price: {overview.price} - change: {overview.change}")
```
### disclaimer
using this library to acquire data from some website is against their "terms of service" and *robots.txt*; use it responsibly and at your own risk, this library was built purely for educational purposes.
### important information
any quote data displayed on the [finviz.com](https://finviz.com) website is delayed by 15 minutes for nasdaq/nyse/amex; this api should **NOT be used** for real-time trading, it's primary purpose for research in educational purposes.
Raw data
{
"_id": null,
"home_page": "https://github.com/rdnve/finavis",
"name": "finavis",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.12,<4.0",
"maintainer_email": "",
"keywords": "finance,datascience,scrapper,markets,stock,quote,ticker,finviz",
"author": "serje \u00f9",
"author_email": "pleaseanswermeserjeu@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/5c/e9/af0c69011dd91d18c7d4b0cee8d2334ae4a7c9fd7009812a9d9e4fd0eea0/finavis-0.0.36.tar.gz",
"platform": null,
"description": "## another unofficial api for [finviz.com](https://finviz.com)\n\n[](https://www.python.org/downloads/)\n[](https://pypi.org/project/finavis/)\n[](https://pypi.org/project/finavis/)\n[](https://pypi.org/project/finavis/)\n[](https://github.com/rdnve/finavis/blob/master/LICENSE)\n\n\n### installation\n\n```bash\n# via pypi (recommended)\n$ python -m pip install -U finavis\n\n# or using github w/ pip\n$ python -m pip install git+https://github.com/rdnve/finavis.git\n\n# or using github w/ poetry\n$ poetry add git+https://github.com/rdnve/finavis.git\n```\n\n### getting a single quote\n```python\nimport typing as ty\n\nfrom finavis import get_quote\nfrom finavis.library import Quote\n\nquote: Quote = get_quote(ticker=\"AAPL\")\n\n# accessing to attributes: type help(quote) for more\nprint(f\"Ticker: {quote.ticker}, price: {quote.price}, w/ EPS {quote.eps_ttm}\")\n\n# extract attributes to dictionary\ndata: ty.Dict[str, str] = quote.to_dict()\n```\n\n### getting a several quotes\n```python\nimport typing as ty\n\nfrom finavis import get_quotes\n\ntickers: ty.Tuple[str, ...] = (\"AAPL\", \"INTC\", \"QCOM\")\nfor quote in get_quotes(tickers=tickers):\n print(f\"Ticker: {quote.ticker}, price: {quote.price}, w/ EPS {quote.eps_ttm}\")\n```\n\n### getting a screener w/ objects\n```python\nfrom finavis import Screener\nfrom finavis.library import Exchange, Index, Order\n\nscreener: Screener = Screener(\n exchange=Exchange.NASDAQ,\n index=Index.SP500,\n order_by=Order.CHANGE_ASC,\n)\n\nfor index, overview in enumerate(screener()):\n print(f\"Ticker: {overview.ticker}, price: {overview.price} - change: {overview.change}\")\n```\n\n### disclaimer\nusing this library to acquire data from some website is against their \"terms of service\" and *robots.txt*; use it responsibly and at your own risk, this library was built purely for educational purposes.\n\n### important information\nany quote data displayed on the [finviz.com](https://finviz.com) website is delayed by 15 minutes for nasdaq/nyse/amex; this api should **NOT be used** for real-time trading, it's primary purpose for research in educational purposes.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "another unofficial api for some financial visualization website",
"version": "0.0.36",
"project_urls": {
"Homepage": "https://github.com/rdnve/finavis",
"Repository": "https://github.com/rdnve/finavis"
},
"split_keywords": [
"finance",
"datascience",
"scrapper",
"markets",
"stock",
"quote",
"ticker",
"finviz"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "879e59b8633c99754786b6708add2d48abbeb63585d6c3bf4d04b7fad373a37e",
"md5": "933cae991a162748d85282e8be593397",
"sha256": "d28e06b1552ff775938d5668b21037794ca0b415a0395eead9799db04629d860"
},
"downloads": -1,
"filename": "finavis-0.0.36-py3-none-any.whl",
"has_sig": false,
"md5_digest": "933cae991a162748d85282e8be593397",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12,<4.0",
"size": 13785,
"upload_time": "2024-01-05T22:16:02",
"upload_time_iso_8601": "2024-01-05T22:16:02.630926Z",
"url": "https://files.pythonhosted.org/packages/87/9e/59b8633c99754786b6708add2d48abbeb63585d6c3bf4d04b7fad373a37e/finavis-0.0.36-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ce9af0c69011dd91d18c7d4b0cee8d2334ae4a7c9fd7009812a9d9e4fd0eea0",
"md5": "9ce2ca8c3e64c025be6c6bda9980594e",
"sha256": "7786761ed8cf27182a3b25f28012bb5fd1dbe19f31f651e263315b092013f6be"
},
"downloads": -1,
"filename": "finavis-0.0.36.tar.gz",
"has_sig": false,
"md5_digest": "9ce2ca8c3e64c025be6c6bda9980594e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12,<4.0",
"size": 12025,
"upload_time": "2024-01-05T22:16:03",
"upload_time_iso_8601": "2024-01-05T22:16:03.893184Z",
"url": "https://files.pythonhosted.org/packages/5c/e9/af0c69011dd91d18c7d4b0cee8d2334ae4a7c9fd7009812a9d9e4fd0eea0/finavis-0.0.36.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-05 22:16:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rdnve",
"github_project": "finavis",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "finavis"
}
JSON
