etrader (version 0.1.5)

etrd_alert_detail: ETrade Alert Details

Description

Get the details for a specific alert based on the alert ID

Usage

etrd_alert_detail(
  alertId,
  access_tokens = NULL,
  etrade_cred = NULL,
  sandbox = FALSE
)

Value

the alert details in list form

Arguments

alertId

An alert id that comes from etrd_alerts

access_tokens

Access tokens are created using etrd_auth_access_token. This entry is not required because the output is saved and retrieved from R options automatically.

etrade_cred

The output created from etrd_auth_credentials when a valid ETRADE key and secret have been passed. This entry is not required because the output is saved and retrieved from R options automatically.

sandbox

ETRADE offers a sandbox environment for validating API calls and responses. If using the sandbox environment, this must be set to TRUE in each function called throughout etrader. ETRADE states "Sandbox responses use stored data that's intended to provide typical responses for basic use cases. So the responses you receive will not contain current data, and may not exactly match your requests in other ways." Essentially, the responses will not match the requests entered but successful pull will indicate whether the entry was valid or not.

Examples

if (FALSE) {

# Get an alert detail for a specific account and alert
account_id = etrd_account_list()$accountIdKey[1]
alert_id = etrd_alerts(account_id)$id[1]
etrd_alert_detail(alert_id)

}