diff --git a/README.md b/README.md index 9876928..e13498f 100644 --- a/README.md +++ b/README.md @@ -278,11 +278,11 @@ options = { } ``` -`api.getTransactionsByID(transactionID)` +`api.getTransactionByID(transactionID)` > transactionID = integer > -`api.getTransactionByIDRange(options)` +`api.getTransactionsByIDRange(options)` ```javascript options = { to: integer, @@ -291,6 +291,6 @@ options = { } ``` -`api.getTransactionSinceID(transactionID)` +`api.getTransactionsSinceID(transactionID)` > transactionID = integer > \ No newline at end of file diff --git a/lib/endpoints/instruments.js b/lib/endpoints/instruments.js index b8df0f8..505794d 100644 --- a/lib/endpoints/instruments.js +++ b/lib/endpoints/instruments.js @@ -14,7 +14,7 @@ const Instruments = {} dailyAlignment: int, alignmentTimezone: string, weeklyAlignment: string - } + } */ Instruments.getCandles = function (instrument, options) { let url = this.baseURL + `instruments/${instrument}/candles` + this.formatQuery(options) @@ -33,15 +33,15 @@ Instruments.getOrderBook = function (options) { return axios.get(url, this.header) } -/*GET REQUEST for instrument's positionbook +/* GET REQUEST for instrument's positionbook options = { instrument: 'string' (e.g. 'USD_CAD') - time: 'dateTime' DEFAULT: most recent time (e.g. 2016-06-22T18:41:36.201836422Z) or as UNIX depending on config + time: 'dateTime' DEFAULT: most recent time (e.g. 2016-06-22T18:41:36.201836422Z) or as UNIX depending on config } */ Instruments.getPositionBook = function (options) { let url = this.baseURL + `instruments/${options.instrument}/positionBook` - url += this.formatQuery(options.time) + url += this.formatTime(options.time) return axios.get(url, this.header) }