GhostfolioSidekick

A continuous running Docker container (a sidecar) to automatically import files from several brokers & crypto exchanges. The program checks every hour if any new transactions are found and inserts them in ghostfolio. It can also correct & remove transactions in case they have changed (for example a different exchange rate) or the source file was deleted.

Additionally, for self-hosted instances, it can maintain symbols automatically.

• Set trackinsight property of symbols
• Create manual symbols
• Delete symbols that are no longer used

( more to come? Help is always welcome! )

Setup

Ghostfolio

• Create an account in ghostfolio using anonymous option save your KEY.
• Create the relevant accounts in ghostfolio.

Folder structure

FileImporterPath should point to a folder with the following structure:

• Account Name
  • File1.csv
• Account Name 2
  • File2.csv
  • File3.csv

Assuming you configured an account with the name 'Trading 212' and an account with 'De Giro' in ghostfolio, the following structure should be used. For example:

• Trading 212
  • Export2023.csv
• De Giro
  • Export2022.csv
  • Export2023.csv

Configuration File

A single json file csv file that contains mapping to convert currencies and symbols to a symbol that can be found via ghostfolio. Also allows the following sybol settings

• Setting Trackinsight on symbols
• Adding / Updating Manual symbols

{
    "settings" : {
		"use.crypto.workaround.stakereward.as.dividends" : true, // default is false
		"use.crypto.workaround.dust" : true // default is false,
		"use.crypto.workaround.dust.threshold": 0.01 // default is 0
	},
	"platforms":[
		{ "name": "De Giro", "url":"https://www.degiro.nl/" }
	],
	"accounts":[
		{ "name": "De Giro", "currency":"EUR", "platform":"De Giro" }
	],
	"mappings":[
		{ "type":"currency", "source":"GBX", "target":"GBp"},
		{ "type":"symbol", "source":"USDC", "target":"usd-coin"},
		{ "type":"symbol", "source":"BTC", "target":"bitcoin"}
	],
	"symbols":[
		{ "symbol": "VDUC.L", "trackinsight": "VUSC" },
		{ "symbol": "VFEM.L", "trackinsight": "VDEM" },
		{ "symbol": "DE0001102333", "manualSymbolConfiguration": { "currency":"EUR", "isin":"DE0001102333","name":"Bond Germany Feb 2024","assetSubClass":"BOND","assetClass":"EQUITY" } },
		{ "symbol": "PhysicalGoldEuroPerKilogram", "manualSymbolConfiguration": { "currency":"EUR", "isin":"PhysicalGoldEuroPerKilogram","name":"Physical Gold EUR/KG","assetSubClass":"PRECIOUS_METAL","assetClass":"COMMODITY", "scraperConfiguration":{ "url": "<url>", "selector":"<selector>"} } }
	]
}

Settings

use.crypto.workaround.stakereward.as.dividends (Experimental)

This settings does control if a workaround is used for stakerewards.

Value	Action
false (default)	Ignore stake activities
true	Convert the Stake reward activity to a Buy & Dividend activity

use.crypto.workaround.dust (Experimental)

This settings does control if a workaround is used for dust (very small amount of cryptocurrency that cannot be sold).

Value	Action
false (default)	Do nothing
true	Adjust the last sell activity as if the dust was also sold

use.crypto.workaround.threshold (Experimental)

This settings is the threshold of local currency of the asset if a value is considered dust. Any holding less than this value is considered dust and will be added to the last sell/send activity.

Platform and Account

Creates platforms and accounts if not yet created

Fields are identical to the UI

Mappings

Change an identifier from the imported files to be compatible with Ghostfolio (for example certain symbols may not be found by Ghostfolio, so we can substituting the identifier with one that is recognized).

Fieldname	Type	Description
type	one of: 'currency', 'symbol'	The type of mapping to be applied
source	any string	the name of the symbol as it appears in the csv files
target	any string	the name of the symbol to use within Ghostfolio

Symbols

Maintaining symbols in ghostfolio

Fieldname	Type	Description
symbol	any string	The name of the symbol
trackinsight	any string	The trackinsight key to be set
manualSymbolConfiguration	ManualSymbolConfiguration	see ManualSymbolConfiguration. Will be created if it does not exists

ManualSymbolConfiguration

Fieldname	Type	Description
currency	any string	The currency of the symbol
isin	any string	The ISIN to be set
name	any string	The name of the symbol
assetSubClass	one of: 'CRYPTOCURRENCY', 'ETF', 'STOCK', 'MUTUALFUND', 'BOND', 'COMMODITY', 'PRECIOUS_METAL', 'PRIVATE_EQUITY'	Same list as Ghostfolio
assetClass	one of: 'CASH', 'COMMODITY', 'EQUITY', 'FIXED_INCOME', 'REAL_ESTATE'	Same list as Ghostfolio
scraperConfiguration	object with url and selector	The scraperconfiguration as used in Ghostfolio (NOTE: no support for headers yet)

Supported formats

The goal is to support all platforms as best as possible. Due to the continuous growth of Ghostfolio, new features may be added when possible.

Platform	Source of the files	Buy	Sell	Dividend	Interest & Cash balance
Generic importer	See below	X	X	X	X
Trading 212	Export of transaction history	X	X	X	X
De Giro	Export of account history	X	X	X	X
Scalable Capital	The CSV files of the Baader bank. Type WUM and RKK	X	X	X	X
Bunq (bank)	Export CSV (Semicolom delimited)	-	-	-	X
NIBC (bank)	Export CSV (Semicolom delimited)	-	-	-	X
Nexo (Experimental)	Export of transaction history	X	-	-	X
Bitvavo (Experimental)	Export of transaction history	X	X	-	X

Generic import format

Beside the supported exchanges and brokers there is also a generic format. This format is only usefull for stocks at the moment, not for cryptocurrency:

Field	Value(s)
OrderType	BUY ,SELL, DIVIDEND and INTEREST
Symbol	The symbol to search
Date	The date, yyyy-MM-dd
Currency	The currency of the unitprice and fee
Quantity	The amount of units
UnitPrice	The paid price per unit
Fee	The total fee paid for the transaction

Example

OrderType,Symbol,Date,Currency,Quantity,UnitPrice,Fee BUY,US67066G1040,2023-08-07,USD,0.0267001000,453.33,0.02

Run in Docker

The docker image is named: vibenl/ghostfoliosidekick

Settings

Envs	Description
GHOSTFOLIO_URL	The endpoint for your ghostfolio instance.
GHOSTFOLIO_ACCESTOKEN	The token as used to 'login' in the UI
FILEIMPORTER_PATH	The path to the files (see [Import Path])
CONFIGURATIONFILE_PATH	(optional) The path to the config file, see above

Contributing

• Feel free to submit any issue or PR's you think necessary