bfx-api-node-rest

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>RESTv1 - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <script src="scripts/nav.js" defer></script> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <input type="text" id="nav-search" placeholder="Search" /> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RESTv1.html">RESTv1</a><ul class='methods'><li data-type='method'><a href="RESTv1.html#account_infos">account_infos</a></li><li data-type='method'><a href="RESTv1.html#active_credits">active_credits</a></li><li data-type='method'><a href="RESTv1.html#active_offers">active_offers</a></li><li data-type='method'><a href="RESTv1.html#active_orders">active_orders</a></li><li data-type='method'><a href="RESTv1.html#active_positions">active_positions</a></li><li data-type='method'><a href="RESTv1.html#balance_history">balance_history</a></li><li data-type='method'><a href="RESTv1.html#cancel_all_orders">cancel_all_orders</a></li><li data-type='method'><a href="RESTv1.html#cancel_multiple_orders">cancel_multiple_orders</a></li><li data-type='method'><a href="RESTv1.html#cancel_offer">cancel_offer</a></li><li data-type='method'><a href="RESTv1.html#cancel_order">cancel_order</a></li><li data-type='method'><a href="RESTv1.html#claim_position">claim_position</a></li><li data-type='method'><a href="RESTv1.html#close_swap">close_swap</a></li><li data-type='method'><a href="RESTv1.html#fundingbook">fundingbook</a></li><li data-type='method'><a href="RESTv1.html#get_symbols">get_symbols</a></li><li data-type='method'><a href="RESTv1.html#lends">lends</a></li><li data-type='method'><a href="RESTv1.html#margin_infos">margin_infos</a></li><li data-type='method'><a href="RESTv1.html#movements">movements</a></li><li data-type='method'><a href="RESTv1.html#multiple_new_orders">multiple_new_orders</a></li><li data-type='method'><a href="RESTv1.html#new_deposit">new_deposit</a></li><li data-type='method'><a href="RESTv1.html#new_offer">new_offer</a></li><li data-type='method'><a href="RESTv1.html#new_order">new_order</a></li><li data-type='method'><a href="RESTv1.html#offer_status">offer_status</a></li><li data-type='method'><a href="RESTv1.html#order_status">order_status</a></li><li data-type='method'><a href="RESTv1.html#orderbook">orderbook</a></li><li data-type='method'><a href="RESTv1.html#orders_history">orders_history</a></li><li data-type='method'><a href="RESTv1.html#past_trades">past_trades</a></li><li data-type='method'><a href="RESTv1.html#replace_order">replace_order</a></li><li data-type='method'><a href="RESTv1.html#stats">stats</a></li><li data-type='method'><a href="RESTv1.html#symbols_details">symbols_details</a></li><li data-type='method'><a href="RESTv1.html#taken_swaps">taken_swaps</a></li><li data-type='method'><a href="RESTv1.html#ticker">ticker</a></li><li data-type='method'><a href="RESTv1.html#today">today</a></li><li data-type='method'><a href="RESTv1.html#total_taken_swaps">total_taken_swaps</a></li><li data-type='method'><a href="RESTv1.html#trades">trades</a></li><li data-type='method'><a href="RESTv1.html#transfer">transfer</a></li><li data-type='method'><a href="RESTv1.html#wallet_balances">wallet_balances</a></li><li data-type='method'><a href="RESTv1.html#withdraw">withdraw</a></li></ul></li><li><a href="RESTv2.html">RESTv2</a><ul class='methods'><li data-type='method'><a href="RESTv2.html#accountFees">accountFees</a></li><li data-type='method'><a href="RESTv2.html#accountSummary">accountSummary</a></li><li data-type='method'><a href="RESTv2.html#accountTrades">accountTrades</a></li><li data-type='method'><a href="RESTv2.html#activeOrders">activeOrders</a></li><li data-type='method'><a href="RESTv2.html#activeOrdersWithIds">activeOrdersWithIds</a></li><li data-type='method'><a href="RESTv2.html#alertDelete">alertDelete</a></li><li data-type='method'><a href="RESTv2.html#alertList">alertList</a></li><li data-type='method'><a href="RESTv2.html#alertSet">alertSet</a></li><li data-type='method'><a href="RESTv2.html#calcAvailableBalance">calcAvailableBalance</a></li><li data-type='method'><a href="RESTv2.html#cancelAllFundingOffers">cancelAllFundingOffers</a></li><li data-type='method'><a href="RESTv2.html#cancelFundingOffer">cancelFundingOffer</a></li><li data-type='method'><a href="RESTv2.html#cancelOrder">cancelOrder</a></li><li data-type='method'><a href="RESTv2.html#cancelOrderMulti">cancelOrderMulti</a></li><li data-type='method'><a href="RESTv2.html#cancelOrderWithCid">cancelOrderWithCid</a></li><li data-type='method'><a href="RESTv2.html#cancelOrders">cancelOrders</a></li><li data-type='method'><a href="RESTv2.html#cancelRecurringAlgoOrder">cancelRecurringAlgoOrder</a></li><li data-type='method'><a href="RESTv2.html#candles">candles</a></li><li data-type='method'><a href="RESTv2.html#changeLogs">changeLogs</a></li><li data-type='method'><a href="RESTv2.html#claimPosition">claimPosition</a></li><li data-type='method'><a href="RESTv2.html#closeFunding">closeFunding</a></li><li data-type='method'><a href="RESTv2.html#closePosition">closePosition</a></li><li data-type='method'><a href="RESTv2.html#conf">conf</a></li><li data-type='method'><a href="RESTv2.html#currencies">currencies</a></li><li data-type='method'><a href="RESTv2.html#deleteSettings">deleteSettings</a></li><li data-type='method'><a href="RESTv2.html#derivsPositionCollateralSet">derivsPositionCollateralSet</a></li><li data-type='method'><a href="RESTv2.html#exchangeRate">exchangeRate</a></li><li data-type='method'><a href="RESTv2.html#fundingCreditHistory">fundingCreditHistory</a></li><li data-type='method'><a href="RESTv2.html#fundingCredits">fundingCredits</a></li><li data-type='method'><a href="RESTv2.html#fundingInfo">fundingInfo</a></li><li data-type='method'><a href="RESTv2.html#fundingLoanHistory">fundingLoanHistory</a></li><li data-type='method'><a href="RESTv2.html#fundingLoans">fundingLoans</a></li><li data-type='method'><a href="RESTv2.html#fundingOfferHistory">fundingOfferHistory</a></li><li data-type='method'><a href="RESTv2.html#fundingOffers">fundingOffers</a></li><li data-type='method'><a href="RESTv2.html#fundingTrades">fundingTrades</a></li><li data-type='method'><a href="RESTv2.html#futures">futures</a></li><li data-type='method'><a href="RESTv2.html#generateInvoice">generateInvoice</a></li><li data-type='method'><a href="RESTv2.html#generateToken">generateToken</a></li><li data-type='method'><a href="RESTv2.html#getCoreSettings">getCoreSettings</a></li><li data-type='method'><a href="RESTv2.html#getDepositAddress">getDepositAddress</a></li><li data-type='method'><a href="RESTv2.html#getRecurringAlgoOrder">getRecurringAlgoOrder</a></li><li data-type='method'><a href="RESTv2.html#getRecurringAlgoOrders">getRecurringAlgoOrders</a></li><li data-type='method'><a href="RESTv2.html#getRecurringAoOrders">getRecurringAoOrders</a></li><li data-type='method'><a href="RESTv2.html#getSettings">getSettings</a></li><li data-type='method'><a href="RESTv2.html#getURL">getURL</a></li><li data-type='method'><a href="RESTv2.html#getWeightedAverages">getWeightedAverages</a></li><li data-type='method'><a href="RESTv2.html#inactiveSymbols">inactiveSymbols</a></li><li data-type='method'><a href="RESTv2.html#invalidateAuthToken">invalidateAuthToken</a></li><li data-type='method'><a href="RESTv2.html#keepFunding">keepFunding</a></li><li data-type='method'><a href="RESTv2.html#keyPermissions">keyPermissions</a></li><li data-type='method'><a href="RESTv2.html#ledgers">ledgers</a></li><li data-type='method'><a href="RESTv2.html#liquidations">liquidations</a></li><li data-type='method'><a href="RESTv2.html#lnxInvoicePayments">lnxInvoicePayments</a></li><li data-type='method'><a href="RESTv2.html#logins">logins</a></li><li data-type='method'><a href="RESTv2.html#marginInfo">marginInfo</a></li><li data-type='method'><a href="RESTv2.html#marketAveragePrice">marketAveragePrice</a></li><li data-type='method'><a href="RESTv2.html#movementInfo">movementInfo</a></li><li data-type='method'><a href="RESTv2.html#movements">movements</a></li><li data-type='method'><a href="RESTv2.html#orderBook">orderBook</a></li><li data-type='method'><a href="RESTv2.html#orderHistory">orderHistory</a></li><li data-type='method'><a href="RESTv2.html#orderHistoryWithIds">orderHistoryWithIds</a></li><li data-type='method'><a href="RESTv2.html#orderMultiOp">orderMultiOp</a></li><li data-type='method'><a href="RESTv2.html#orderTrades">orderTrades</a></li><li data-type='method'><a href="RESTv2.html#payAddCurrencyConversion">payAddCurrencyConversion</a></li><li data-type='method'><a href="RESTv2.html#payCurrencyConversionList">payCurrencyConversionList</a></li><li data-type='method'><a href="RESTv2.html#payCurrencyList">payCurrencyList</a></li><li data-type='method'><a href="RESTv2.html#payDeposits">payDeposits</a></li><li data-type='method'><a href="RESTv2.html#payDepositsUnlinked">payDepositsUnlinked</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceComplete">payInvoiceComplete</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceCreate">payInvoiceCreate</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceCreatePos">payInvoiceCreatePos</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceCurrencyDetailed">payInvoiceCurrencyDetailed</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceEvents">payInvoiceEvents</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceExpire">payInvoiceExpire</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceList">payInvoiceList</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceListPaginated">payInvoiceListPaginated</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceMarkRefunded">payInvoiceMarkRefunded</a></li><li data-type='method'><a href="RESTv2.html#payInvoiceUpdate">payInvoiceUpdate</a></li><li data-type='method'><a href="RESTv2.html#payMerchantDailyLimit">payMerchantDailyLimit</a></li><li data-type='method'><a href="RESTv2.html#payMerchantSettingsList">payMerchantSettingsList</a></li><li data-type='method'><a href="RESTv2.html#payMerchantSettingsRead">payMerchantSettingsRead</a></li><li data-type='method'><a href="RESTv2.html#payMerchantSettingsWrite">payMerchantSettingsWrite</a></li><li data-type='method'><a href="RESTv2.html#payMerchantSettingsWriteBatch">payMerchantSettingsWriteBatch</a></li><li data-type='method'><a href="RESTv2.html#payPublicInvoiceCurrencyDetailed">payPublicInvoiceCurrencyDetailed</a></li><li data-type='method'><a href="RESTv2.html#payRefundInvoice">payRefundInvoice</a></li><li data-type='method'><a href="RESTv2.html#payRemoveCurrencyConversion">payRemoveCurrencyConversion</a></li><li data-type='method'><a href="RESTv2.html#performance">performance</a></li><li data-type='method'><a href="RESTv2.html#positions">positions</a></li><li data-type='method'><a href="RESTv2.html#positionsAudit">positionsAudit</a></li><li data-type='method'><a href="RESTv2.html#positionsHistory">positionsHistory</a></li><li data-type='method'><a href="RESTv2.html#positionsSnapshot">positionsSnapshot</a></li><li data-type='method'><a href="RESTv2.html#stats">stats</a></li><li data-type='method'><a href="RESTv2.html#status">status</a></li><li data-type='method'><a href="RESTv2.html#statusMessages">statusMessages</a></li><li data-type='method'><a href="RESTv2.html#submitAutoFunding">submitAutoFunding</a></li><li data-type='method'><a href="RESTv2.html#submitFundingOffer">submitFundingOffer</a></li><li data-type='method'><a href="RESTv2.html#submitOrder">submitOrder</a></li><li data-type='method'><a href="RESTv2.html#submitOrderMulti">submitOrderMulti</a></li><li data-type='method'><a href="RESTv2.html#submitRecurringAlgoOrder">submitRecurringAlgoOrder</a></li><li data-type='method'><a href="RESTv2.html#symbolDetails">symbolDetails</a></li><li data-type='method'><a href="RESTv2.html#symbols">symbols</a></li><li data-type='method'><a href="RESTv2.html#ticker">ticker</a></li><li data-type='method'><a href="RESTv2.html#tickers">tickers</a></li><li data-type='method'><a href="RESTv2.html#tickersHistory">tickersHistory</a></li><li data-type='method'><a href="RESTv2.html#trades">trades</a></li><li data-type='method'><a href="RESTv2.html#transfer">transfer</a></li><li data-type='method'><a href="RESTv2.html#updateOrder">updateOrder</a></li><li data-type='method'><a href="RESTv2.html#updateOrderMulti">updateOrderMulti</a></li><li data-type='method'><a href="RESTv2.html#updateRecurringAlgoOrder">updateRecurringAlgoOrder</a></li><li data-type='method'><a href="RESTv2.html#updateSettings">updateSettings</a></li><li data-type='method'><a href="RESTv2.html#userInfo">userInfo</a></li><li data-type='method'><a href="RESTv2.html#usesAgent">usesAgent</a></li><li data-type='method'><a href="RESTv2.html#wallets">wallets</a></li><li data-type='method'><a href="RESTv2.html#walletsHistory">walletsHistory</a></li><li data-type='method'><a href="RESTv2.html#withdraw">withdraw</a></li></ul></li></ul><h3><a href="global.html">Global</a></h3> </nav> <div id="main"> <h1 class="page-title">RESTv1</h1> <section> <header> <h2> RESTv1 </h2> <div class="class-description usertext"><p>Communicates with v1 of the Bitfinex HTTP API</p></div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="RESTv1"><span class="type-signature"></span>new RESTv1<span class="signature">(opts)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-description">Description:</dt> <dd class="tag-description"><ul class="dummy"><li><p>Instantiate a new REST v1 transport.</p></li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line13">line 13</a> </li></ul></dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>apiKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <nullable><br> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>apiSecret</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <nullable><br> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>url</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <nullable><br> </td> <td class="description last"><p>endpoint URL</p></td> </tr> <tr> <td class="name"><code>agent</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <nullable><br> </td> <td class="description last"><p>optional node agent for connection (proxy)</p></td> </tr> <tr> <td class="name"><code>nonceGenerator</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="attributes"> <nullable><br> </td> <td class="description last"><p>optional, should return a nonce</p></td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="account_infos"><span class="type-signature"></span>account_infos<span class="signature">(cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line557">line 557</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-account-info">https://docs.bitfinex.com/v1/reference#rest-auth-account-info</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="active_credits"><span class="type-signature"></span>active_credits<span class="signature">(cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line515">line 515</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-active-credits">https://docs.bitfinex.com/v1/reference#rest-auth-active-credits</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="active_offers"><span class="type-signature"></span>active_offers<span class="signature">(cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line507">line 507</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-offers">https://docs.bitfinex.com/v1/reference#rest-auth-offers</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="active_orders"><span class="type-signature"></span>active_orders<span class="signature">(cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line360">line 360</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-active-orders">https://docs.bitfinex.com/v1/reference#rest-auth-active-orders</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="active_positions"><span class="type-signature"></span>active_positions<span class="signature">(cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line376">line 376</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-active-positions">https://docs.bitfinex.com/v1/reference#rest-auth-active-positions</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="balance_history"><span class="type-signature"></span>balance_history<span class="signature">(currency, options, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line399">line 399</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-balance-history">https://docs.bitfinex.com/v1/reference#rest-auth-balance-history</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>currency</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="cancel_all_orders"><span class="type-signature"></span>cancel_all_orders<span class="signature">(cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line307">line 307</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-cancel-all-orders">https://docs.bitfinex.com/v1/reference#rest-auth-cancel-all-orders</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="cancel_multiple_orders"><span class="type-signature"></span>cancel_multiple_orders<span class="signature">(order_ids, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line316">line 316</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-cancel-multiple-orders">https://docs.bitfinex.com/v1/reference#rest-auth-cancel-multiple-orders</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>order_ids</code></td> <td class="type"> <span class="param-type">Array.<number></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="cancel_offer"><span class="type-signature"></span>cancel_offer<span class="signature">(offer_id, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line486">line 486</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-cancel-offer">https://docs.bitfinex.com/v1/reference#rest-auth-cancel-offer</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>offer_id</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="cancel_order"><span class="type-signature"></span>cancel_order<span class="signature">(order_id, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line297">line 297</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-cancel-order">https://docs.bitfinex.com/v1/reference#rest-auth-cancel-order</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>order_id</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="claim_position"><span class="type-signature"></span>claim_position<span class="signature">(position_id, amount, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line386">line 386</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-claim-position">https://docs.bitfinex.com/v1/reference#rest-auth-claim-position</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>position_id</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>amount</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="close_swap"><span class="type-signature"></span>close_swap<span class="signature">(swap_id, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line547">line 547</a> </li></ul></dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>swap_id</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="fundingbook"><span class="type-signature"></span>fundingbook<span class="signature">(currency, options, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line173">line 173</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-public-fundingbook">https://docs.bitfinex.com/v1/reference#rest-public-fundingbook</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>currency</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="get_symbols"><span class="type-signature"></span>get_symbols<span class="signature">(cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line233">line 233</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-public-symbols">https://docs.bitfinex.com/v1/reference#rest-public-symbols</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="lends"><span class="type-signature"></span>lends<span class="signature">(symbol, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line225">line 225</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-public-lends">https://docs.bitfinex.com/v1/reference#rest-public-lends</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>symbol</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="margin_infos"><span class="type-signature"></span>margin_infos<span class="signature">(cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line565">line 565</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-margin-information">https://docs.bitfinex.com/v1/reference#rest-auth-margin-information</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="movements"><span class="type-signature"></span>movements<span class="signature">(currency, options, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line417">line 417</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-deposit-withdrawal-history">https://docs.bitfinex.com/v1/reference#rest-auth-deposit-withdrawal-history</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>currency</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="multiple_new_orders"><span class="type-signature"></span>multiple_new_orders<span class="signature">(orders, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line288">line 288</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-multiple-new-orders">https://docs.bitfinex.com/v1/reference#rest-auth-multiple-new-orders</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>orders</code></td> <td class="type"> <span class="param-type">Array.<Object></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">Method</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="new_deposit"><span class="type-signature"></span>new_deposit<span class="signature">(currency, method, wallet_name, cb)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="rest1.js.html">rest1.js</a>, <a href="rest1.js.html#line454">line 454</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://docs.bitfinex.com/v1/reference#rest-auth-deposit">https://docs.bitfinex.com/v1/reference#rest-auth-deposit</a></li> </ul> </dd> </dl> <h5 class="h5-parameters">Para