PlaidEx.API.Investments (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Investments API — holdings, transactions, and securities.

Summary

Functions

get_holdings(config, access_token, opts \\ [])

Returns all investment holdings (positions) for an Item.

get_transactions(config, access_token, start_date, end_date, opts \\ [])

Returns investment transactions for an Item over a date range.

refresh(config, value, opts \\ [])

Refreshes investment data for an Item.

Functions

get_holdings(config, access_token, opts \\ [])

@spec get_holdings(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok,
   %{
     holdings: [PlaidEx.Schemas.InvestmentHolding.t()],
     securities: [PlaidEx.Schemas.Security.t()]
   }}
  | {:error, PlaidEx.Error.t()}

Returns all investment holdings (positions) for an Item.

get_transactions(config, access_token, start_date, end_date, opts \\ [])

@spec get_transactions(
  PlaidEx.Config.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Returns investment transactions for an Item over a date range.

refresh(config, value, opts \\ [])

@spec refresh(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Refreshes investment data for an Item.