https://github.com/pardnio/go-stock-notification
https://github.com/pardnio/go-stock-notification
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/pardnio/go-stock-notification
- Owner: pardnio
- Created: 2026-01-08T02:29:46.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2026-01-21T05:27:07.000Z (5 months ago)
- Last Synced: 2026-04-24T17:35:29.064Z (about 2 months ago)
- Language: Go
- Size: 18.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> [!NOTE]
> This README was generated by [Claude Code](https://gist.github.com/pardnchiu/b09c9bf1166ec7759cbbeeae2e4e93df), get the ZH version from [here](./README.zh.md).
# go-stock-notification
> A stock price notification service powered by PostgreSQL LISTEN/NOTIFY, automatically pushing Discord alerts when prices hit target thresholds.
## Features
- **Database-Driven Notifications**: Leverages PostgreSQL Triggers and pg_notify for real-time price monitoring without polling
- **Discord Integration**: Sends formatted embedded notification messages via Webhook
- **RESTful API**: Provides simple HTTP endpoints for setting prices and notification thresholds
## Architecture
```mermaid
sequenceDiagram
participant Client
participant Gin as Gin Server
participant PG as PostgreSQL
participant App as Go Listener
participant Discord
Client->>Gin: PUT /set/:ticker/price/:price
Gin->>PG: UPDATE ticker_price
PG->>PG: Trigger check_price()
PG->>PG: INSERT/UPDATE ticker_notify
PG->>App: pg_notify('ticker_notify', payload)
App->>Discord: POST Webhook
```
## Installation
```bash
# Clone the repository
git clone https://github.com/neurowatt-dev/go-stock-notification.git
cd go-stock-notification
# Copy environment template
cp .env.example .env
# Edit .env with your database and Discord Webhook settings
# Start with Docker Compose
docker compose up -d
```
## Usage
### Set Notification Threshold
Configure the price level at which notifications trigger:
```bash
# Set AAPL notification price to 150.00
curl http://localhost:8080/set/AAPL/notify/150.00
```
### Update Stock Price
Update the latest stock price; crossing the threshold triggers a notification:
```bash
# Update AAPL price to 151.50
curl http://localhost:8080/set/AAPL/price/151.50
```
### Notification Logic
- **Breakout Up**: Triggers when price rises from below to at or above threshold
- **Breakdown**: Triggers when price falls from at or above to below threshold
- **Direction Change**: Notifications only sent on direction change to prevent duplicates
## Configuration Reference
### Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| `DB_USER` | PostgreSQL username | `postgres` |
| `DB_PASSWORD` | PostgreSQL password | `password` |
| `DB_NAME` | Database name | `database` |
| `DB_PORT` | Database port | `5432` |
### Database Schema
| Table | Purpose |
|-------|---------|
| `ticker_price` | Stores ticker symbols with current and previous prices |
| `ticker_compare` | Stores notification threshold prices |
| `ticker_notify` | Stores notification state and trigger direction |
### API Endpoints
| Method | Path | Description |
|--------|------|-------------|
| GET | `/set/:ticker/notify/:price` | Set notification threshold |
| GET | `/set/:ticker/price/:price` | Update stock price |
## License
This is a private project.
## Author
邱敬幃 Pardn Chiu
***
©️ 2026 [邱敬幃 Pardn Chiu](https://linkedin.com/in/pardnchiu)