brokr

command module
v0.0.0-...-58dd970 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 14, 2018 License: Apache-2.0 Imports: 2 Imported by: 0

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.

brokr Demo GIF

Installing

$ 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 <ACCOUNT ID> --token <ACCESS TOKEN>.

Your .brokr.yaml will look something like this:

brokerage: tradier
preview_order: true
tradier:
  account: <ACCOUNT ID>
  access_token: <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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL