Skip to content

Commit

Permalink
fetchWithdrawals docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
samgermain committed Jun 6, 2022
1 parent b6c4a22 commit 6e39647
Show file tree
Hide file tree
Showing 64 changed files with 640 additions and 0 deletions.
10 changes: 10 additions & 0 deletions js/aax.js
Original file line number Diff line number Diff line change
Expand Up @@ -2230,6 +2230,16 @@ module.exports = class aax extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name aax#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the aax api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
const request = {
// status Not required : "0: Under Review, 1: Manual Review, 2: On Chain, 3: Review Failed, 4: On Chain, 5: Completed, 6: Failed"
Expand Down
10 changes: 10 additions & 0 deletions js/ascendex.js
Original file line number Diff line number Diff line change
Expand Up @@ -2156,6 +2156,16 @@ module.exports = class ascendex extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name ascendex#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the ascendex api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
const request = {
'txType': 'withdrawal',
};
Expand Down
10 changes: 10 additions & 0 deletions js/bibox.js
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,16 @@ module.exports = class bibox extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bibox#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bibox api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
if (limit === undefined) {
limit = 100;
Expand Down
10 changes: 10 additions & 0 deletions js/bigone.js
Original file line number Diff line number Diff line change
Expand Up @@ -1299,6 +1299,16 @@ module.exports = class bigone extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bigone#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bigone api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
const request = {
// 'page_token': 'dxzef', // request page after this page token
Expand Down
10 changes: 10 additions & 0 deletions js/binance.js
Original file line number Diff line number Diff line change
Expand Up @@ -3485,6 +3485,16 @@ module.exports = class binance extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name binance#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the binance api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
const legalMoney = this.safeValue (this.options, 'legalMoney', {});
const request = {};
Expand Down
10 changes: 10 additions & 0 deletions js/bitbns.js
Original file line number Diff line number Diff line change
Expand Up @@ -957,6 +957,16 @@ module.exports = class bitbns extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bitbns#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bitbns api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
if (code === undefined) {
throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires a currency code argument');
}
Expand Down
10 changes: 10 additions & 0 deletions js/bitflyer.js
Original file line number Diff line number Diff line change
Expand Up @@ -750,6 +750,16 @@ module.exports = class bitflyer extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bitflyer#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bitflyer api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
let currency = undefined;
const request = {};
Expand Down
10 changes: 10 additions & 0 deletions js/bitmart.js
Original file line number Diff line number Diff line change
Expand Up @@ -2332,6 +2332,16 @@ module.exports = class bitmart extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bitmart#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bitmart api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
return await this.fetchTransactionsByType ('withdraw', code, since, limit, params);
}

Expand Down
10 changes: 10 additions & 0 deletions js/bitopro.js
Original file line number Diff line number Diff line change
Expand Up @@ -1373,6 +1373,16 @@ module.exports = class bitopro extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bitopro#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bitopro api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
if (code === undefined) {
throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires the code argument');
}
Expand Down
10 changes: 10 additions & 0 deletions js/bitpanda.js
Original file line number Diff line number Diff line change
Expand Up @@ -1116,6 +1116,16 @@ module.exports = class bitpanda extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bitpanda#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bitpanda api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
const request = {
// 'cursor': 'string', // pointer specifying the position from which the next pages should be returned
Expand Down
10 changes: 10 additions & 0 deletions js/bitrue.js
Original file line number Diff line number Diff line change
Expand Up @@ -1514,6 +1514,16 @@ module.exports = class bitrue extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bitrue#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bitrue api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
if (code === undefined) {
throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires a code argument');
}
Expand Down
10 changes: 10 additions & 0 deletions js/bitstamp.js
Original file line number Diff line number Diff line change
Expand Up @@ -1307,6 +1307,16 @@ module.exports = class bitstamp extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bitstamp#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bitstamp api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
const request = {};
if (since !== undefined) {
Expand Down
10 changes: 10 additions & 0 deletions js/bittrex.js
Original file line number Diff line number Diff line change
Expand Up @@ -1295,6 +1295,16 @@ module.exports = class bittrex extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bittrex#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bittrex api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
// https://support.bittrex.com/hc/en-us/articles/115003723911
const request = {};
Expand Down
10 changes: 10 additions & 0 deletions js/bitvavo.js
Original file line number Diff line number Diff line change
Expand Up @@ -1455,6 +1455,16 @@ module.exports = class bitvavo extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bitvavo#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bitvavo api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
const request = {
// 'symbol': currency['id'],
Expand Down
10 changes: 10 additions & 0 deletions js/bkex.js
Original file line number Diff line number Diff line change
Expand Up @@ -875,6 +875,16 @@ module.exports = class bkex extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bkex#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bkex api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
if (code === undefined) {
throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires code argument');
}
Expand Down
10 changes: 10 additions & 0 deletions js/blockchaincom.js
Original file line number Diff line number Diff line change
Expand Up @@ -863,6 +863,16 @@ module.exports = class blockchaincom extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name blockchaincom#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the blockchaincom api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
const request = {
// 'from' : integer timestamp in ms
Expand Down
10 changes: 10 additions & 0 deletions js/btcalpha.js
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,16 @@ module.exports = class btcalpha extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name btcalpha#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the btcalpha api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
let currency = undefined;
const request = {};
Expand Down
10 changes: 10 additions & 0 deletions js/btcmarkets.js
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,16 @@ module.exports = class btcmarkets extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name btcmarkets#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str|undefined} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the btcmarkets api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
return await this.fetchTransactionsWithMethod ('privateGetWithdrawals', code, since, limit, params);
}

Expand Down
10 changes: 10 additions & 0 deletions js/buda.js
Original file line number Diff line number Diff line change
Expand Up @@ -955,6 +955,16 @@ module.exports = class buda extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name buda#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the buda api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
if (code === undefined) {
throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires a currency code argument');
Expand Down
10 changes: 10 additions & 0 deletions js/bw.js
Original file line number Diff line number Diff line change
Expand Up @@ -1302,6 +1302,16 @@ module.exports = class bw extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bw#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bw api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
if (code === undefined) {
throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires a currency code argument');
}
Expand Down
10 changes: 10 additions & 0 deletions js/bybit.js
Original file line number Diff line number Diff line change
Expand Up @@ -3911,6 +3911,16 @@ module.exports = class bybit extends Exchange {
}

async fetchWithdrawals (code = undefined, since = undefined, limit = undefined, params = {}) {
/**
* @method
* @name bybit#fetchWithdrawals
* @description fetch all withdrawals made from an account
* @param {str} code unified currency code
* @param {int|undefined} since the earliest time in ms to fetch withdrawals for
* @param {int|undefined} limit the maximum number of withdrawals structures to retrieve
* @param {dict} params extra parameters specific to the bybit api endpoint
* @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure}
*/
await this.loadMarkets ();
const request = {
// 'coin': currency['id'],
Expand Down
Loading

0 comments on commit 6e39647

Please sign in to comment.