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" : {
        "dataprovider.preference.order": "COINGECKO,YAHOO", // default "YAHOO,COINGECKO"
        "use.dust.currency" : "EUR", // default is "USD",
        "use.dust.threshold" : 0.0001 // default is 0.0001,
        "use.crypto.workaround.dust.threshold": 0.01 // default is 0.001,
        "use.crypto.workaround.stakereward.add.to.last.buy" : true // default is false,
        "delete.unused.symbols": false // default is true. Note generated symbols like INTEREST and FEE are always deleted since they can't be reused.
        "use.dividend.workaround.tax.substract.from.amount": true // default is false. If set to true, the tax is substracted from the dividend amount. If set to false, the tax is added as a fee.
    },
    "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>", "locale":"<locale>"} } }
    ],
    "benchmarks":[
        { "symbol": "^AEX" },
        { "symbol": "^SPX" },
    ]
}

Settings

use.dust.threshold (Experimental)

This settings does control if a workaround is used for dust (very small amount that cannot be sold or due to rounding errors). The amount is the total value of the assets (thus quantity times unitprice). Unitprice is converted to the currency defined by use.dust.currency.

For crypto specifically, another setting will take presidence. See use.crypto.workaround.dust.threshold. This due to the likelyness of higher values for the dust of cryptocurrencies.

use.crypto.workaround.dust.threshold (Experimental)

This settings does control if a workaround is used for dust (very small amount that cannot be sold or due to rounding errors). The amount is the total value of the assets (thus quantity times unitprice). Unitprice is converted to the currency defined by use.dust.currency.

use.crypto.workaround.stakereward.add.to.last.buy (Experimental)

This settings does control if a workaround is used for staking rewards. If set to true, the staking reward is added to the last buy activity.

Platform and Account

Creates platforms and accounts if not yet created

Fields are identical to the UI

Benchmarks

Add a symbol as a benchmark

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).

Symbols

Maintaining symbols in ghostfolio

ManualSymbolConfiguration

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.

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:

Example

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

File2: Symbol,Date,StockSplitFrom,StockSplitTo US67066G1040,2023-08-07,1,3

Run in Docker

The docker image is named: vibenl/ghostfoliosidekick

Example docker-compose.yml:

ghostfoliosidekick:
    image: vibenl/ghostfoliosidekick:latest
    container_name: Ghostfolio-Ghostfoliosidekick
    hostname: ghostfoliosidekick
    security_opt:
        - no-new-privileges:true
    environment:
        - GHOSTFOLIO_URL=url
        - GHOSTFOLIO_ACCESTOKEN=abc
        - FILEIMPORTER_PATH=/var/lib/data
        - CONFIGURATIONFILE_PATH=/var/lib/data/config.json
    restart: always
    volumes:
        - /volume1/docker/ghostfolio/sidekick:/var/lib/data:r
    depends_on:
    ghostfolio:
        condition: service_started

Settings

Contributing

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