cryptomarket
Advanced tools
cryptomarket - npm Package Compare versions
Comparing version 1.0.2 to 1.0.3
@@ -26,2 +26,3 @@ /* eslint-disable no-param-reassign */ | ||
| this.boardData = {}; | ||
| this.transports = ['websocket', 'polling']; | ||
| } | ||
@@ -49,2 +50,3 @@ | ||
| reconnectionDelayMax: 15000, | ||
| transports: this.transports, | ||
| }); | ||
@@ -439,3 +441,11 @@ } | ||
| connect() { | ||
| connect(...transports) { | ||
| if (!_.isEmpty(transports)) { | ||
| this.transports = transports.filter( | ||
| (transport) => transport === 'polling' || transport === 'websocket', | ||
| ); | ||
| if (_.isEmpty(this.transports)) { | ||
| return Promise.reject(new Error('Invalid transports')); | ||
| } | ||
| } | ||
| this.socketClient = socket(this.urlWorker, { | ||
@@ -446,2 +456,3 @@ forceNew: false, | ||
| reconnectionDelayMax: 15000, | ||
| transports: this.transports, | ||
| }); | ||
@@ -452,4 +463,2 @@ | ||
| // GENERAL METHODS | ||
| // =============================================================================== | ||
| return new Promise((resolve, reject) => { | ||
@@ -456,0 +465,0 @@ // Fired upon a connection including a successful reconnection. |
| { | ||
| "name": "cryptomarket", | ||
| "version": "1.0.2", | ||
| "version": "1.0.3", | ||
| "description": "The CryptoMarket for Node.js", | ||
@@ -5,0 +5,0 @@ "homepage": "https://www.cryptomkt.com", |
113
README.md
@@ -63,3 +63,4 @@ # cryptomkt-node | ||
| ```javascript | ||
| //Any of the 3 ways to call the function should return an output like this | ||
| // Any of the 3 ways to call the function should return an output like this: | ||
| response: { | ||
@@ -87,5 +88,3 @@ status: 'success', | ||
| const data = obj.data; | ||
| data.forEach((market) => { | ||
| console.log(data); | ||
| }); | ||
| console.log(data); | ||
| }).catch((err) => { | ||
@@ -111,4 +110,6 @@ console.error(err); | ||
| ```javascript | ||
| //receives a Js object. "market" and "side" are mandatory (ex: {"market": "XLMCLP","side":"sell"}). | ||
| client.getBook(dictionary, (err, output) => { | ||
| // Receives a Js object. "market" and "side" are mandatory. | ||
| // Example: {"market": "XLMCLP", "side": "sell"} | ||
| client.getBook(object, (err, output) => { | ||
| if(err){ | ||
@@ -150,8 +151,11 @@ console.log('error'); | ||
| ... | ||
| ] | ||
| ] | ||
| ``` | ||
| **Obtain ticker info** | ||
| ```javascript | ||
| //receives a Js object that contains the market. (ex: {"market":"XLMARS"}) | ||
| client.getTicker(market, (err, output) => { | ||
| // Receives a Js object that contains the market. | ||
| // Example: {"market": "XLMARS"} | ||
| client.getTicker(object, (err, output) => { | ||
| if(err){ | ||
@@ -231,6 +235,12 @@ console.log('error'); | ||
| ``` | ||
| **Create an order** | ||
| ```javascript | ||
| //receives a Js object. "market","type","side" and "amount" are mandatory. (ex: {"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "limit", "side": "sell"}). | ||
| client.createOrder(order, (err, output) => { | ||
| // Receives a Js object. "market", "type", "side" and "amount" are mandatory. | ||
| // (Example: {"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "limit", "side": "sell"} | ||
| // Note that "side" can be either "sell" or "buy", also "type" can be "limit", "stop-limit" or "market". | ||
| // If you want to execute an "stop-limit" order you need to specify the "limit" amount. | ||
| // Example: {"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "stop-limit", "limit": 50, "side": "sell"} | ||
| client.createOrder(object, (err, output) => { | ||
| if(err){ | ||
@@ -266,4 +276,6 @@ console.log('error'); | ||
| ```javascript | ||
| //receives object array that contains multiple orders. "market","type","side" and "amount" are mandatory. (ex: [{"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "limit", "side": "sell"},{Order2},...]). | ||
| client.createMultiOrders(orders, (err, output) => { | ||
| // Receives object array that contains multiple orders. "market", "type", "side" and "amount" are mandatory. | ||
| // Example: [{"amount": 1, "market": "XLMCLP", "price": 50.5, "type": "limit", "side": "sell"}, {Order2},...] | ||
| client.createMultiOrders(object, (err, output) => { | ||
| if(err){ | ||
@@ -278,6 +290,6 @@ console.log('error'); | ||
| response: { | ||
| status: 'success', | ||
| data: { | ||
| created: [{Order1},{Order2},...], | ||
| not_created: [] | ||
| status: 'success', | ||
| data: { | ||
| created: [{Order1},{Order2},...], | ||
| not_created: [] | ||
| } | ||
@@ -289,4 +301,6 @@ } | ||
| ```javascript | ||
| //receives a Js object that contains the market (ex: {"market":"XLMCLP"}) | ||
| client.getActiveOrders(market, (err, output) => { | ||
| // Receives a Js object that contains the market | ||
| // Example: {"market":"XLMCLP"} | ||
| client.getActiveOrders(object, (err, output) => { | ||
| if(err){ | ||
@@ -341,4 +355,6 @@ console.log('error'); | ||
| ```javascript | ||
| //receives object that contains the order's ID (ex: {"id":"O000004"}). | ||
| client.cancelOrder(order, (err, output) => { | ||
| // Receives object that contains the order's ID. | ||
| // Example: {"id":"O000004"} | ||
| client.cancelOrder(object, (err, output) => { | ||
| if(err){ | ||
@@ -370,6 +386,9 @@ console.log('error'); | ||
| ``` | ||
| **Cancel multiple orders** | ||
| ```javascript | ||
| //receives object array that contains multiple order's IDs (ex: [{"id":"O000001"},{"id":"O000002"},...]). | ||
| client.cancelMultiOrders(orders, (err, output) => { | ||
| // Receives object array that contains multiple order's IDs. | ||
| // Example: [{"id":"O000001"},{"id":"O000002"},...] | ||
| client.cancelMultiOrders(object, (err, output) => { | ||
| if(err){ | ||
@@ -385,8 +404,12 @@ console.log('error'); | ||
| status: 'success', | ||
| data: { canceled: [{Order1},{Order2},...], not_canceled: [] } } | ||
| data: { canceled: [{Order1},{Order2},...], not_canceled: [] } | ||
| } | ||
| ``` | ||
| **Make a transfer** | ||
| ```javascript | ||
| //receives a Js object. "currency", "address", and "amount" are mandatory. (ex: {"currency":'ETH',"address":'0xf2ec...',"amount":0.02}). | ||
| client.transfer(transfer, (err, output) => { | ||
| // Receives a Js object. "currency", "address", and "amount" are mandatory. | ||
| // Example: {"currency": "ETH", "address": "0xf2ec...", "amount": 0.02} | ||
| client.transfer(object, (err, output) => { | ||
| if(err){ | ||
@@ -397,3 +420,2 @@ console.log('error'); | ||
| }); | ||
| ``` | ||
@@ -407,4 +429,6 @@ ***Expected output*** | ||
| ```javascript | ||
| //receives a Js object that contains the market (ex: {"market":"XLMCLP"}) | ||
| client.getExecutedOrders(market, (err, output) => { | ||
| // Receives a Js object that contains the market. | ||
| // Example: {"market":"XLMCLP"} | ||
| client.getExecutedOrders(object, (err, output) => { | ||
| if(err){ | ||
@@ -450,4 +474,6 @@ console.log('error'); | ||
| ```javascript | ||
| //receives a Js object that contains the ID (ex: {"id":"O000005"}) | ||
| client.getOrderStatus(id, (err, output) => { | ||
| // Receives a Js object that contains the ID. | ||
| // Example: {"id":"O000005"} | ||
| client.getOrderStatus(object, (err, output) => { | ||
| if(err){ | ||
@@ -491,3 +517,2 @@ console.log('error'); | ||
| ``` | ||
| ***Expected Output*** | ||
@@ -516,2 +541,4 @@ ```javascript | ||
| Cryptomarket's API v2 integrates Socket.IO! You can now receive real-time events connecting to the sockets. | ||
| ### Get socket instance | ||
@@ -524,2 +551,3 @@ | ||
| var socket; | ||
| client.socket.connect() | ||
@@ -534,3 +562,3 @@ .then((skt) => { | ||
| var socket= await client.socket.connect(); | ||
| var socket = await client.socket.connect(); | ||
| ``` | ||
@@ -552,3 +580,4 @@ | ||
| ```javascript | ||
| // Subscription required* | ||
| // Subscription required. | ||
| socket.on('open-book', (data) => { | ||
@@ -574,3 +603,4 @@ console.log('open-book', data); | ||
| ```javascript | ||
| // Subscription required* | ||
| // Subscription required. | ||
| socket.on('historical-book', (data) => { | ||
@@ -624,3 +654,4 @@ console.log('historical-book', data); | ||
| ```javascript | ||
| // Subscription required* | ||
| // Subscription required. | ||
| socket.on('candles', (data) => { | ||
@@ -697,3 +728,3 @@ console.log('candles', data); | ||
| **Receive balance info** | ||
| **Receive Your Balance info** | ||
| ```javascript | ||
@@ -723,3 +754,3 @@ socket.on('balance', (data) => { | ||
| **Receive user orders info** | ||
| **Receive Your Orders info** | ||
| ```javascript | ||
@@ -753,3 +784,3 @@ socket.on('open-orders', (data) => { | ||
| **Receive historical user orders info** | ||
| **Receive Your Historical orders info** | ||
| ```javascript | ||
@@ -760,3 +791,2 @@ socket.on('historical-orders', (data) => { | ||
| ``` | ||
| ***Expected Output*** | ||
@@ -802,4 +832,3 @@ ```javascript | ||
| **Receive UserĀ“s operated volume** | ||
| **Receive Your operated volume** | ||
| ```javascript | ||
@@ -806,0 +835,0 @@ socket.on('operated', (data) => { |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.37%
58406
- Lines of code
- increased by0.92%
985
- Number of lines in readme file
- increased by3.65%
824