Cancel Specific Order by ID for Account

Description

Given the tokens object from the 'get_authentication_tokens' function, the encrypted account ID, and the order ID, cancel the specific order.

Usage

cancel_order(tokens, account_number, order_id)

Arguments

Value

Returns a message informing the user if cancellation was successful or if there was an error.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Account Information for Specific Account

Description

Given the tokens object from the 'get_authentication_tokens' function and the encrypted account ID, return the account information (positions, fundamentals, and general account information). The encrypted account ID can be found using the 'get_account_numbers' function.

Usage

get_account(tokens, account_number, fields = NULL)

Arguments

Value

Returns a data frame containing the account information. This includes position information a day trader flag, the account number, and more.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Account Numbers

Description

Given the tokens object from the 'get_authentication_tokens' function, return the account number(s) information, including the actual account number(s) and the encrypted ID(s) of the user that were granted when authenticating. The encrypted IDs are used in other functions (like orders and transactions) that require a specific encrypted account ID to be specified.

Usage

get_account_numbers(tokens)

Arguments

Value

Returns a data frame containing the account numbers and their encrypted values.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Accounts Information

Description

Given the tokens object from the 'get_authentication_tokens' function, return the account(s) information associated with the authenticated user. By default, this includes positions, fundamentals, and general account information. However, one can use the 'fields' argument to get more specific as to the information returned.

Usage

get_accounts(tokens, fields = NULL)

Arguments

Value

Returns a data frame containing the account(s) information.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Authentication Tokens

Description

Given the app key, redirect uri, and app secret, this function will walk the user through the process to gather the appropriate authentication tokens (access token and refresh token) and store them in the user's specified location (if no location is specified, it will store the tokens in the user's working directory). Note that the tokens are saved in an RDS file via a list since additional metadata is captured in addition to the tokens (such as the expiration of those tokens to help with knowing when to refresh). After this function is initially called, be sure use the same path to the token for future calls along with maintaining the default name that is used for the RDS file to avoid manual reauthentication whenever possible. This function will always first look to see if an RDS file exists at the specified path and with the default name to check if tokens are valid or expired. Authentication requires no user intervention when the refresh token is valid. User intervention (via the login method through a separate browser) is only required when both the access token and the refresh token are expired.

Usage

get_authentication_tokens(
  app_key,
  redirect_uri,
  app_secret,
  token_save_path = getwd()
)

Arguments

Value

Returns a message on whether the authentication was successful or not along with token information (if successful, NULL otherwise), including the path to where the token RDS object is saved.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Instruments

Description

Given the tokens object from the 'get_authentication_tokens' function, the symbol(s) of interest, and the search type, return a data frame with information about the securities matching the search.

Usage

get_instruments(tokens, symbol, projection)

Arguments

Value

Returns a data frame containing information surrounding the symbol(s) of interest in the search.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Instruments by Cusip

Description

Given the tokens object from the 'get_authentication_tokens' function and a cusip, return a data frame with information about the security matching the search.

Usage

get_instruments_cusip(tokens, cusip_id)

Arguments

Value

Returns a data frame containing information surrounding the cusip of interest in the search.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Market Hours

Description

Given the tokens object from the 'get_authentication_tokens' function, return a data frame containing information about the market(s) of interest and its specific hours of operation. By default, all of the markets are returned for today's date, but both the specific markets returned and the date can be tweaked. Please see the parameters for more specifics related to what can be specified for the function.

Usage

get_market_hours(
  tokens,
  markets = c("equity", "option", "bond", "future", "forex"),
  date = NULL
)

Arguments

Value

Returns a data frame containing information surrounding the market of interest and its specific hours of operation.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Market Hours for Single Market

Description

Given the tokens object from the 'get_authentication_tokens' function and the market of interest, return specific information about that market's hours of operation. Note that a data parameter can also be specified between now and one year from now to obtain specific hours of operation for the market related to that date.

Usage

get_market_hours_single(tokens, market, date = NULL)

Arguments

Value

Returns a data frame containing information surrounding the market's hours of operation.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Movers

Description

