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 include:
- Fetching all active alerts related to specific stock symbols.
- Retrieving alerts filtered by alert type (e.g., price above threshold, new 52-week high).
- Sorting alerts by creation date or symbol in ascending or descending order.
- Limiting the number of alerts returned for performance or display purposes.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching alerts or limit the results to a specified maximum number. |
| Limit | Maximum number of alerts to return when not returning all. Minimum value is 1. |
| Filters | Collection of filter options to narrow down the alerts: |
| - Alert Type | Filter alerts by their condition type, e.g., Price Above, New 52-Week High, Daily Reminder, etc. |
| - Search | Search alerts by stock symbol or company name. |
| - Sort Direction | Order of sorting results: Ascending or Descending. |
| - Sort Field | Field to sort by: Created Date, Symbol, or Status. |
| - Status | Filter alerts by status: All, Active, Paused, or Triggered. |
Output
The output is an array of JSON objects representing the retrieved alerts. Each alert object contains details such as its ID, symbol, condition type, status, creation date, and other relevant metadata provided by the StockAlert.pro API.
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 API endpoints.
- No additional external dependencies are required beyond the configured API authentication.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Using invalid filter values may result in empty responses or errors.
- Requesting too many records without enabling "Return All" may truncate results unexpectedly.
Error messages:
- Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
- Validation errors may occur if filter parameters are malformed; ensure correct property types and allowed values.
- Network or API downtime can cause request failures; retry after some time or check API status.
Links and References
- StockAlert.pro API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes