Overview
The node interacts with the StockAlert.pro API to manage stock alerts. Specifically, the "Alert" resource with the "Get Many" operation allows users to retrieve multiple stock alerts based on various filters and sorting options. This is useful for monitoring a portfolio of stock alerts, analyzing alert statuses, or integrating alert data into workflows for further processing or notifications.
Practical examples:
- Fetch all active alerts related to price changes above a threshold.
- Retrieve a limited number of alerts filtered by symbol or company name.
- Sort alerts by creation date or status to prioritize handling.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching alerts or limit the number of results returned. |
| Limit | Maximum number of alerts to return if not returning all (minimum 1). |
| Filters | Collection of filter options: |
| - Alert Type | Filter alerts by type/condition. Options include: All, Price Above, Price Below, Price Change Up (%), Price Change Down (%), New 52-Week High, New 52-Week Low, One-Time Reminder, Daily Reminder, Golden Cross (MA), Death Cross (MA), MA Touch Above, MA Touch Below, RSI Limit, Volume Change, P/E Ratio Below, P/E Ratio Above, Forward P/E Below, Forward P/E Above, Earnings Announcement, Dividend Ex-Date, Dividend Payment. |
| - Search | Search alerts by stock symbol or company name. |
| - Sort Direction | Order of sorting: Ascending or Descending. |
| - Sort Field | Field to sort by: Created Date, Symbol, or Status. |
| - Status | Filter alerts by status: All, Active, Paused, Triggered. |
Output
The output is an array of JSON objects representing the retrieved alerts. Each alert object contains details such as alert ID, symbol, condition/type, status, creation date, and other relevant metadata depending on the alert type.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the StockAlert.pro API.
- The node uses internal helper functions to make HTTP requests to the StockAlert.pro endpoints.
- No additional environment variables are explicitly required beyond the API authentication.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Providing invalid filter values may result in empty responses or errors.
- Requesting too many items without enabling "Return All" may truncate results unexpectedly.
Error messages:
- Authentication errors typically indicate invalid or missing API keys; verify credentials.
- Validation errors may occur if filter parameters are malformed; check property values.
- Network or API downtime errors require retrying later or checking service status.
Links and References
- StockAlert.pro API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes