Skip to content

Latest commit

 

History

History
220 lines (188 loc) · 17.6 KB

README-en.md

File metadata and controls

220 lines (188 loc) · 17.6 KB


java-version spring-boot-version hits-of-code github-closed-pull-requests github-workflow-status github-all-releases docker-pulls telegram-channel telegram-group telegram-support

Find out the real annual percentage return on investment and compare it to a bank deposit, find out the average cost of buying stocks, bonds, derivatives, automate, analyze your portfolio.

Contents

Purpose

If you keep records of transactions in Excel or have heard that it should be kept (recommendation 1, 2, 3), then this free application will help you do it.

Accounting for transactions in an Excel table, in contrast to broker reports, shows the history of the portfolio: the average purchase price, financial results of transactions, history of dividends and coupons, withholding taxes on payments and withdrawals, history of cash flows, the final return on investments and speculation since the opening of the account, future tax withholding and tax obligations are not a complete list of information that the application will calculate for you.

Some brokers provide a personal account and charts, but may not disclose all the information. If you have several accounts with different brokers, information will be presented in different places, volumes and formats. Application objectively, displays data in a single format for all brokers.

main-page

sectors-pie-chart

All you need to do is download the latest broker reports or enter manually information. In this case, all information is saved on your computer, the data does not go to the cloud, and the Internet is not required to work.

For each account separately and summing up a single total for all accounts, the following information will be available:

  • review of asset growth calculated using the S&P 500 method, compared to the S&P 500, investment history and cash balances;
    portfolio-analysis
  • portfolio of securities with information about the current position, average price purchases and yield of securities (CHISTVNDOH/XIRR), taking into account hedging positions in the derivatives market and the average purchase price of currency;
    portfolio
  • share of a security in a portfolio;
    current-proportion
  • trader's portfolio with information on profitability transactions on the derivatives market in the context of a group of contracts (for example, for all futures and options Si, the same for BR, etc.);
    derivatives-marker-total-profit
  • distribution of profit across groups of derivatives contracts in the trader’s portfolio;
    derivatives-profit-proportion
  • details of dividend, coupon and depreciation payments;
    portfolio-payment
  • details of dividend, coupon and depreciation payments, accrued on shares and bonds from the linked IIS account; foreign-portfolio-payment
  • profitability of transactions on the stock market (FIFO method);
    stock-market
  • profitability of transactions on the derivatives market;
    derivatives-market
  • profitability of transactions on the foreign exchange market;
    foreign-market
  • input and output of securities from/to other accounts, conversion, split of shares (AAPL, TSLA, etc.);
  • profitability of portfolio (CHISTVNDOH/XIRR), replenishments, write-offs, transfers from/to other accounts,
  • current cash balance;
    cash-in
  • tax burden, including the obligation to independently pay tax for foreign securities;
    tax
  • broker commission.

Difference from similar products

Investbook in comparison with Intelinvest and Snowball Income has the following advantages:

  1. No monthly subscription. For free. Always and unconditionally.
  2. Dividends, coupons and tax payments are taken into account upon receipt. This allows you to accurately calculate profitability, timely track delays in receipt of payments to the account.
  3. High accuracy of portfolio value assessment and tax liabilities. Unlike analogues of the amount and date of receipt payments specified in the application can be directly used to draw up a 3-NDFL declaration.
  4. No Internet access required, the ability to work in your free time while traveling without the Internet.
  5. Safety. No need to upload broker reports to the cloud, no need to provide an access token to the brokerage account to third parties and software with potential errors. For example, it is known that tokens of a popular broker allow you to make transactions without your participation.
  6. Open source is an additional guarantee of security and confidence in the availability of data only to you.
  7. Clear, widely used report format - Excel tables with detailed description of each column.
  8. Unified data presentation format "Portfolio Open Format" if necessary, it will allow you to painlessly transfer the accumulated data to another investment accounting application.

Brokers

The application analyzes reports from brokers Tinkoff (xlsx), Sberbank (xlsx), VTB (xls), Promsvyazbank (xlsx, xml) and Your Broker / Uralsib (zip with xls). If your account is opened with another broker, write to us. You can also use it already on your version of the application forms for entering information or download data from Excel file. Your broker's support can also be offered to third-party developers through extension functionality. Instructions for installing extensions are available for operating systems windows, mac and linux.

Install

Download the .msi installer from the [project] page (https://github.com/spacious-team/investbook/releases/latest) and run it.

You can refer to more detailed instructions for installing and using the application for operating systems windows, mac and linux. Investbook can also be run in docker.

Working with the application

Launch the application via a shortcut on the Windows desktop, in the browser go to http://localhost:2030 and download broker reports (from your local computer or email).

For convenience, the application allows:

  1. Downloading the same report multiple times (useful if you don't remember whether you downloaded a particular report or not), There will be no data duplication.
  2. Downloading reports for any time interval (day, month, year, etc.), and it is acceptable that reports of different time periods will overlap.
  3. It is acceptable to download reports for multiple brokerage/investment accounts, including from different brokerage houses.

After downloading the report, analytical download in excel file format becomes available.

Application update

The update process on Windows is no different from the initial installation process. Use the instructions for operating systems windows, mac or linux. Or, if Investbook was run in docker, use instructions.

Documentation

Additional information can be found in documentation, also offline documentation is always available is available to you in the installed application on the main page via the "Documentation" link.

License

The application is free (you are allowed to use, distribute, copy and make changes). The license text is available in English and Russian languages, and also available explanation and answers to questions in Russian.

The license implies that the application is released to the public. Application version from page will always be distributed free of charge. But the license also allows any developer to improve their own copy of the application, including for the purpose of sales (with the caveat that the modified source code will be open on the Internet).

Why is the application code open source

For some areas, open source solutions are better suited than others, for example in the fields of finance and data encryption, because these solutions can be trusted because you or anyone else can look at the code and see in the security of the program. Many famous brands use open source, Instagram for example, Android, Telegram, Twitter, Google Chrome, Mozilla Firefox, sites with a secure https connection, such as https://vk.com, etc. The idea of open source is the freedom to develop and use software.

Elon Musk's opinion on open source.

We will publish more source code and make it publicly available. And of course he will also be criticized, people will help you find all the stupid things in the code. And we will quickly correct them, and we will do it under full public control. I think this approach will allow us to gain public trust. Because here you don't have to take my word for it, you can read the code with your own eyes, and what people say about this code. And you can see the improvements we're making. You can monitor the entire process in real time and see all the improvements. I'd be surprised If only society hadn't thought after that, "Wow, this looks like something we can trust!" Well, it's true, this story should inspire much more trust than others with all their black boxes and refusal to show the inside story. What are you trying to hide? Clearly not something good. If you have nothing to hide, why not show it?

2023 year interview

How to help

You can help by expanding or correcting the documentation, reporting problems with the application, offering new functionality or improving the Investbook application code.

There is also extension functionality, that allows third-party developers expand the list of brokers supported out of the box. Extensions can be connected at the request of users to the application. Third-party developers can distribute extensions for free or for a fee, therefore, developers, even pursuing different goals, work together. If you decide to improve the application in this repository, please read the following information.

Contacts

You can leave your review on the website otzovik.com.

Evaluate investment performance easily and confidentially.