kraken_cli

Crates.iokraken_cli
lib.rskraken_cli
version0.26.0
sourcesrc
created_at2023-08-23 19:53:12.821455
updated_at2024-07-10 17:43:02.884669
descriptionA CLI for the Kraken Exchange
homepage
repositoryhttps://github.com/gmosx/kraken-sdk-rust/tree/main/kraken_cli
max_upload_size
id952702
size64,811
George Moschovitis (gmosx)

documentation

README

Kraken CLI

A CLI for the Kraken Exchange.

Setup

To install the executable from source, run:

cargo install --path .

Usage

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:

kraken account balance --json --pretty

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

Calling private API endpoints requires credentials provided through env variables:

export KRAKEN_API_KEY="..."
export KRAKEN_API_SECRET="..."

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

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 or https://spdx.org/licenses/Apache-2.0.html for details.

Copyright

Copyright © 2023 Georgios Moschovitis.

Commit count: 0

cargo fmt