{"id":49247424,"url":"https://github.com/rgomezjnr/shortable","last_synced_at":"2026-04-24T22:41:18.057Z","repository":{"id":57466876,"uuid":"405916585","full_name":"rgomezjnr/shortable","owner":"rgomezjnr","description":"Receive an alert if an asset becomes shortable, e.g. from HTB to ETB, or vice versa","archived":false,"fork":false,"pushed_at":"2021-09-22T20:34:20.000Z","size":81,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-18T21:32:00.119Z","etag":null,"topics":["alert","alpaca","api","assets","broker","cli","database","json","market","notification","python","script","sell","short","stock","stocks","toast","tool","trade","windows"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/shortable/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rgomezjnr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-13T09:49:13.000Z","updated_at":"2024-05-10T19:04:55.000Z","dependencies_parsed_at":"2022-09-10T02:01:00.291Z","dependency_job_id":null,"html_url":"https://github.com/rgomezjnr/shortable","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/rgomezjnr/shortable","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rgomezjnr%2Fshortable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rgomezjnr%2Fshortable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rgomezjnr%2Fshortable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rgomezjnr%2Fshortable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rgomezjnr","download_url":"https://codeload.github.com/rgomezjnr/shortable/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rgomezjnr%2Fshortable/sbom","scorecard":{"id":773786,"data":{"date":"2025-08-11","repo":{"name":"github.com/rgomezjnr/shortable","commit":"4ace06b484bd24a356300a9d15a02a902c853c63"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/9 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T02:58:44.476Z","repository_id":57466876,"created_at":"2025-08-23T02:58:44.476Z","updated_at":"2025-08-23T02:58:44.476Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32243800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T13:21:15.438Z","status":"ssl_error","status_checked_at":"2026-04-24T13:21:15.005Z","response_time":64,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alert","alpaca","api","assets","broker","cli","database","json","market","notification","python","script","sell","short","stock","stocks","toast","tool","trade","windows"],"created_at":"2026-04-24T22:41:17.427Z","updated_at":"2026-04-24T22:41:18.051Z","avatar_url":"https://github.com/rgomezjnr.png","language":"Python","funding_links":["https://github.com/sponsors/rgomezjnr","https://paypal.me/rgomezjnr"],"categories":[],"sub_categories":[],"readme":"# shortable\nReceive an alert if an asset becomes shortable, e.g. from HTB to ETB, or vice versa\n\n![shortable notification](images/shortable-notification.png)\n\n![shortable action center](images/shortable-action-center.png)\n\n## Summary\nshortable is a Python script for tracking the short selling availability of assets. The script works by maintaining a\ndatabase of assets and their shorting availability (either true, shortable, easy-to-borrow (ETB) or false, non-shortable,\nhard-to-borrow (HTB)). When the script notices the asset shortable condition has changed since the last run, it notifies\nthe user with a Windows 10 toast notification. This may be helpful in quickly acting on ETB or HTB changes of assets or\ngauging market sentiment. The script currently only supports the Alpaca Securities broker but could be expanded to other\nbrokers that have API access.\n\n## Requirements\n- [Python 3](https://www.python.org/downloads/)\n- [winotify](https://github.com/versa-syahptr/winotify)\n- [alpaca-trade-api](https://github.com/alpacahq/alpaca-trade-api-python)\n\n## Setup\n1. Install shortable using pip:\n```\n    pip install shortable\n```\n2. Create API keys using the [Alpaca dashboard](https://app.alpaca.markets/login). Refer to Alpaca's [API v2](https://alpaca.markets/docs/api-documentation/api-v2/) and [API Documentation](https://alpaca.markets/docs/api-documentation/) for more details.\n3. Set environment variables APCA_API_KEY_ID and APCA_API_SECRET_KEY for the Windows user account.\nshortable can be used with Alpaca paper accounts by setting APCA_API_BASE_URL=https://paper-api.alpaca.markets. Refer to\n[Alpaca Environment Variables](https://github.com/alpacahq/alpaca-trade-api-python#alpaca-environment-variables).\n\n## Usage\n1. Define assets to track in [shortable.json](#shortablejson) e.g. {\"AMZN\": true, \"MSFT\": true, \"TSLA\": false}.\n2. Run shortable from the same directory as [shortable.json](#shortablejson). When there are no asset shortable changes there is no output or notification. Check [shortable.log](#shortablelog) to verify operation.\n3. Optionally schedule shortable to run routinely using Windows Task Scheduler.\n\n## Files\n### shortable.json\nDictionary database for recording asset shortable status. Save in the directory you intend to run shortable from.\nUse JSON format such as follows:\n```\n{\"AMZN\": true, \"MSFT\": true, \"TSLA\": false}\n```\n\n### shortable.log\nLog file indicating checks for shortable status, changes to shortable status, and when toast notifications are fired.\nAutomatically created in the same directory from which shortable is run from.\n\n## Support\nIf you find an issue or have any feedback please submit an issue on [GitHub](https://github.com/rgomezjnr/shortable/issues).\n\nIf you would like to show your support donations are greatly appeciated via:\n- [GitHub Sponsors](https://github.com/sponsors/rgomezjnr)\n- [PayPal](https://paypal.me/rgomezjnr)\n- [Bitcoin:](bitcoin:bc1qh46qmztl77d9dl8f6ezswvqdqxcaurrqegca2p) bc1qh46qmztl77d9dl8f6ezswvqdqxcaurrqegca2p\n- [Ethereum:](ethereum:0xAB443e578c9eA629088e26A9009e44Ed40f68678) 0xAB443e578c9eA629088e26A9009e44Ed40f68678\n\n## Author\n[Robert Gomez, Jr.](https://github.com/rgomezjnr)\n\n## Source code\nhttps://github.com/rgomezjnr/shortable\n\n## License\n[MIT](https://github.com/rgomezjnr/shortable/blob/master/LICENSE.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frgomezjnr%2Fshortable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frgomezjnr%2Fshortable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frgomezjnr%2Fshortable/lists"}