get_orders_account {charlesschwabapi}

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

tokens

token object from 'get_authentication_tokens' function (list).

account_number

encrypted ID of the account (string).

from_entered_datetime

encrypted ID of the account - default is current datetime less 60 days (string).

to_entered_datetime

specific fields to be returned - default is current datetime (string).

max_results

maximum number of results to be returned - default is NULL, which is 3000 (numeric).

status

only orders of this status should be returned. Default is NULL, which is all statuses. Valid values are "AWAITING_PARENT_ORDER", "AWAITING_CONDITION", "AWAITING_STOP_CONDITION", "AWAITING_MANUAL_REVIEW", "ACCEPTED", "AWAITING_UR_OUT", "PENDING_ACTIVATION", "QUEUED", "WORKING", "REJECTED", "PENDING_CANCEL", "CANCELED", "PENDING_REPLACE", "REPLACED", "FILLED", "EXPIRED", "NEW", "AWAITING_RELEASE_TIME", "PENDING_ACKNOWLEDGEMENT", "PENDING_RECALL", and "UNKNOWN" (string).

Value

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

Author(s)

Nick Bultman, [e-mail], July 2024