BREAKING: Switched to https://min-api.cryptocompare.com/ API endpoint

RyanZim · RyanZim · commit 27512b9af83f · 2017-02-22T11:09:51.000-05:00
- Removed coinList()
- Changed the return value of price() &amp; priceHistorical()
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 Unreleased
 ----------
 
+Switched to https://min-api.cryptocompare.com/
+
+- removed: `coinList()`
+- changed: `price()` returns a different data structure
+- changed: `priceHistorical()` returns a different data structure
+
 0.0.2 / 2016-11-21
 ------------------
 - bug fix: `priceHistorical()` - wrong endpoint
diff --git a/README.md b/README.md
@@ -25,51 +25,53 @@ Usage
 
 ### Methods
 
-#### coinList
+### `price()`
 
-Reference: https://www.cryptocompare.com/api/#-api-data-coinlist-
+`price(fsym, tsyms, [tryConversion])`
 
-- Signature: `coinList()`
-- Parameters: (none)           
-- Returns:    A Promise function that returns contains an associative array of coins.
-
-**Example:**
+- `fsym` (String) From Symbol
+- `tsym` (Array of Strings | String) To Symbol(s)
+- `tryConversion` (Boolean) By default, if the crypto does not trade directly into the toSymbol requested, BTC will be used for conversion. Set `tryConversion` to `false` to disable using BTC for conversion.
 
 ```js
-var cc = require('cryptocompare')
-cc.coinList()
-.then(coinList => {
-  console.dir(coinList.BTC)
-})
-.catch(console.error.bind(console)
-```
+const cc = require('cryptocompare')
 
-**Outputs:**
+// Basic Usage:
+cc.price('BTC', ['USD', 'EUR'])
+.then(prices => {
+  console.log(prices)
+  // -> { USD: 1100.24, EUR: 1039.63 }
+})
+.catch(console.error)
 
-```
-{ Id: '1182',
-  Url: '/coins/btc/overview',
-  ImageUrl: '/media/19633/btc.png',
-  Name: 'BTC',
-  CoinName: 'Bitcoin',
-  FullName: 'Bitcoin (BTC)',
-  Algorithm: 'SHA256',
-  ProofType: 'PoW',
-  FullyPremined: '0',
-  TotalCoinSupply: '21000000',
-  PreMinedValue: 'N/A',
-  TotalCoinsFreeFloat: 'N/A',
-  SortOrder: '1' }
+// Passing a single pair of currencies:
+cc.price('BTC', 'USD')
+.then(prices => {
+  console.log(prices)
+  // -> { USD: 1100.24 }
+})
+.catch(console.error)
 ```
 
-### price
+### priceHistorical
 
-Reference: https://www.cryptocompare.com/api/#-api-data-price-
+`priceHistorical(fsym, tsyms, time)`
 
+- `fsym` (String) From Symbol
+- `tsym` (Array of Strings | String) To Symbol(s)
+- `time` (Date) Date in history that you want price data for
 
-### priceHistorical
+```js
+const cc = require('cryptocompare')
 
-https://www.cryptocompare.com/api/#-api-data-pricehistorical-
+// Basic Usage:
+cc.priceHistorical('BTC', ['USD', 'EUR'], new Date('2017-01-01'))
+.then(prices => {
+  console.log(prices)
+  // -> { BTC: { USD: 997, EUR: 948.17 } }
+})
+.catch(console.error)
+```
 
 
 
diff --git a/index.js b/index.js
@@ -1,38 +1,32 @@
 'use strict'
 /* global fetch */
 
-const baseUrl = 'https://www.cryptocompare.com/api/data/'
+const baseUrl = 'https://min-api.cryptocompare.com/data/'
 
 function fetchJSON (url) {
   return fetch(url)
     .then(res => res.json())
     .then(body => {
-      // 'response' is a CryptoCompare field
-      if (body.Response !== 'Success') throw new Error(body.Message)
-      return body.Data
+      if (body.Response === 'Error') throw body.Message
+      return body
     })
 }
 
