cryptowatch-api
Advanced tools
Comparing version 0.1.0 to 0.1.1
| { | ||
| "name": "cryptowatch-api", | ||
| "version": "0.1.0", | ||
| "version": "0.1.1", | ||
| "description": "Cryptowatch api wrapper", | ||
| "main": "cryptowatch.js", | ||
| "scripts": { | ||
| "generate-docs": "node_modules/.bin/jsdoc2md index.js > README.md", | ||
| "generate-docs": "node_modules/.bin/jsdoc2md cryptowatch.js > README.md", | ||
| "test": "jest" | ||
@@ -9,0 +9,0 @@ }, |
@@ -10,3 +10,2 @@ <a name="CryptoWatch"></a> | ||
| * [CryptoWatch](#CryptoWatch) | ||
| * [.request()](#CryptoWatch+request) | ||
| * [.allowance()](#CryptoWatch+allowance) | ||
@@ -25,16 +24,10 @@ * [.assets()](#CryptoWatch+assets) | ||
| * [.summaries()](#CryptoWatch+summaries) | ||
| * [.trades(market, pair)](#CryptoWatch+trades) | ||
| * [.trades(market, pair, params)](#CryptoWatch+trades) | ||
| * [.orderbook(market, pair)](#CryptoWatch+orderbook) | ||
| * [.OHLC(market, pair)](#CryptoWatch+OHLC) | ||
| * [.OHLC(market, pair, params)](#CryptoWatch+OHLC) | ||
| <a name="CryptoWatch+request"></a> | ||
| ### cryptoWatch.request() | ||
| Request helper function | ||
| **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| <a name="CryptoWatch+allowance"></a> | ||
| ### cryptoWatch.allowance() | ||
| Get remaining api allowance | ||
| Gets remaining api allowance. | ||
@@ -45,3 +38,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.assets() | ||
| Get all assets (crypto or fiat currency) | ||
| Gets all assets (crypto or fiat currency). | ||
@@ -52,3 +45,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.asset(name) | ||
| Get an asset information | ||
| Gets an asset's information. | ||
@@ -64,3 +57,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.pairs() | ||
| Gets crypto pairs info | ||
| Gets currency pairs info. | ||
@@ -71,3 +64,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.pair(name) | ||
| Gets info for a pair | ||
| Gets info for a currency pair. | ||
@@ -83,3 +76,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.exchanges([active]) | ||
| Gets info for all the exchanges | ||
| Gets info for all the exchanges. | ||
@@ -95,3 +88,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.exchange(name) | ||
| Gets an exchange info | ||
| Gets info for an exchange. | ||
@@ -107,3 +100,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.markets([exchange]) | ||
| Gets info for markets | ||
| Gets info for markets. Optionally specify a single exchange. | ||
@@ -119,3 +112,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.market(exchange, pair) | ||
| Gets info for a market given an exchange and pair | ||
| Gets info for a market given an exchange and pair. | ||
@@ -132,3 +125,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.price(market, pair) | ||
| Returns price for a given market and currency pair | ||
| Returns price for a given market and currency pair. | ||
@@ -147,3 +140,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| markets. Somes values may be out of date by a few seconds as results | ||
| are cached | ||
| are cached. | ||
@@ -154,3 +147,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.summary(market, pair) | ||
| Returns summary for a given market and currency pair | ||
| Returns summary for a given market and currency pair. | ||
@@ -174,4 +167,4 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.trades(market, pair) | ||
| Returns trades for a given market and currency pair | ||
| ### cryptoWatch.trades(market, pair, params) | ||
| Returns trades for a given market and currency pair. | ||
@@ -184,2 +177,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| | pair | <code>String</code> | | ||
| | params | <code>Object</code> | | ||
@@ -189,3 +183,3 @@ <a name="CryptoWatch+orderbook"></a> | ||
| ### cryptoWatch.orderbook(market, pair) | ||
| Returns the orderbook for a given market and currency pair | ||
| Returns the orderbook for a given market and currency pair. | ||
@@ -201,3 +195,3 @@ **Kind**: instance method of [<code>CryptoWatch</code>](#CryptoWatch) | ||
| ### cryptoWatch.OHLC(market, pair) | ||
| ### cryptoWatch.OHLC(market, pair, params) | ||
| Returns a market’s OHLC candlestick data. Returns data as lists of lists | ||
@@ -212,2 +206,3 @@ of numbers for each time period integer. | ||
| | pair | <code>String</code> | | ||
| | params | <code>Object</code> | | ||
Fixed alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Number of medium supply chain risk alerts
- decreased by-100%
0
Worsened metrics
- Total package byte prevSize
- decreased by-0.18%
12287
- Number of lines in readme file
- decreased by-2.55%
191