Class used to get InvestmentTransactions for the Investments product.

Sections
Namespace
Methods
G
Public
Instance Public methods
get(access_token, start_date, end_date, account_ids: nil, count: nil, offset: nil, options: nil)

Get information about all available investment transactions.

Does a POST /investments/transactions/get call which gives you high level account data along with investment transactions and associated securities from all investment accounts contained in the access_token's item.

access_token

access_token who's item to get investment transactions for.

start_date

Start of query for investment transactions.

end_date

End of query for investment transactions.

account_ids

Specific account ids to fetch transactions for (optional).

count

Amount of investment transactions to pull (optional).

offset

Offset to start pulling investment transactions (optional).

options

Additional options to merge into API request.

Returns

Returns GetResponse.

# File lib/plaid/products/investments.rb, line 22
def get(access_token, start_date, end_date,
        account_ids: nil, count: nil, offset: nil, options: nil)

  options_payload = {}
  options_payload[:account_ids] = account_ids unless account_ids.nil?
  options_payload[:count] = count unless count.nil?
  options_payload[:offset] = offset unless offset.nil?
  options_payload.merge!(options) unless options.nil?

  post_with_auth 'investments/transactions/get',
                 GetResponse,
                 access_token: access_token,
                 start_date: Plaid.convert_to_date_string(start_date),
                 end_date: Plaid.convert_to_date_string(end_date),
                 options: options_payload
end