Skip to content
This repository has been archived by the owner on May 1, 2018. It is now read-only.

Adding jsdoc comments #119

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 77 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ By default the returned data is an object, in order to get clear text you have t

The baseUrl itself can also be set via options
```javascript
'baseUrl' : 'https://bittrex.com/api/v1',
'baseUrl' : 'https://bittrex.com/api/v1.1',
'baseUrlv2' : 'https://bittrex.com/Api/v2.0',
```

Expand Down Expand Up @@ -405,79 +405,129 @@ will result in (the Header is being set too):
https://bittrex.com/api/v1.1/account/getbalances?currency=BTC&apikey=API_KEY&nonce=4456490600
```

##### getticker
##### getmarkets()
```javascript
bittrex.getticker( { market : 'BTC-LTC' }, function( data, err ) {
bittrex.getmarkets( function( data, err ) {
console.log( data );
});
```

##### getbalances
##### getcurrencies()
```javascript
bittrex.getbalances( function( data, err ) {
bittrex.getcurrencies( function( data, err ) {
console.log( data );
});
```

##### getmarkethistory
##### getticker()
```javascript
bittrex.getmarkethistory({ market : 'BTC-LTC' }, function( data, err ) {
bittrex.getticker( { market : 'BTC-LTC' }, function( data, err ) {
console.log( data );
});
```

##### getmarketsummaries
##### getmarketsummaries()
```javascript
bittrex.getmarketsummaries( function( data, err ) {
console.log( data );
});
```

##### getmarketsummary
##### getmarketsummary()
```javascript
bittrex.getmarketsummary( { market : 'BTC-LTC'}, function( data, err ) {
console.log( data );
});
```

##### getorderbook
##### getorderbook()
```javascript
bittrex.getorderbook({ market : 'BTC-LTC', depth : 10, type : 'both' }, function( data, err ) {
console.log( data );
});
```

##### getwithdrawalhistory
##### getmarkethistory()
```javascript
bittrex.getmarkethistory({ market : 'BTC-LTC' }, function( data, err ) {
console.log( data );
});
```
##### buylimit()
```javascript
bittrex.buylimit({market: 'BTC-LTC', quantity: '100', rate: '.0015'}, function( data, err ) {
console.log( data );
});
```
##### buymarket()
```javascript
bittrex.buymarket({market: 'BTC-LTC', quantity: '100'}, function( data, err ) {
console.log( data );
});
```
##### selllimit()
```javascript
bittrex.selllimit({market: 'BTC-LTC', quantity: '100', rate: '.0015'}, function( data, err ) {
console.log( data );
});
```
##### sellmarket()
```javascript
bittrex.sellmarket({market: 'BTC-LTC', quantity: '100'}, function( data, err ) {
console.log( data );
});
```
##### cancel()
```javascript
bittrex.cancel({uuid: 'EE50BC5B-E9A1-478A-BEB6-F73023ABD069'}, function( data, err ) {
console.log( data );
});
```
##### getopenorders()
```javascript
bittrex.getopenorders({market: 'USDT-BTC'}, function( data, err ) {
console.log( data );
});
```
##### getbalances()
```javascript
bittrex.getbalances( function( data, err ) {
console.log( data );
});
```
##### getbalance()
```javascript
bittrex.getbalance({ currency : 'BTC' }, function( data, err ) {
console.log( data );
});
```
##### getwithdrawalhistory()
```javascript
bittrex.getwithdrawalhistory({ currency : 'BTC' }, function( data, err ) {
console.log( data );
});
```

##### getdepositaddress
##### getdepositaddress()
```javascript
bittrex.getdepositaddress({ currency : 'BTC' }, function( data, err ) {
console.log( data );
});
```

##### getdeposithistory
##### getdeposithistory()
```javascript
bittrex.getdeposithistory({ currency : 'BTC' }, function( data, err ) {
console.log( data );
});
```

##### getbalance
##### getorderhistory()
```javascript
bittrex.getbalance({ currency : 'BTC' }, function( data, err ) {
bittrex.getorderhistory({market: 'USDT-BTC'}, function( data, err ) {
console.log( data );
});
```

##### withdraw
##### getorder()
```javascript
bittrex.getorder({uuid: 'EE50BC5B-E9A1-478A-BEB6-F73023ABD069'}, function( data, err ) {
console.log( data );
});
```
##### withdraw()
```javascript
bittrex.withdraw({ currency : 'BTC', quantity : '1.5112', address : 'THE_ADDRESS' }, function( data, err ) {
bittrex.withdraw({ currency : 'BTC', quantity : '1.5112', address : 'THE_ADDRESS' }, function(
console.log( data );
});
```
Expand Down
Loading