diff options
-rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -32,8 +32,8 @@ The server will run on the port specified in your `.env` file. ## Usage The server has two purposes: -1. Update the stock metrics to the spreadsheet weekly. -2. Provide a REST API for updating the spreadsheet on demand. +1. **Update the stock metrics to the spreadsheet weekly.** +2. **Provide a REST API for updating the spreadsheet on demand.** The only endpoint is `http://localhost:{env.PORT}/api/update-stock-screener?token=${env.STOCK_SCREENER_AUTH_TOKEN}`. This is meant to be run in the background but still allows for manual triggering via the API. Obviously, you should secure this endpoint in a production environment. |