← how it works | dividend tracker api documentation
Dividend Tracker API Endpoint Summary
The table below summarises the Dividend Tracker API Enpoints.
| API Endpoint | Description | What it Does | How-to Guide |
|---|---|---|---|
GET / |
Test if the server is up and running | Displays 'Hello API' when the endpoint is reachable | How-To do a Health-Check (and start your local server) |
POST /monthly-summary |
Calculate total dividends received per month | Accepts a JSON list of dividend data and returns a JSON list of aggregated montly totals | How-To Calculate Aggregated Monthly Dividend Totals |