kraken-btc ๐Ÿ™

An opinionated command line interface for buying Bitcoin on Kraken.com. Written in Rust.

Installation ยท Example ยท API Credentials

--- This is a simple command line interface for buying Bitcoin on [Kraken.com](https://kraken.com). The idea is to enable setups that make it easy to get your hands on some Bitcoin in an automated way. For example, you could use this in an Auto-[DCA](https://en.wikipedia.org/wiki/Dollar_cost_averaging) script. I've always wanted to build something in [Rust ๐Ÿฆ€](https://rust-lang.org) so this was a good opportunity for me to learn how to do that. ## ๐Ÿ’ฝ Installation Binaries for macOS are available through Homebrew and GitHub releases. For other platforms, it is recommended to build from source. ### Homebrew (macOS) ``` $ brew tap dnlggr/tap $ brew install kraken-btc ```
Expand for uninstall instructions

$ brew untap dnlggr/tap

$ brew uninstall kraken-btc

### Download Binary Release (macOS) You can find binaries for all releases on this repo's [releases page](https://github.com/dnlggr/kraken-btc/releases). ### From Source To build from source, you must have [Rust and Cargo installed](https://www.rust-lang.org/tools/install). ``` $ cargo install kraken-btc ``` This will install a binary in your Rust installation root's `bin` directory. Typically, this is `$HOME/.cargo/bin`. ## ๐Ÿ’ธ Usage This is a short example on how to use `kraken-btc` to spend 100 Euro on Bitcoin. ``` $ kraken-btc --api-key <...> --api-secret <...> buy --fiat-currency EUR --fiat-amount 100 ``` You'll get a confirmation of your order that looks something like the one below. ``` ๐Ÿ™ Spending 100 EUR on Bitcoin. ๐Ÿ“ฆ ORDER: buy 0.00531632 XBTEUR @ limit 18810.0 ๐ŸŽซ TXID: ABCDEF-GHIJK-LMNOPQ ๐ŸŽ‰ STATUS: Order was placed. ``` Make sure to double check your [orders page](https://www.kraken.com/u/trade#tab=orders) on Kraken from time to time make sure everything works as expected. **Tip:** Pass the optional `--dry-run` flag to the `buy` subcommand to test your order without actually placing it. For more detailed usage information and documentation run `kraken-btc help`. ## ๐Ÿ”‘ API Credentials Create the necessary Kraken API here: [API settings page](https://www.kraken.com/u/security/api/new). To be able to place orders, the generated API credentials must have the **_Modify Orders_** permission. On some pages, the _API Key_ might be referred to as _API Public Key_. Likewise, the _API Secret_ is also known as _API Private Key_. It is important to keep these credentials safe and never share them with anyone. It's best to not store them in plain text on your computer but to use a password manager. More information on how to create API credentials can be found in Kraken's [documentation](https://support.kraken.com/hc/en-us/articles/360000919966-How-to-generate-an-API-key-pair-).