AlpacaElixir v2.2.0 Alpaca.Account.Configuration View Source

A resource that allows us to query an Account Configuration from Alpaca

Link to this section Summary

Functions

Edit your Alpaca trading account configuration info

Retrieve your Alpaca trading account configuration info

Link to this section Functions

Edit your Alpaca trading account configuration info

Example

iex> {:ok, %{} = account_config} = Alpaca.Account.Configuration.edit(%{trade_confirm_email: "none"})

Allows us to edit our own account configuration info and return the new configuration as a result tuple {:ok, %{}} if successful. If not success we will get back a result tuple {:error, {status: http_status_code, body: http_response_body}}

Specs

get() :: {:ok, map()} | {:error, map()}

Retrieve your Alpaca trading account configuration info

Example

iex> {:ok, %{} = account_config} = Alpaca.Account.Configuration.get()

Allows us to retrieve our own account configuration info as a result tuple {:ok, %{}} if successful. If not success we will get back a result tuple {:error, {status: http_status_code, body: http_response_body}}