You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

shortable

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

shortable

Receive an alert if an asset becomes shortable, e.g. from HTB to ETB, or vice versa

0.1.0
pipPyPI
Maintainers
1

shortable

Receive an alert if an asset becomes shortable, e.g. from HTB to ETB, or vice versa

shortable notification

shortable action center

Summary

shortable is a Python script for tracking the short selling availability of assets. The script works by maintaining a database of assets and their shorting availability (either true, shortable, easy-to-borrow (ETB) or false, non-shortable, hard-to-borrow (HTB)). When the script notices the asset shortable condition has changed since the last run, it notifies the user with a Windows 10 toast notification. This may be helpful in quickly acting on ETB or HTB changes of assets or gauging market sentiment. The script currently only supports the Alpaca Securities broker but could be expanded to other brokers that have API access.

Requirements

  • Python 3
  • winotify
  • alpaca-trade-api

Setup

  • Install shortable using pip:
    pip install shortable

Usage

  • Define assets to track in shortable.json e.g. {"AMZN": true, "MSFT": true, "TSLA": false}.
  • Run shortable from the same directory as shortable.json. When there are no asset shortable changes there is no output or notification. Check shortable.log to verify operation.
  • Optionally schedule shortable to run routinely using Windows Task Scheduler.

Files

shortable.json

Dictionary database for recording asset shortable status. Save in the directory you intend to run shortable from. Use JSON format such as follows:

{"AMZN": true, "MSFT": true, "TSLA": false}

shortable.log

Log file indicating checks for shortable status, changes to shortable status, and when toast notifications are fired. Automatically created in the same directory from which shortable is run from.

Support

If you find an issue or have any feedback please submit an issue on GitHub.

If you would like to show your support donations are greatly appeciated via:

Author

Robert Gomez, Jr.

Source code

https://github.com/rgomezjnr/shortable

License

MIT

Keywords

assets stocks short sell stock market trade broker alpaca windows toast notification alert database json api cli tool script python

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts