22[ ![ Build Status] ( https://travis-ci.org/bausmeier/node-bitx.png )] ( https://travis-ci.org/bausmeier/node-bitx )
33[ ![ codecov] ( https://codecov.io/gh/bausmeier/node-bitx/branch/master/graph/badge.svg )] ( https://codecov.io/gh/bausmeier/node-bitx )
44
5- A simple wrapper for the BitX API.
5+ A simple wrapper for the Luno API.
66
77## Usage
88Add bitx as a dependency:
@@ -12,21 +12,21 @@ $ npm install --save bitx
1212```
1313
1414### BitX([ keyId, keySecret, ] [ options ] )
15- To access the private BitX API methods you must supply your key id and key secret as the first two arguments. If you are only accessing the public API endpoints you can leave these two arguments out.
15+ To access the private Luno API methods you must supply your key id and key secret as the first two arguments. If you are only accessing the public API endpoints you can leave these two arguments out.
1616
1717The optional options argument can be used to override the default options. The default options are equivalent to:
1818
1919``` javascript
2020{
21- hostname: ' api.mybitx .com' ,
21+ hostname: ' api.luno .com' ,
2222 port: 443 ,
2323 ca: undefined ,
2424 pair: ' XBTZAR'
2525}
2626```
2727
2828## Methods
29- For details about the API endpoints see https://api.mybitx .com/api .
29+ For details about the API endpoints see https://www.luno .com/en/developers /api .
3030
3131### Callbacks
3232The arguments passed to the callback function for each method are:
@@ -35,7 +35,7 @@ The arguments passed to the callback function for each method are:
35351 . An object containing the data returned by the BitX API.
3636
3737### getTicker([ options, ] callback)
38- GET https://api.mybitx .com/api/1/ticker
38+ GET https://api.luno .com/api/1/ticker/XBTZAR
3939
4040Default options:
4141
@@ -52,7 +52,7 @@ bitx.getTicker(function(err, ticker) {});
5252```
5353
5454### getAllTickers(callback)
55- GET https://api.mybitx .com/api/1/tickers
55+ GET https://api.luno .com/api/1/tickers
5656
5757Example:
5858
@@ -61,7 +61,7 @@ bitx.getAllTickers(function(err, tickers) {});
6161```
6262
6363### getOrderBook([ options, ] callback)
64- GET https://api.mybitx .com/api/1/orderbook
64+ GET https://api.luno .com/api/1/orderbook
6565
6666Default options:
6767
@@ -78,7 +78,7 @@ bitx.getOrderBook(function(err, orderBook) {});
7878```
7979
8080### getTrades([ options, ] callback)
81- GET https://api.mybitx .com/api/1/trades
81+ GET https://api.luno .com/api/1/trades
8282
8383Default options:
8484
@@ -95,7 +95,7 @@ bitx.getTrades(function(err, trades) {});
9595```
9696
9797### getTradeList([ options, ] callback)
98- GET https://api.mybitx .com/api/1/listtrades
98+ GET https://api.luno .com/api/1/listtrades
9999
100100Default options:
101101
@@ -112,7 +112,7 @@ bitx.getTradeList({sort_desc: true, limit: 10}, function(err, tradeList) {});
112112```
113113
114114### getOrderList([ options, ] callback)
115- GET https://api.mybitx .com/api/1/listorders
115+ GET https://api.luno .com/api/1/listorders
116116
117117Default options:
118118
@@ -130,7 +130,7 @@ bitx.getOrderList({state: 'PENDING'}, function(err, orderList) {});
130130```
131131
132132### getBalance([ asset, ] callback)
133- GET https://api.mybitx .com/api/1/balance
133+ GET https://api.luno .com/api/1/balance
134134
135135Example:
136136
@@ -139,7 +139,7 @@ bitx.getBalance('ZAR', function(err, balance) {});
139139```
140140
141141### getFundingAddress(asset, [ options, ] callback)
142- GET https://api.mybitx .com/api/1/funding_address
142+ GET https://api.luno .com/api/1/funding_address
143143
144144Default options:
145145
@@ -156,7 +156,7 @@ bitx.getFundingAddress('XBT', {address: 'B1tC0InExAMPL3fundIN6AdDreS5t0Use'}, fu
156156```
157157
158158### createFundingAddress(asset, callback)
159- POST https://api.mybitx .com/api/1/funding_address
159+ POST https://api.luno .com/api/1/funding_address
160160
161161Example:
162162
@@ -165,7 +165,7 @@ bitx.createFundingAddress('XBT', function(err, fundingAddress) {});
165165```
166166
167167### getFeeInfo([ options, ] callback)
168- GET https://api.mybitx .com/api/1/fee_info
168+ GET https://api.luno .com/api/1/fee_info
169169
170170Default options:
171171
@@ -182,7 +182,7 @@ bitx.getFeeInfo({pair: 'XBTZAR'}, function(err, feeInfo) {});
182182```
183183
184184### postBuyOrder(volume, price, [ options, ] callback)
185- POST https://api.mybitx .com/api/1/postorder
185+ POST https://api.luno .com/api/1/postorder
186186
187187Example:
188188
@@ -191,7 +191,7 @@ bitx.postBuyOrder(9999.99, 0.01, function(err, order) {});
191191```
192192
193193### postSellOrder(volume, price, [ options, ] callback)
194- POST https://api.mybitx .com/api/1/postorder
194+ POST https://api.luno .com/api/1/postorder
195195
196196Example:
197197
@@ -200,7 +200,7 @@ bitx.postSellOrder(0.01, 9999.99, function(err, order) {});
200200```
201201
202202### postMarketBuyOrder(volume, [ options, ] callback)
203- POST https://api.mybitx .com/api/1/marketorder
203+ POST https://api.luno .com/api/1/marketorder
204204
205205Example:
206206
@@ -209,7 +209,7 @@ bitx.postMarketBuyOrder(0.01, function(err, order) {});
209209```
210210
211211### postMarketSellOrder(volume, [ options, ] callback)
212- POST https://api.mybitx .com/api/1/marketorder
212+ POST https://api.luno .com/api/1/marketorder
213213
214214Example:
215215
@@ -218,7 +218,7 @@ bitx.postMarketSellOrder(0.01, function(err, order) {});
218218```
219219
220220### stopOrder(orderId, callback)
221- POST https://api.mybitx .com/api/1/stoporder
221+ POST https://api.luno .com/api/1/stoporder
222222
223223Example:
224224
@@ -227,7 +227,7 @@ bitx.stopOrder('BXMC2CJ7HNB88U4', function(err, result) {});
227227```
228228
229229### getOrder(orderId, callback)
230- GET https://api.mybitx .com/api/1/orders/{orderId}
230+ GET https://api.luno .com/api/1/orders/{orderId}
231231
232232Example:
233233
@@ -236,7 +236,7 @@ bitx.getOrder('BXHW6PFRRXKFSB4', function(err, result) {});
236236```
237237
238238### getTransactions(asset, [ options, ] callback)
239- GET https://api.mybitx .com/api/1/transactions
239+ GET https://api.luno .com/api/1/transactions
240240
241241Default options:
242242``` javascript
@@ -253,7 +253,7 @@ bitx.getTransactions('XBT', {offset: 5, limit: 20}, function(err, transactions)
253253```
254254
255255### getWithdrawals(callback)
256- GET https://api.mybitx .com/api/1/withdrawals
256+ GET https://api.luno .com/api/1/withdrawals
257257
258258Example:
259259
@@ -262,7 +262,7 @@ bitx.getWithdrawals(function(err, withdrawals) {});
262262```
263263
264264### getWithdrawal(withdrawalId, callback)
265- GET https://api.mybitx .com/api/1/withdrawals/{withdrawalId}
265+ GET https://api.luno .com/api/1/withdrawals/{withdrawalId}
266266
267267Example:
268268
@@ -271,7 +271,7 @@ bitx.getWithdrawal('1212', function(err, withdrawal) {});
271271```
272272
273273### requestWithdrawal(type, amount, callback)
274- POST https://api.mybitx .com/api/1/withdrawals
274+ POST https://api.luno .com/api/1/withdrawals
275275
276276Example:
277277
@@ -280,7 +280,7 @@ bitx.requestWithdrawal('ZAR_EFT', 1000, function(err, withdrawal) {});
280280```
281281
282282### cancelWithdrawal(withdrawalId, callback)
283- DELETE https://api.mybitx .com/api/1/withdrawals/{withdrawalId}
283+ DELETE https://api.luno .com/api/1/withdrawals/{withdrawalId}
284284
285285Example:
286286
0 commit comments