CryptoWatch

CryptoWatch Wrapper for cryptowat.ch api

Kind: global class

• CryptoWatch
  • .allowance()
  • .assets()
  • .asset(name)
  • .pairs()
  • .pair(name)
  • .exchanges([active])
  • .exchange(name)
  • .markets([exchange])
  • .market(exchange, pair)
  • .price(market, pair)
  • .prices()
  • .summary(market, pair)
  • .summaries()
  • .trades(market, pair, params)
  • .orderbook(market, pair)
  • .OHLC(market, pair, params)

cryptoWatch.allowance()

Gets remaining api allowance.

Kind: instance method of CryptoWatch

cryptoWatch.assets()

Gets all assets (crypto or fiat currency).

Kind: instance method of CryptoWatch

cryptoWatch.asset(name)

Gets an asset's information.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | name | String |

cryptoWatch.pairs()

Gets currency pairs info.

Kind: instance method of CryptoWatch

cryptoWatch.pair(name)

Gets info for a currency pair.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | name | String |

cryptoWatch.exchanges([active])

Gets info for all the exchanges.

Kind: instance method of CryptoWatch

| Param | Type | Default | Description | | --- | --- | --- | --- | | [active] | Boolean | true | If true, only return active exchanges |

cryptoWatch.exchange(name)

Gets info for an exchange.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | name | String |

cryptoWatch.markets([exchange])

Gets info for markets. Optionally specify a single exchange.

Kind: instance method of CryptoWatch

| Param | Type | Description | | --- | --- | --- | | [exchange] | String | Optional. Supply a specific exchange to get markets for |

cryptoWatch.market(exchange, pair)

Gets info for a market given an exchange and pair.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | exchange | String | | pair | String |

cryptoWatch.price(market, pair)

Returns price for a given market and currency pair.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | market | String | | pair | String |

cryptoWatch.prices()

Aggregate endpoint that returns the current price for all supported markets. Somes values may be out of date by a few seconds as results are cached.

Kind: instance method of CryptoWatch

cryptoWatch.summary(market, pair)

Returns summary for a given market and currency pair.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | market | String | | pair | String |

cryptoWatch.summaries()

Aggregate endpoint that returns the market summary for all supported markets. Some values may be out of date by a few seconds as results are cached.

Kind: instance method of CryptoWatch

cryptoWatch.trades(market, pair, params)

Returns trades for a given market and currency pair.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | market | String | | pair | String | | params | Object |

cryptoWatch.orderbook(market, pair)

Returns the orderbook for a given market and currency pair.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | market | String | | pair | String |

cryptoWatch.OHLC(market, pair, params)

Returns a market’s OHLC candlestick data. Returns data as lists of lists of numbers for each time period integer.

Kind: instance method of CryptoWatch

| Param | Type | | --- | --- | | market | String | | pair | String | | params | Object |