shortable 0.1.0

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

shortable

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

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

1. Install shortable using pip:

    pip install shortable

2. Create API keys using the Alpaca dashboard. Refer to Alpaca's API v2 and API Documentation for more details.
3. Set environment variables APCA_API_KEY_ID and APCA_API_SECRET_KEY for the Windows user account. shortable can be used with Alpaca paper accounts by setting APCA_API_BASE_URL=https://paper-api.alpaca.markets. Refer to Alpaca Environment Variables.

Usage

1. Define assets to track in shortable.json e.g. {"AMZN": true, "MSFT": true, "TSLA": false}.
2. 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.
3. 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:

• GitHub Sponsors
• PayPal
• Bitcoin: bc1qh46qmztl77d9dl8f6ezswvqdqxcaurrqegca2p
• Ethereum: 0xAB443e578c9eA629088e26A9009e44Ed40f68678

Author

Robert Gomez, Jr.

Source code

https://github.com/rgomezjnr/shortable

License

MIT