go-comdirect

go-comdirect is both a client library and CLI tool to interact with the comdirect REST API.

Additional Notes

• The library is currently unstable and will change frequently until version 1.0.0 is released
• Please read the comdirect API documentation prior to using this software
• Use of this software is at your own risk
• 10 requests per second are allowed by comdirect
• 3 invalid TAN validation attempts will cancel the online access

Install

Use go get to install the latest version of this library:

$ go get -u github.com/jsattler/go-comdirect

Use go install to install the comdirect CLI tool:

go install github.com/jsattler/go-comdirect/comdirect@main

Quick Start

// omitting error validation, imports and packages

options := &comdirect.AuthOptions{
    Username:     os.Getenv("COMDIRECT_USERNAME"),
    Password:     os.Getenv("COMDIRECT_PASSWORD"),
    ClientId:     os.Getenv("COMDIRECT_CLIENT_ID"),
    ClientSecret: os.Getenv("COMDIRECT_CLIENT_SECRET"),
}

client := comdirect.NewWithAuthOptions(options)

Documentation

You can find detailed documentation

• on how to install and use the comdirect CLI tool
• on this website
• in the docs/ folder
• or in the tests of pkg/comdirect

Roadmap / To-Do

• Auth
  • P_TAN_PUSH
  • P_TAN_PHOTO (currently out of scope)
  • P_TAN_APP (currently out of scope)
  • Refresh Token
  • Revoke Token
• Account
  • All Balances
  • Balance by Account ID
  • Transactions
• Depot
  • All Depots
  • Positions by Depot ID
  • Position by Depot ID and Position ID
  • Transactions by Depot ID
• Instrument
  • Instrument by Instrument ID
• Order
  • Dimensions
  • Orders by Depot ID
  • Order by Order ID
  • Order Pre-Validation
  • Order Validation
  • Generate Order Cost Indication Ex-Ante
• Quote
  • Quote-Request Validation and TAN Challenge Request
  • Quote-Request Validation and TAN validation
  • Create Quote-Request Request
• Documents
  • Documents (Postbox)
  • Document by ID
  • Pre-Document (currently out of scope, since I have no document to test this with)
• Reports
  • Balances of all comdirect products