AlpacaElixir v0.1.7 Alpaca.Account View Source

A resource that allows us to query an Account from Alpaca

Link to this section Summary

Functions

Retrieve your Alpaca trading account info

Link to this section Functions

Specs

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

Retrieve your Alpaca trading account info

Example

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

Allows us to retrieve our own account information 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}}