KrakenDCA

command module
v1.2.1 Latest Latest
Warning

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

Go to latest
Published: May 9, 2024 License: GPL-3.0 Imports: 5 Imported by: 0

README ΒΆ

πŸ™ Kraken-DCA

Automated dollar cost averaging on the Kraken exchange

Buid License

Table of Contents

  1. ➀ About the project
  2. ➀ Configuration
  3. ➀ Push Notifications
  4. ➀ Run with Docker
  5. ➀ Run without Docker

πŸ” About the project

Since Kraken has extremely high fees for its crypto savings plan, this tool was developed to invest regularly in cryptocurrencies. Since Kraken offers two platforms: β€˜Kraken’ and β€˜Kraken Pro’, we take advantage of the fact that Kraken Pro has very low fees. All you have to do is regularly deposit fiat currencies on Kraken Pro and the bot does everything else for you.

πŸ’° Orders
When will orders be placed?

Bitcoin orders are placed as often as possible. To illustrate the behaviour in more detail, let's look at the following example: You deposit €500 per month on Kraken-Pro. The bot calculates how often you can buy Bitcoin this month, as Kraken has a minimum purchase limit of 0.0001 BTC. Your orders are executed as often as possible throughout the month, thereby achieving dollar-cost averaging.

βš™οΈ Configuration

This tool is configured via environment variables. Some environment variables are required and some activate additional functionalities.

Variable Description Required Default
KRAKEN_PUBLIC_KEY Your Kraken API public key βœ…
KRAKEN_PRIVATE_KEY Your Kraken API private key βœ…
CURRENCY Your fiat currency to be used, e.g. USD or EUR ❌ USD
KRAKEN_ORDER_SIZE The order size to be used. This value should only be edited if you know exactly what you are doing. ❌ 0.0001
EXPERIMENTAL_MAKER_FEE If set to true, maker orders are placed, saving fees. Warning: This function is experimental. ❌ false
CHECK_DELAY How often the algorithm should be executed, in seconds. ❌ 60
GOTIFY_URL URL to your Gotify server ❌
GOTIFY_APP_TOKEN App token for the app on the Gotify server ❌

πŸ“± Push Notifications

The environment variables GOTIFY_URL and GOTIFY_APP_TOKEN can be used to activate Gotify Push Notifications. As soon as a purchase has been made, you will immediately receive a notification so that you always have a full overview of your purchases.

🐳 Run with Docker
Docker-CLI
docker run -d --name kraken_dca \
  -e KRAKEN_PUBLIC_KEY=your-public-key \
  -e KRAKEN_PRIVATE=your-private-key \
  -e CURRENCY=EUR \
  ghcr.io/primexz/kraken_dca:latest

πŸš€ Docker-Compose
vim docker-compose.yml
version: "3.8"
services:
  kraken_dca:
    image: ghcr.io/primexz/kraken_dca:latest
    environment:
      - KRAKEN_PUBLIC_KEY=your-public-key
      - KRAKEN_PRIVATE_KEY=your-private-key
      - CURRENCY=EUR
    restart: always
docker-compose up -d

πŸ’» Run without Docker

This tool can be run directly with Go for development.

KRAKEN_PUBLIC_KEY=your-public-key KRAKEN_PRIVATE_KEY=your-private-key go run .

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