# Kraken CLI

A CLI for the Kraken Exchange.

## Setup

To install the executable from source, run:

```sh
cargo install --path .
```

## Usage

```sh
kraken --help

kraken market ticker BTC/USD

kraken account balance

kraken account orders list
kraken account orders list --json --pretty
kraken account orders list -jp

kraken account orders cancel OLJ-XXXX-YYYY

kraken account orders create --type limit --side BUY --pair BTC/USD --volume 0.1 --price 1000.0
```

Additional functionality that will be supported _in the future_:

```sh
kraken account balance --json --pretty

kraken account orders remove ...
kraken account orders create ...
```

Calling private API endpoints requires credentials provided through env
variables:

```sh
export KRAKEN_API_KEY="..."
export KRAKEN_API_SECRET="..."
```

The `RUST_LOG` env variable is used to configure tracing, e.g.

```sh
RUST_LOG=debug kraken market ticker BTC/USD
```

## Status

This work is under active development and the API is expected to change.

## Contributing

Pull requests, issues and comments are welcome! Make sure to add tests for new
features and bug fixes.

## License

This work is licensed under the Apache-2.0 License. See
[LICENSE.txt](LICENSE.txt) or <https://spdx.org/licenses/Apache-2.0.html> for
details.

## Copyright

Copyright © 2023 [Georgios Moschovitis](https://gmosx.ninja).