rp_getAccHist: Get History

View source: R/rPublic.R

rp_getAccHistR Documentation

Get History

Description

Get History

Usage

rp_getAccHist(accountId, start = NULL, end = NULL, pageSize = NULL)

Arguments

accountId

= Public Brokerage Account Number

start

= (Optional) Start timestamp in ISO 8601 format with timezone. Ex. "YYYY-MM-DDTHH:MM:SSZ"

end

= (Optional) End timestamp in ISO 8601 format with timezone. Ex. "YYYY-MM-DDTHH:MM:SSZ"

pageSize

= (Optional) Maximum number of records to return.

Value

Fetches a paginated data.frame of historical events for the specified account.

Examples

## Not run: 
  # Return Public Brokerage Account History
    my_acc <- rp_getAccts()
    
    # using only accountId
    my_hist <- rp_getAccHist(accountId = my_acc$accountId)
    
    # using some parameters
    my_hist <- rp_getAccHist(accountId = my_acc$accountId, 
                             start = format(Sys.time()-days(30), format="%Y-%m-%dT%H:%M:%SZ"),
                             pageSize = 20
                             )

## End(Not run)

rPublic documentation built on Aug. 23, 2025, 1:12 a.m.