View Source ExTrade.Accounts (ExTrade v0.0.1)

Interface to the E*TRADE Accounts API.

Link to this section Summary

Link to this section Functions

Link to this function

get_account_balance(account_id_key, opts \\ [])

View Source
@spec get_account_balance(String.t(), Keyword.t()) ::
  {:ok, ExTrade.Accounts.Balance.t()} | ExTrade.Response.error_t()

Retrieve a given ExTrade.Accounts.Account's ExTrade.Accounts.Balance via the Get Account Balances endpoint.

Optional Query Parameters

  • :acount_type
  • :real_time_nav
@spec list_accounts() ::
  {:ok, [ExTrade.Accounts.Account.t()]} | ExTrade.Response.error_t()

Retrieve a list of ExTrade.Accounts.Accounts via the List Accounts endpoint.

Link to this function

list_transaction_details(account_id_key, transaction_id, opts \\ [])

View Source
@spec list_transaction_details(String.t(), integer(), Keyword.t()) ::
  {:ok, ExTrade.Accounts.TransactionDetails.t()} | ExTrade.Response.error_t()

Retrieve a given ExTrade.Accounts.Transaction's ExTrade.Accounts.TransactionDetails via the List Transaction Details endpoint.

Optional Query Parameters

  • :store_id
Link to this function

list_transactions(account_id_key, opts \\ [])

View Source
@spec list_transactions(String.t(), Keyword.t()) ::
  {:ok, [ExTrade.Accounts.Transaction.t()]} | ExTrade.Response.error_t()

Retrieve a given ExTrade.Accounts.Account's list of ExTrade.Accounts.Transactions via the List Transactions endpoint.

Optional Query Parameters

  • :count
  • :end_date
  • :marker
  • :sort_order
  • :start_date
Link to this function

view_portfolio(account_id_key, opts \\ [])

View Source

Retrieve a given ExTrade.Accounts.Account's ExTrade.Accounts.Portfolio via the View Portfolio endpoint.

Optional Query Parameters

  • :count
  • :lots_required
  • :market_session
  • :sort_by
  • :sort_order
  • :totals_required
  • :view