Given the tokens object from the 'get_authentication_tokens' function and the symbol of interest, return the top 10 securities movement for a specific index in a data frame. By default, it is sorted by volume and the frequency is 0, but these can be tweaked.

Usage

get_movers(tokens, symbol_id, sort = NULL, frequency = NULL)

Arguments

Value

Returns a data frame containing information surrounding the top 10 securities movement for the symbol specified.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Option Chains

Description

Given the tokens object from the 'get_authentication_tokens' function and the symbol of interest, return a data frame containing information about the option chain. Note that there are many ways to customize the data returned, including being able to specify the strategy as analytical and providing custom input assumptions. Refer to the parameters below for more detailed information.

Usage

get_option_chains(
  tokens,
  symbol,
  contract_type = NULL,
  strike_count = NULL,
  include_underlying_quote = NULL,
  strategy = NULL,
  interval = NULL,
  strike = NULL,
  range = NULL,
  from_date = NULL,
  to_date = NULL,
  volatility = NULL,
  underlying_price = NULL,
  interest_rate = NULL,
  days_to_expiration = NULL,
  exp_month = NULL,
  option_type = NULL,
  entitlement = NULL
)

Arguments

Value

Returns a data frame containing information about the given symbol's option chain.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Option Expiration Chain

Description

Given the tokens object from the 'get_authentication_tokens' function and the symbol of interest, return the option expiration chain information related to the symbol. This includes expiration dates, expiration types, settlement types, and more.

Usage

get_option_expiration_chain(tokens, symbol)

Arguments

Value

Returns a data frame containing information surrounding the option expiration chain.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Specific Order by ID for Account

Description

Given the tokens object from the 'get_authentication_tokens' function, the encrypted account ID, and the order ID, return a data frame containing information about the specific order.

Usage

get_order_id(tokens, account_number, order_id)

Arguments

Value

Returns a data frame containing the information about the specific order.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Orders

Description

Given the tokens object from the 'get_authentication_tokens' function, return a data frame containing the orders for all accounts related to the authenticated user. By default, it will return all orders (default max is 3000) from the last 60 days. This can be adjusted through additional function parameters.

Usage

get_orders(
  tokens,
  from_entered_datetime = strftime(Sys.time() - lubridate::days(60), format =
    "%Y-%m-%dT%H:%M:%S.000Z"),
  to_entered_datetime = strftime(Sys.time(), format = "%Y-%m-%dT%H:%M:%S.000Z"),
  max_results = NULL,
  status = NULL
)

Arguments

Value

Returns a data frame containing order information for all accounts affiliated with authorized user.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Orders for Specific Account

Description

Given the tokens object from the 'get_authentication_tokens' function and the encrypted account ID, return a data frame containing the orders for the specific account. By default, it will return all orders (default max is 3000) from the last 60 days. This can be adjusted through additional function parameters.

Usage

get_orders_account(
  tokens,
  account_number,
  from_entered_datetime = strftime(Sys.time() - lubridate::days(60), format =
    "%Y-%m-%dT%H:%M:%S.000Z"),
  to_entered_datetime = strftime(Sys.time(), format = "%Y-%m-%dT%H:%M:%S.000Z"),
  max_results = NULL,
  status = NULL
)

Arguments

Value

Returns a data frame containing order information for the specified account.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Price History

Description

Given the tokens object from the 'get_authentication_tokens' function and the equity symbol of interest, return the recent price history for the symbol. There are additional parameters that can be specified to customize the call, but specific information about the default value information is given below (both in this description and the specifics on each parameter).

Usage

get_price_history(
  tokens,
  symbol,
  period_type = NULL,
  period = NULL,
  frequency_type = NULL,
  frequency = NULL,
  start_datetime = NULL,
  end_datetime = NULL,
  need_extended_hours_data = NULL,
  need_previous_close = NULL
)

Arguments

Details

While the parameter defaults for this function are NULL, the values that ultimately feed into the API call are used behind-the-scenes. For example, the period type parameter's default in the function is NULL, but behind-the-scenes the API is using "day" to grab the appropriate data.

Additionally, there are defaults for parameters that are dependent on other parameters. For the period parameter, if the period type is "day", the default period is 10, otherwise it is 1. For the frequency type parameter, if it is "day" then the default value is "minute", otherwise it is "monthly" for year and "weekly" for the others.

