pkscreener is an advanced stock screener to find potential breakout stocks from NSE and tell it's possible breakout values. It also helps to find the stocks which are consolidating and may breakout, or the particular chart patterns that you're looking specifically to make your decisions. pkscreener is totally customizable and it can screen stocks with the settings that you have provided.

You can get daily scan results/alerts at scheduled times by subscribing to the following Telegram channel:

https://t.me/PKScreener (or scan the QR code to join)

For any discussion related to PKScreener, you may like to join the following related Telegram group:

https://t.me/PKScreeners (or scan the QR code to join)

If you would like to receive the scan results, please join the telegram channel and group above. You may receive the following scan results:

1. by 4pm IST, Monday - Friday

2. For all Nifty stocks at/by 9:45-10:15am and by 4pm IST, Monday - Friday

   • 
   • 
   • 
   • 
   • 
   • 
   • 
   • 
   • 
   • 
   • 

Screening options to choose from:

• Artificial Intelligence v2 for Nifty 50 Prediction
• Live Index Scan : 5 EMA for Intraday
• Screen stocks by the stock names (NSE Stock Code)
• Nifty 50
• Nifty Next 50
• Nifty 100
• Nifty 200
• Nifty 500
• Nifty Smallcap 50
• Nifty Smallcap 100
• Nifty Smallcap 250
• Nifty Midcap 50
• Nifty Midcap 100
• Nifty Midcap 150
• Nifty (All Stocks)
• Newly Listed (IPOs in last 2 Year)
• F&O Stocks Only

Followin scanners are already implemented. Others are In Progress

     0 > Full Screening (Shows Technical Parameters without any criterion)
     1 > Probable Breakouts                     2 > Recent Breakouts & Volumes
     3 > Consolidating stocks                   4 > Lowest Volume in last 'N'-days (Early Breakout Detection)
     5 > RSI screening                          6 > Reversal Signals
     7 > Stocks making Chart Patterns           8 > CCI outside of the given range
     9 > Volume gainers                         10 > Closing at least 2% up since last 3 days
    11 > Short term bullish stocks              12 > 15 Minute Price & Volume breakout
    13 > Bullish RSI & MACD Intraday            14 > NR4 Daily Today

• Download and install docker desktop: https://docs.docker.com/get-docker/
• After installation, launch/run docker desktop and if it asks, login using your docker credentials.
• Launch any command line and type docker pull pkjmesra/pkscreener-debian:latest. Then type docker run pkjmesra/pkscreener-debian:latest python3 pkscreener -a Y -o X:12:10 -e ow whatever -o options you'd like executed.
• Pass whatever option you'd like to pass in -o. Look at the menu options above. For, example, 12 is Scanners.. 10 Closing at least 2% up since last 3 days etc. Wait while it runs and produces the output for you.

• Download the suitable file according to your OS.

• Linux & Mac users should make sure that the pkscreener.bin or pkscreener.run is having execute permission.

• Run the file. Following window will appear after a brief delay.

• Configure the parameters as per your requirement using Option > E.

• Scanner Menus the scanner menus for each level/sub-level

• Following are the screenshots of screening and output results.

• Once done, you can also save the results in an excel file.

You can now use the Backtests menu to backtest any of the selected strategies.

• Once done, you can also view the output html file saved at the same location from where you launched the app.

• Running it once with pre-defined inputs You can also run it as a one time job in any scheduler with pre-defined options. For example ./pkscreener.py -a Y -o X:12:10 -e (or pkscreener.exe -a Y -o X:12:10 -e if you're executing with the exe) will run the scanner for all Nifty stocks and find all stocks matching CCI filter, save the results in xlsx file and exit. ./pkscreener.py -a Y -o X:12:9:2.5 -e will run the scanner (menu option X) for all Nifty stocks (menu option 12) to find volume gainers (menu option 9) with at least the volume multiplier of 2.5 (input variable 2.5), save the results in xlsx file and exit (menu option -e). Passing in the -p option for example pkscreener.py -a Y -p -o X:12:6:1 -e will also silence all command line prints/outputs and just run silently for the given options, save results and exit. Try and see all options with ./pkscreener.py -h.

• Running it at regular intervals If you want to runn it at regular intervals, you can just pass the interval in -c command line option. For example, ./pkscreener.py -a Y -o X:12:6:1 -c 180 will run it every 180 seconds with console outputs also being printed. If you'd just like it to run as a cron job without console outputs, you may also pass the -p parameter. For example, ./pkscreener.py -a Y -p -o X:12:6:1 -c 180

The Result table contains a lot of different parameters which can be pretty overwhelming to the new users, so here's the description and significance of each parameter.

Feel free to Edit the parameters in the pkscreener.ini file which will be generated by the application.

[config]
period = 300d
daystolookback = 30
duration = 1d
minprice = 30
maxprice = 10000
volumeratio = 2
consolidationpercentage = 10
shuffle = y
cachestockdata = y
onlystagetwostocks = y
useema = n
logsEnabled = n

Try to tweak this parameters as per your trading styles. For example, If you're comfortable with weekly charts, make duration=5d and so on. For intraday, you can set period=1d and duration=5m if you would like to calculate with 5minute candles. Set the duration to 15m or whatever value you desire, but keep the period to 1d. This tool, however, works best for short/mid term instead of intraday, but some scans like momentum/volume/NR4 etc can be used for screening stocks for intraday as well. You can use the toggle menu option T to toggle between long term and intraday config before you begin the scanners.

You can create your own telegram channel to receive alerts wherenevr you run it locally on your laptop either from a command line interface console or run it as a scheduler. Simply, go ahead and

1. Create a bot for yourself, then a channel and get their IDs. Follow the steps in https://medium.com/codex/using-python-to-send-telegram-messages-in-3-simple-steps-419a8b5e5e2 and https://www.siteguarding.com/en/how-to-get-telegram-bot-api-token
2. After you have created the bot using botFather and have received/verified your bot id/token and channel ID using get id bot, simply go to src folder in the source code directory and create a .env.dev file with the following (If you are instead using the .exe or .bin or .run file from release, just create this file in the same folder where the executable (.exe or .bin or .run) is placed.)

CHAT_ID=Your_Channel_Id_Here_Without_A_Hyphen_or_Minus_Sign
TOKEN=Your_Bot_Token_Here
chat_idADMIN=Your_Own_ID_Here

3. From now on, you will begin to receive your own alerts on your telegram channel.

If you are having issues running the program, you can just launch a command line interface (On windows> Start > Run > cmd) and then launch PKScreener with a command line option of -l. For example, python pkscreener.py -l. This will show you the path where the program will save all the log outputs from this run. Copy that path and go ahead and run the application. After you have finished the run, go to that copied path, zip the contents of the file pkscreener-logs.txt and create an issue at https://github.com/pkjmesra/PKScreener/issues. Please do not forget to attach the log files in the issue.

• Please feel free to Suggest improvements bugs by creating an issue.
• Please follow the Guidelines for Contributing while making a Pull Request.

• DO NOT use the result provided by the software 'solely' to make your trading decisions.
• Always backtest and analyze the stocks manually before you trade.
• The Author and the software will not be held liable for your losses.
• A lot of this work is based on the original work of https://github.com/pranjal-joshi/Screeni-py. A big thank you!