AlpacaElixir v2.2.0 Alpaca.Client View Source

Client responsible for making requests to Alpaca and handling the responses.

This client allows us to define all of our HTTP request logic and configuration in one place so that we can easily change or adapt this away from all of the other business logic of our library.

We have access to HTTP request types on this client and it will automatically use a base url as well as set all the necessary headers for us.

We have access to GET, POST, PATCH, and DELETE HTTP requests using this client.

Example usage

Alpaca.Client.get("/path", %{query_param: "value"})
Alpaca.Client.post("/path", %{param1: "value"})
Alpaca.Client.patch("/path", %{param1: "value"})
Alpaca.Client.delete("/path")

Link to this section Summary

Functions

api_host()

client_id(env_key \\ :client_id)

client_secret(env_key \\ :client_secret)

data_api_host()

delete(path, opts \\ [])

Issue a delete request using the HTTP client

get(path, params \\ %{}, opts \\ [])

Issue a get request using the HTTP client

patch(path, params \\ %{}, opts \\ [])

Issue a patch request using the HTTP client

post(path, params \\ %{}, opts \\ [])

Issue a post request using the HTTP client

put(path, params \\ %{}, opts \\ [])

Issue a put request using the HTTP client

Link to this section Functions

api_host()

Specs

api_host() :: String.t()

client_id(env_key \\ :client_id)

Specs

client_id(atom()) :: String.t()

client_secret(env_key \\ :client_secret)

Specs

client_secret(atom()) :: String.t()

data_api_host()

Specs

data_api_host() :: String.t()

delete(path, opts \\ [])

Issue a delete request using the HTTP client

Accepts path which is the url path of the request, will be added to the end of the base_url

get(path, params \\ %{}, opts \\ [])

Issue a get request using the HTTP client

Accepts path which is the url path of the request, will be added to the end of the base_url and a map of params which will become the query list for the get request

patch(path, params \\ %{}, opts \\ [])

Issue a patch request using the HTTP client

Accepts path which is the url path of the request, will be added to the end of the base_url and a map of params which will be the body of the post request

post(path, params \\ %{}, opts \\ [])

Issue a post request using the HTTP client

Accepts path which is the url path of the request, will be added to the end of the base_url and a map of params which will be the body of the post request

put(path, params \\ %{}, opts \\ [])

Issue a put request using the HTTP client

Accepts path which is the url path of the request, will be added to the end of the base_url and a map of params which will be the body of the post request