-function coinList () {
-  let url = `${baseUrl}coinlist/`
-  return fetchJSON(url)
-}
-
-function price (fsym, tsyms, useBtc) {
+function price (fsym, tsyms, tryConversion) {
   let url = `${baseUrl}price?fsym=${fsym}&tsyms=${tsyms}`
-  if (useBtc) url += 'usebtc=true'
+  if (tryConversion === false) url += '&tryConversion=false'
   return fetchJSON(url)
 }
 
 function priceHistorical (fsym, tsyms, time) {
   if (!(time instanceof Date)) throw new Error('time parameter must be an instance of Date.')
   time = Math.floor(time.getTime() / 1000)
   let url = `${baseUrl}pricehistorical?fsym=${fsym}&tsyms=${tsyms}&ts=${time}`
-  return fetchJSON(url)
+  // The API returns json with an extra layer of nesting, so remove it
+  return fetchJSON(url).then(result => result[fsym])
 }
 
 module.exports = {
-  coinList,
   price,
   priceHistorical
 }
diff --git a/test/cryptocompare.test.js b/test/cryptocompare.test.js
@@ -5,34 +5,49 @@ const test = require('tape')
 global.fetch = require('node-fetch')
 const cc = require('../')
 
-test('coinList()', t => {
+test('price()', t => {
+  t.plan(2)
+  cc.price('BTC', ['USD', 'EUR']).then(prices => {
+    t.strictEqual(typeof prices.USD, 'number', 'prices.USD is a number')
+    t.strictEqual(typeof prices.EUR, 'number', 'prices.EUR is a number')
+    t.end()
+  }).catch(t.end)
+})
+
+test('price() allows passing a string as the second parameter', t => {
   t.plan(1)
-  cc.coinList().then(coinList => {
-    t.strictEqual(coinList.BTC.CoinName, 'Bitcoin', 'CoinName field should be Bitcoin')
+  cc.price('BTC', 'USD').then(prices => {
+    t.strictEqual(typeof prices.USD, 'number', 'prices.USD is a number')
+    t.end()
   }).catch(t.end)
 })
 
-test('price()', t => {
-  t.plan(4)
-  cc.price('BTC', ['USD', 'CNY']).then(prices => {
-    t.strictEqual(prices[0].Symbol, 'USD', 'prices[0].Symbol === USD')
-    t.strictEqual(typeof prices[0].Price, 'number', 'prices[0].Price is a number')
-    t.strictEqual(prices[1].Symbol, 'CNY')
-    t.strictEqual(typeof prices[1].Price, 'number')
+test("price()'s tryConversion=false works", t => {
+  cc.price('LTD', 'USD', false).then(prices => {
+    t.end('Promise should not resolve')
+  }).catch(e => {
+    t.ok(e, 'Converting LTD to USD fails')
     t.end()
   }).catch(t.end)
 })
 
 test('priceHistorical()', t => {
-  t.plan(5)
-  // Arbitrary timestamp; historical values are hard-coded into this test
-  const timestamp = new Date(1456149600 * 1000)
-  cc.priceHistorical('BTC', ['USD', 'CNY'], timestamp).then(prices => {
-    t.strictEqual(prices[0].Symbol, 'USD', 'prices[0].Symbol === USD')
-    t.strictEqual(typeof prices[0].Price, 'number', 'prices[0].Price is a number')
-    t.is(prices[0].Price, 438.26)
-    t.strictEqual(prices[1].Symbol, 'CNY')
-    t.strictEqual(typeof prices[1].Price, 'number')
+  t.plan(3)
+  // NOTE: Historical values are hard-coded into this test
+  const timestamp = new Date('2017-01-01')
+  cc.priceHistorical('BTC', ['USD', 'EUR'], timestamp).then(prices => {
+    t.strictEqual(typeof prices.USD, 'number', 'prices.USD is a number')
+    t.is(prices.USD, 997, 'Correct historical value')
+    t.strictEqual(typeof prices.EUR, 'number', 'prices.EUR is a number')
+    t.end()
+  }).catch(t.end)
+})
+
+test('error handling', t => {
+  cc.price('BTC').then(prices => {
+    t.end('Promise should not resolve')
+  }).catch(e => {
+    t.ok(e, 'Errors')
     t.end()
   }).catch(t.end)
 })
