← choose a method to test the endpoints | how-to's | how to calculate aggregated monthly dividend totals | dividend tracker api documentation
How to Calculate Aggregated Monthly Dividend Totals
Scenario
You have a list of dividend data and you would like to know the amount of dividends paid out per month for all tickers. This is known as aggregated monthly dividend totals.
Prerequisites
Before you begin, make sure you have:
- Node.js and npm installed on your system
- A basic working knowledge of JavaScript or Node.js
- Forked the Dividend Tracker API and cloned a copy to your local system.
- Start the Dividend Tracker API server locally on your machine
Outline of Steps
This how-to guide covers the following sections/steps:
- Example of the file format containing your dividend data
- Example for making the
/monthly-summaryAPI call with your file and receiving the aggregated monthly dividend totals back in JSON format to your console.