https://github.com/houseofai/tvscreener

TradingView Screener API
https://github.com/houseofai/tvscreener

quantitative-finance technical-analysis tradingview

Last synced: 5 months ago
JSON representation

TradingView Screener API

• Host: GitHub
• URL: https://github.com/houseofai/tvscreener
• Owner: houseofai
• License: apache-2.0
• Created: 2023-08-02T07:48:18.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-29T12:45:53.000Z (almost 2 years ago)
• Last Synced: 2025-05-12T22:18:24.937Z (5 months ago)
• Topics: quantitative-finance, technical-analysis, tradingview
• Language: Jupyter Notebook
• Homepage:
• Size: 946 KB
• Stars: 68
• Watchers: 5
• Forks: 8
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  




-----------------

# TradingView Screener API: simple Python library to retrieve data from TradingView Screener

[![PyPI version](https://badge.fury.io/py/tvscreener.svg)](https://badge.fury.io/py/tvscreener)

[![Downloads](https://pepy.tech/badge/tvscreener)](https://pepy.tech/project/tvscreener)

[![Coverage](https://codecov.io/github/houseofai/tvscreener/coverage.svg?branch=main)](https://codecov.io/gh/houseofai/tvscreener)

![tradingview-screener.png](https://raw.githubusercontent.com/houseofai/tvscreener/main/.github/img/tradingview-screener.png)

Get the results as a Pandas Dataframe

![dataframe.png](https://github.com/houseofai/tvscreener/blob/main/.github/img/dataframe.png?raw=true)

# Main Features

- Query **Stock**, **Forex** and **Crypto** Screener

- All the **fields available**: ~300 fields - even hidden ones)

- **Any time interval** (`no need to be a registered user` - 1D, 5m, 1h, etc.)

- Filters by any fields, symbols, markets, countries, etc.

- Get the results as a Pandas Dataframe

## Installation

The source code is currently hosted on GitHub at:

https://github.com/houseofai/tvscreener

Binary installers for the latest released version are available at the [Python

Package Index (PyPI)](https://pypi.org/project/tvscreener)

```sh

# or PyPI

pip install tvscreener

```

From pip + GitHub:

```sh

$ pip install git+https://github.com/houseofai/tradingview-screener@main

```

## Usage

For Stocks screener:

```python

import tvscreener as tvs

ss = tvs.StockScreener()

df = ss.get()

# ... returns a dataframe with 150 rows by default

``` 

For Forex screener:

```python

import tvscreener as tvs

fs = tvs.ForexScreener()

df = fs.get()

```

For Crypto screener:

```python

import tvscreener as tvs

cs = tvs.CryptoScreener()

df = cs.get()

```

## Parameters

For Options and Filters, please check the [notebooks](https://github.com/houseofai/tvscreener/tree/main/notebooks) for

examples.