-
Notifications
You must be signed in to change notification settings - Fork 0
API Alerts
Nia Mutiara edited this page Jul 29, 2013
·
1 revision
GET /api/alerts/{alertId}
Returns alert details with the following properties.
| Property Name | Description |
|---|---|
| id | ID of the Alert |
| targetPrice | Target price of the alert |
| upOrDown |
true for up, false for down |
| priceMovement | |
| active | Whether the alert is active |
| activeUntilDate |
GET /api/users/{userId}/alerts
Returns a list of alerts which are subscribed by a user. Each of the alert returned contains the same properties as "Get an Alert's Details".
POST /api/users/{userId}/alerts
Creates a new stock alert which will be subscribed by a user.
Request Parameters
| Param Name | Description |
|---|---|
| securityId | Security ID of the Alert |
| targetPrice | Target price of the alert |
| upOrDown |
true for up, false for down |
| priceMovement | |
| active | Whether the alert is active |
| activeUntilDate |
PUT /api/users/{userId}/alerts/{alertId}
Updates an existing stock alert which is subscribed by a user.
The request parameters are the same as "Create a New Subscription for a User".
GET /api/users/{userId}/alertPlans
| Property Name | Description |
|---|---|
| id | |
| costCCPerMonth | |
| numberOfAlerts | |
| productIdentifier |
POST /api/users/{userId}/alertPlans
POST /api/users/{userId}/alertPlans/restore
POST /api/users/{userId}/alertPlans/checkAlertPlanSubscription