Price Alerts
Price Alerts are user-configured triggers that notify when a stock or instrument reaches a specific price or meets certain market conditions.
Once an alert is triggered, you can get the notification in the General WebSocket.
Each alert compares the last traded price, or the open, high, low or close price, of an instrument with a target value you set. An alert is enabled, disabled or triggered, and a triggered or expired alert can no longer be modified or switched on and off. Use these APIs to create, change, pause, list and delete alerts from your own app.
| Endpoint | Method | Description |
|---|---|---|
| Create Price Alert | POST | This API allows you to create a price alert for an instrument. |
| Get Price Alerts | GET | This API allows you to fetch your price alerts by alert name or alert ID, with their current status. |
| Modify Price Alert | PUT | This API allows you to modify an existing price alert. |
| Delete Price Alert | DELETE | This API allows you to delete a price alert. |
| Enable / Disable Price Alert | PUT | This API allows you to switch a price alert between enabled and disabled. |
Last updated on