alpha_vantage_api_wrapper - npm Package Compare versions

Comparing version 0.0.13 to 0.0.14

lib/Forex.js

@@ -97,3 +97,3 @@ "use strict";
             }
-            this.setRequiredOptions(options, 'FX_DAILY', baseCurrency, destinationCurrency);
+            this.setRequiredOptions(options, 'FX_WEEKLY', baseCurrency, destinationCurrency);
             axios_1.default.get(this._alpha._url, {
@@ -120,3 +120,3 @@ params: options
             }
-            this.setRequiredOptions(options, 'FX_DAILY', baseCurrency, destinationCurrency);
+            this.setRequiredOptions(options, 'FX_MONTHLY', baseCurrency, destinationCurrency);
             axios_1.default.get(this._alpha._url, {
@@ -123,0 +123,0 @@ params: options

lib/index.js

@@ -6,2 +6,3 @@ "use strict";
 const Forex_1 = require("./Forex");
+const Crypto_1 = require("./Crypto");
 class Alpha {
@@ -18,2 +19,3 @@ /**
         this.forex = new Forex_1.Forex(this);
+        this.crypto = new Crypto_1.Crypto(this);
     }
@@ -20,0 +22,0 @@ hasApiKey() {

package.json

 {
   "name": "alpha_vantage_api_wrapper",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Alpha Vintage API Wrapper for Node.Js",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

 # Alpha Vantage API - Node.js Wrapper [![Build Status](https://travis-ci.org/travis-ci/travis-web.svg?branch=master)](https://travis-ci.org/travis-ci/travis-web)
 This is a simple wrapper package for the Alpha Vantage API<br>
-For now it only works for Stocks, Forex & Sectors.
+Stocks, Forex, Crypto & Sector API are working.
 
+*Technical indicators - work in progress*
+
 * [Instalation](#instalation)
@@ -23,2 +25,7 @@ * [Usage](#usage)
     * [Monthly](#fx-monthly)
+* [Crypto](#crypto-api)
+    * [Exchange Rates](#crypto-exchange-rates)
+    * [Daily](#crypto-daily)
+    * [Weekly](#crypto-weekly)
+    * [Monthly](#crypto-monthly)
 * [Sector](#sector-api)
@@ -193,3 +200,3 @@ * [Performance](#performance)
 # Forex API
-## Fx Echange Rates
+## Fx Exchange Rates
 This API returns the realtime exchange rate for any pair of digital currency (e.g., Bitcoin) or physical currency (e.g., USD).
@@ -260,3 +267,54 @@ ```js
 
+# Crypto API
+## Crypto Exchange Rates
+This API returns the realtime exchange rate for any pair of digital currency (e.g., Bitcoin) or physical currency (e.g., USD).
+```js
+alpha.crypto.exchageRate(baseCurrency, destinationCurrency)
+```
 
+## Crypto Daily
+This API returns the daily historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD.
+
+
+
+Available options = **object**
+```javascript
+{
+    "datatype": "json" || "csv",
+}
+```
+
+```js
+alpha.crypto.daily(baseCurrency, destinationCurrency, options = optional)
+```
+
+## Crypto Weekly
+This API returns the weekly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD.
+
+Available options = **object**
+```javascript
+{
+    "datatype": "json" || "csv",
+}
+```
+
+```js
+alpha.crypto.weekly(baseCurrency, destinationCurrency, options = optional)
+```
+
+## Crypto Monthly
+This API returns the monthly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC). Prices and volumes are quoted in both the market-specific currency and USD.
+
+Available options = **object**
+```javascript
+{
+    "datatype": "json" || "csv",
+}
+```
+
+```js
+alpha.crypto.monthly(baseCurrency, destinationCurrency, options = optional)
+```
+
+
 # Sector API
@@ -263,0 +321,0 @@ ## Performance

src/Forex.ts

@@ -99,3 +99,3 @@ import { Alpha } from './index'
 
-            this.setRequiredOptions(options, 'FX_DAILY', baseCurrency, destinationCurrency);
+            this.setRequiredOptions(options, 'FX_WEEKLY', baseCurrency, destinationCurrency);
 
@@ -123,3 +123,3 @@ axios.get(this._alpha._url, {
 
-            this.setRequiredOptions(options, 'FX_DAILY', baseCurrency, destinationCurrency);
+            this.setRequiredOptions(options, 'FX_MONTHLY', baseCurrency, destinationCurrency);
 
@@ -126,0 +126,0 @@ axios.get(this._alpha._url, {

src/index.ts

 import { Stocks } from './Stocks'
 import { Sector } from './Sector';
 import { Forex } from './Forex';
+import { Crypto } from './Crypto'
 
@@ -11,2 +12,3 @@ export class Alpha {
   forex: Forex;
+  crypto: Crypto;
   
@@ -23,2 +25,3 @@
     this.forex = new Forex(this);
+    this.crypto = new Crypto(this)
   }
@@ -25,0 +28,0 @@

No alert changes

Improved metrics

Total package byte prevSize

86412

increased by11.9%

Number of package files

20

increased by11.11%

Lines of code

1114

increased by20.3%

Number of lines in readme file

322

increased by21.97%

No dependency changes