https://github.com/calvn/brokr
📈 - Make your plays. Place your trades.
https://github.com/calvn/brokr
cli stocks tradier trading
Last synced: about 1 year ago
JSON representation
📈 - Make your plays. Place your trades.
- Host: GitHub
- URL: https://github.com/calvn/brokr
- Owner: calvn
- License: apache-2.0
- Created: 2016-07-25T21:34:17.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-14T07:22:28.000Z (over 8 years ago)
- Last Synced: 2025-03-02T03:51:21.544Z (over 1 year ago)
- Topics: cli, stocks, tradier, trading
- Language: Go
- Homepage:
- Size: 7.14 MB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# brokr
brokr is a CLI application that allows you to manage your brokerage account, including the ability to place orders, view pending orders and existing positions, and get real-time quotes.
brokr currently only supports managing Tradier brokerage accounts, but it has been designed from the beginning to support implementing other brokerages.
## Installing
```sh
$ go get github.com/calvn/brokr
$ cd $GOPATH/src/github.com/calvn/brokr
$ make build
```
Compiled binaries will be available once brokr is in a relatively stable release.
## Getting started
To get started, configure brokr using `brokr config tradier --account --token `.
Your `.brokr.yaml` will look something like this:
```yml
brokerage: tradier
preview_order: true
tradier:
account:
access_token:
```
After Tradier configuration has been set, you can start interacting with your account.
### Sane defaults
brokr will set sane defaults if none are passed in via `brokr config`.
| Setting | Value |
|---------------|----------|
| brokerage | tradier |
| preview_order | true |
## Limitations
brokr is currently limited to buy and selling stocks. The ability to trade options will be implemented in the near future.
brokr currently does not have short-sell and buy-to-cover implemented. This feature will be added in a future release.
## Contributing
Contributions are always welcomed. To contribute, fork the repository, make the necessary changes, and send in a pull request back to master. Opening an accompanying issue is strongly recommended.
### Development dependencies
- Go 1.8+
- Glide