Packages

A lightweight Elixir wrapper for the Alpha Vantage API.

Current section

4 Versions

Jump to

Compare versions

7 files changed
+12 additions
-12 deletions
  @@ -7,12 +7,12 @@ A lightweight Elixir wrapper for the [Alpha Vantage API](https://www.alphavantag
7 7
8 8 ## Installation
9 9
10 - Add :alpha_vantage to your depency list in the `mix.exs` file.
10 + Add `:alpha_vantage` to your depency list in the `mix.exs` file.
11 11
12 12 ```elixir
13 13 def deps do
14 14 [
15 - {:alpha_vantage, "~> 0.1"}
15 + {:alpha_vantage, "~> 0.2"}
16 16 ]
17 17 end
18 18 ```
  @@ -219,7 +219,7 @@ iex> AlphaVantage.SectorPerformances.sector()
219 219
220 220 ## A Note on Tests
221 221
222 - Currently, the API key limitations have resulted in very little test coverage. Hopefully, we will be able to resolve this in the near future. In the meantime, please open issues for any problems encountered and we will look to address as promptly as possible.
222 + Currently, the free API key limitation of 5 requests per minute prevent the test suite from being run in its entirety, so please note that it is often easiest to run specific tests.
223 223
224 224 ## Contributing
  @@ -18,7 +18,7 @@
18 18 <<".formatter.exs">>,<<"mix.exs">>,<<"README.md">>,<<"LICENSE">>]}.
19 19 {<<"licenses">>,[<<"MIT">>]}.
20 20 {<<"links">>,
21 - [{<<"GitHub">>,<<"https://github.com/Cameron-Kurth/elixir-alpha_vantage">>}]}.
21 + [{<<"GitHub">>,<<"https://github.com/Cameron-Kurth/elixir_alpha_vantage">>}]}.
22 22 {<<"name">>,<<"alpha_vantage">>}.
23 23 {<<"requirements">>,
24 24 [[{<<"app">>,<<"jason">>},
  @@ -31,4 +31,4 @@
31 31 {<<"optional">>,false},
32 32 {<<"repository">>,<<"hexpm">>},
33 33 {<<"requirement">>,<<"~> 1.6">>}]]}.
34 - {<<"version">>,<<"0.2.0">>}.
34 + {<<"version">>,<<"0.2.1">>}.
  @@ -94,7 +94,7 @@ defmodule AlphaVantage.Cryptocurrencies do
94 94 - `:interval`
95 95
96 96 Time interval between two consecutive data points in the time series.
97 - The following values are supported and accepted as strings: `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"60min"`, `"daily"`, `"weekly"`, `"monthly"`
97 + The following values are supported and accepted as strings: `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"60min"`
98 98
99 99 _Optional_ (accepted as a keyword list)
  @@ -72,7 +72,7 @@ defmodule AlphaVantage.Forex do
72 72 - `:interval`
73 73
74 74 Time interval between two consecutive data points in the time series.
75 - The following values are supported and accepted as strings: `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"60min"`, `"daily"`, `"weekly"`, `"monthly"`
75 + The following values are supported and accepted as strings: `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"60min"`
76 76
77 77 _Optional_ (accepted as a keyword list)
  @@ -25,7 +25,7 @@ defmodule AlphaVantage.StockTimeSeries do
25 25 - `:interval`
26 26
27 27 Time interval between two consecutive data points in the time series.
28 - The following values are supported and accepted as strings: `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"60min"`, `"daily"`, `"weekly"`, `"monthly"`
28 + The following values are supported and accepted as strings: `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"60min"`
29 29
30 30 _Optional_ (accepted as a keyword list)
31 31
  @@ -70,7 +70,7 @@ defmodule AlphaVantage.StockTimeSeries do
70 70 - `:interval`
71 71
72 72 Time interval between two consecutive data points in the time series.
73 - The following values are supported and accepted as strings: `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"60min"`, `"daily"`, `"weekly"`, `"monthly"`
73 + The following values are supported and accepted as strings: `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"60min"`
74 74
75 75 - `:slice`
Loading more files…