/sharesies-bot

Dollar-cost averaging on NZ Market Exchange 💰🇳🇿

Primary LanguageGoMIT LicenseMIT

Auto Invest Sharesies NZ (Work in progress)

Currently, Sharesies NZ only support auto-invest for managed funds what creates the need for this application to apply dollar-cost averaging for companies on NZ Market Exchange.

The project is under heavy development so interfaces and structure of the configuration files might/will change. The current implementation is an MVP put together in a couple of hours.

Scheduler

Linux crontab compatible instruction for executing orders

Predefined

Entry Description Equivalent To
@yearly (or @annually) Run once a year, midnight, Jan. 1st 0 0 1 1 *
@monthly Run once a month, midnight, first of month 0 0 1 * *
@weekly Run once a week, midnight between Sat/Sun 0 0 * * 0
@daily (or @midnight) Run once a day, midnight 0 0 * * *
@hourly Run once an hour, beginning of hour 0 * * * *

More information:

Configuration

config/auto_invest.yml

sharesies:
  username: test@test.com
  password: password

balance:
  scheduler: 0 0 1 */6 * # 6 Month
  holds: 
    - reference: Delegat Group
      id: 0545fbc5-b579-4944-9057-55d01849a493
      weight: 50 # 50%
    - reference: ANZ
      id: 860a502e-d07c-435e-9dcc-7d4631a4ee21
      weight: 50 # 50%

buy:
  scheduler: "0 8 * * MON" # Monday 8am
  orders:
    - reference: Delegat Group # Only for log purpose
      id: 0545fbc5-b579-4944-9057-55d01849a493
      amount: 1.00
    - reference: ANZ # Only for log purpose
      id: 860a502e-d07c-435e-9dcc-7d4631a4ee21
      amount: 1.00

Docker Compose

version: "3"

services:
  sharesiesbot:
    image: deividfortuna/sharesies-bot:latest
    container_name: sharesies-bot
    volumes:
      - './config/:/config'
    restart: unless-stopped