Ghostfolio API

👉 Node.js/Typescript library to import data through Ghostfolio. 👈

📦 Install

yarn add ghostfolio-api

🔧 Build

yarn build

📖 Examples

const ghost = GhostfolioApi('access-token');

const requestBody: ImportRequestBody = {
  activities: [
    {
      currency: 'USD',
      dataSource: 'YAHOO',
      date: '2021-09-15T00:00:00.000Z',
      fee: 19,
      quantity: 5,
      symbol: 'MSFT',
      type: 'BUY',
      unitPrice: 298.58,
    },
  ],
};

await ghost.importData(requestBody);

🧪 Tests

yarn test    # to be implemented

👋 Contributions & Pull Requests

Contributions are encouraged, I will review any incoming pull requests. Be sure to run yarn test to run all tests, yarn lint to run eslint and yarn prettier to run the prettier.

⚠️ Disclaimer

This is an unofficial NodeJS API wrapper for the Ghostfolio application, use at your own risk.