plaid v1.7.2 Plaid.Investments.Holdings View Source

Functions for Plaid investments/holdings endpoints.

Link to this section Summary

Functions

Gets user-authorized stock position data for investment-type Accounts

Link to this section Types

Link to this type config() View Source
config() :: %{required(atom()) => String.t()}
Link to this type params() View Source
params() :: %{required(atom()) => String.t() | map()}
Link to this type t() View Source
t() :: %Plaid.Investments.Holdings{
  accounts: [Plaid.Accounts.Account.t()],
  holdings: [Plaid.Investments.Holdings.Holding.t()],
  item: Plaid.Item.t(),
  request_id: String.t(),
  securities: [Plaid.Investments.Security.t()]
}

Link to this section Functions

Link to this function get(params, config \\ %{}) View Source
get(params(), config() | nil) ::
  {:ok, Plaid.Investments.Holdings.t()} | {:error, Plaid.Error.t()}

Gets user-authorized stock position data for investment-type Accounts

Parameters

%{
  access_token: "access-env-identifier",
  options: %{
    account_ids: ["BFEWTGFD"]
  }
}