Value

Returns a data frame containing information surrounding the price history of the symbol of interest.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Quotes

Description

Given the tokens object from the 'get_authentication_tokens' function and the symbols of interest, return a data frame containing information about those symbols. Note that this function can return information that goes beyond a standard quote (for example, fundamental information can be returned). #' By default, everything is returned, but the specific information returned can be customized through the 'fields' argument below.

Usage

get_quotes(tokens, symbols, fields = NULL, indicative = NULL)

Arguments

Value

Returns a data frame containing information about the given symbols of interest.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Quotes for Single Symbol

Description

Given the tokens object from the 'get_authentication_tokens' function and the symbol ID, return a data frame containing information about that symbol. Note that this function can return information that goes beyond a standard quote (for example, fundamental information can be returned). By default, everything is returned, but the specific information returned can be customized through the 'fields' argument below.

Usage

get_quotes_single_symbol(tokens, symbol_id, fields = NULL)

Arguments

Value

Returns a data frame containing information about the given symbol of interest.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get Specific Transaction Information

Description

Given the tokens object from the 'get_authentication_tokens' function, the encrypted account ID of interest, and the transaction ID of interest, return information corresponding to that transaction. Note that the transaction ID can be obtained by first calling the 'get_transactions' function, finding the transaction of interest, and then finding the transaction ID on that data frame.

Usage

get_transaction(tokens, account_number, transaction_id)

Arguments

Value

Returns a data frame containing the transaction information.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Get Account Transactions

Description

Given the tokens object from the 'get_authentication_tokens' function and the encrypted account number of interest, get the transactions associated with that account number. By default, the last 180 days worth of transactions are returned. However, this can be tweaked according to the date parameters along with the types of transactions using the types parameter.

Usage

get_transactions(
  tokens,
  account_number,
  start_datetime = strftime(Sys.time() - lubridate::days(180), format =
    "%Y-%m-%dT%H:%M:%OS3Z"),
  end_datetime = strftime(Sys.time(), format = "%Y-%m-%dT%H:%M:%OS3Z"),
  symbol = NULL,
  types = NULL
)

Arguments

Value

Returns a data frame containing the account's transaction information.

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Get User Preferences

Description

Given the tokens object from the 'get_authentication_tokens' function, returns the user preferences associated with the account that was authenticated.

Usage

get_user_preferences(tokens)

Arguments

Value

Returns a data frame containing the user's preferences

Author(s)

Nick Bultman, njbultman74@gmail.com, June 2024

Place Order for Specific Account

Description

Given the tokens object from the 'get_authentication_tokens' function, the encrypted account ID, and the request body (JSON), place the specific order. Note that due to the complexity of the orders that can be created, currently this function allows maximum flexibility by not cultivating an easier solution to building the request body and assumes the user passes the appropriate JSON. As a result, it is strongly encouraged to look at the documentation for how to build the proper orders for programmatic execution and do robust testing outside of market hours to ensure that when a live trade comes it will be just as the user intended. The user of this function assumes all risk that trades could not be executed exactly as intended as the API and this package are still under active development.

Usage

place_order(tokens, account_number, request_body)

Arguments

Value

Returns a message informing the user if the order was successfully placed/created or if there was an error.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024

Replace Order for Specific Account

Description

Given the tokens object from the 'get_authentication_tokens' function, the encrypted account ID, the order ID and the request body, replace the specific order. Due to the complexity of the orders that can be created/replaced, currently this function allows maximum flexibility by not cultivating an easier solution to building the request body and assumes the user passes the appropriate JSON. Much like the 'place_order' function, it is strongly encouraged to look at the documentation (in this package and on the Charles Schwab developer site) for how to build proper orders before attempting to replace any. The user of this function assumes all risk that trades could not be replaced (and then executed) exactly as intended as the API and this package are still under active development.

Usage

replace_order(tokens, account_number, order_id, request_body)

Arguments

Value

Returns a message informing the user if the order was successfully replaced/created or if there was an error.

Author(s)

Nick Bultman, njbultman74@gmail.com, July 2024