## RESTv2 Communicates with v2 of the Bitfinex HTTP API **Kind**: global class * [RESTv2](#RESTv2) * [new RESTv2(opts)](#new_RESTv2_new) * [.ticker(symbol, cb)](#RESTv2+ticker) ⇒ Promise * [.tickers(symbols, cb)](#RESTv2+tickers) ⇒ Promise * [.stats(key, context, cb)](#RESTv2+stats) ⇒ Promise * [.candles(opts, cb)](#RESTv2+candles) ⇒ Promise * [.alertList(type, cb)](#RESTv2+alertList) ⇒ Promise * [.alertSet(type, symbol, price)](#RESTv2+alertSet) ⇒ Promise * [.alertDelete(symbol, price)](#RESTv2+alertDelete) ⇒ Promise * [.trades(symbol, start, end, limit, cb)](#RESTv2+trades) ⇒ Promise * [.wallets(cb)](#RESTv2+wallets) ⇒ Promise * [.activeOrders(cb)](#RESTv2+activeOrders) ⇒ Promise * [.orderHistory(symbol, start, end, limit, cb)](#RESTv2+orderHistory) ⇒ Promise * [.orderTrades(symbol, start, end, limit, orderID, cb)](#RESTv2+orderTrades) ⇒ Promise * [.positions(cb)](#RESTv2+positions) ⇒ Promise * [.fundingOffers(symbol, cb)](#RESTv2+fundingOffers) ⇒ Promise * [.fundingOfferHistory(symbol, start, end, limit, cb)](#RESTv2+fundingOfferHistory) ⇒ Promise * [.fundingLoans(symbol, cb)](#RESTv2+fundingLoans) ⇒ Promise * [.fundingLoanHistory(symbol, start, end, limit, cb)](#RESTv2+fundingLoanHistory) ⇒ Promise * [.fundingCredits(symbol, cb)](#RESTv2+fundingCredits) ⇒ Promise * [.fundingCreditHistory(symbol, start, end, limit, cb)](#RESTv2+fundingCreditHistory) ⇒ Promise * [.fundingTrades(symbol, start, end, limit, cb)](#RESTv2+fundingTrades) ⇒ Promise * [.marginInfo(key, cb)](#RESTv2+marginInfo) ⇒ Promise * [.fundingInfo(key, cb)](#RESTv2+fundingInfo) ⇒ Promise * [.performance(cb)](#RESTv2+performance) ⇒ Promise * [.calcAvailableBalance(symbol, dir, rate, type, cb)](#RESTv2+calcAvailableBalance) ⇒ Promise * ~~[.symbols(cb)](#RESTv2+symbols) ⇒ Promise~~ * ~~[.symbolDetails(cb)](#RESTv2+symbolDetails) ⇒ Promise~~ * ~~[.accountInfo(cb)](#RESTv2+accountInfo) ⇒ Promise~~ * ~~[.accountFees(cb)](#RESTv2+accountFees) ⇒ Promise~~ * ~~[.accountSummary(cb)](#RESTv2+accountSummary) ⇒ Promise~~ * ~~[.deposit(params, cb)](#RESTv2+deposit) ⇒ Promise~~ * ~~[.withdraw(params, cb)](#RESTv2+withdraw) ⇒ Promise~~ * ~~[.transfer(params, cb)](#RESTv2+transfer) ⇒ Promise~~ * ~~[.keyPermissions(cb)](#RESTv2+keyPermissions) ⇒ Promise~~ * ~~[.balances(cb)](#RESTv2+balances) ⇒ Promise~~ * ~~[.claimPosition(params, cb)](#RESTv2+claimPosition) ⇒ Promise~~ ### new RESTv2(opts) Instantiate a new REST v2 transport. | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.apiKey | string | | | opts.apiSecret | string | | | opts.url | string | endpoint URL | | opts.transform | boolean | default false | | opts.agent | Object | optional node agent for connection (proxy) | ### resTv2.ticker(symbol, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-public-ticker | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | cb | Method | | ### resTv2.tickers(symbols, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-public-tickers | Param | Type | | --- | --- | | symbols | Array.<string> | | cb | Method | ### resTv2.stats(key, context, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-public-stats | Param | Type | Default | | --- | --- | --- | | key | string | "pos.size:1m:tBTCUSD:long" | | context | string | "hist" | | cb | Method | | ### resTv2.candles(opts, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: http://docs.bitfinex.com/v2/reference#rest-public-candles | Param | Type | Description | | --- | --- | --- | | opts | Object | | | opts.timeframe | string | 1m, 5m, 15m, 30m, 1h, 3h, 6h, 12h, 1D, 7D, 14D, 1M | | opts.symbol | string | | | opts.section | string | hist, last | | cb | Method | | ### resTv2.alertList(type, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-alert-list | Param | Type | Default | | --- | --- | --- | | type | string | "price" | | cb | Method | | ### resTv2.alertSet(type, symbol, price) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-alert-set | Param | Type | Default | | --- | --- | --- | | type | string | "price" | | symbol | string | "tBTCUSD" | | price | number | 0 | ### resTv2.alertDelete(symbol, price) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-alert-delete | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | price | number | 0 | ### resTv2.trades(symbol, start, end, limit, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-trades-hist | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | start | number | | | end | number | | | limit | number | | | cb | Method | | ### resTv2.wallets(cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-wallets | Param | Type | | --- | --- | | cb | Method | ### resTv2.activeOrders(cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-orders | Param | Type | | --- | --- | | cb | Method | ### resTv2.orderHistory(symbol, start, end, limit, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#orders-history | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | start | number | | | end | number | | | limit | number | | | cb | Method | | ### resTv2.orderTrades(symbol, start, end, limit, orderID, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-order-trades | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | start | number | | | end | number | | | limit | number | | | orderID | number | | | cb | Method | | ### resTv2.positions(cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-positions | Param | Type | | --- | --- | | cb | Method | ### resTv2.fundingOffers(symbol, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-funding-offers | Param | Type | Default | | --- | --- | --- | | symbol | string | "fUSD" | | cb | Method | | ### resTv2.fundingOfferHistory(symbol, start, end, limit, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-funding-offers-hist | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | start | number | | | end | number | | | limit | number | | | cb | Method | | ### resTv2.fundingLoans(symbol, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-funding-loans | Param | Type | Default | | --- | --- | --- | | symbol | string | "fUSD" | | cb | Method | | ### resTv2.fundingLoanHistory(symbol, start, end, limit, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-funding-loans-hist | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | start | number | | | end | number | | | limit | number | | | cb | Method | | ### resTv2.fundingCredits(symbol, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-funding-credits | Param | Type | Default | | --- | --- | --- | | symbol | string | "fUSD" | | cb | Method | | ### resTv2.fundingCreditHistory(symbol, start, end, limit, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-funding-credits-hist | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | start | number | | | end | number | | | limit | number | | | cb | Method | | ### resTv2.fundingTrades(symbol, start, end, limit, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-funding-trades-hist | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | start | number | | | end | number | | | limit | number | | | cb | Method | | ### resTv2.marginInfo(key, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-info-margin | Param | Type | Default | | --- | --- | --- | | key | string | "base" | | cb | Method | | ### resTv2.fundingInfo(key, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-info-funding | Param | Type | Default | | --- | --- | --- | | key | string | "fUSD" | | cb | Method | | ### resTv2.performance(cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-performance | Param | Type | | --- | --- | | cb | Method | ### resTv2.calcAvailableBalance(symbol, dir, rate, type, cb) ⇒ Promise **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v2/reference#rest-auth-calc-bal-avail | Param | Type | Default | | --- | --- | --- | | symbol | string | "tBTCUSD" | | dir | string | | | rate | number | | | type | string | | | cb | Method | | ### ~~resTv2.symbols(cb) ⇒ Promise~~ ***Deprecated*** Get a list of valid symbol names **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-public-symbols | Param | Type | | --- | --- | | cb | Method | ### ~~resTv2.symbolDetails(cb) ⇒ Promise~~ ***Deprecated*** Get a list of valid symbol names and details **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-public-symbol-details | Param | Type | | --- | --- | | cb | Method | ### ~~resTv2.accountInfo(cb) ⇒ Promise~~ ***Deprecated*** Request information about your account **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-auth-account-info | Param | Type | | --- | --- | | cb | Method | ### ~~resTv2.accountFees(cb) ⇒ Promise~~ ***Deprecated*** Request account withdrawl fees **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-auth-fees | Param | Type | | --- | --- | | cb | Method | ### ~~resTv2.accountSummary(cb) ⇒ Promise~~ ***Deprecated*** Returns a 30-day summary of your trading volume and return on margin funding. **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-auth-summary | Param | Type | | --- | --- | | cb | Method | ### ~~resTv2.deposit(params, cb) ⇒ Promise~~ ***Deprecated*** Request a deposit address **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-auth-deposit | Param | Type | Description | | --- | --- | --- | | params | Object | | | params.request | string | | | params.nonce | string | | | params.method | string | name of currency | | params.wallet_name | string | 'trading', 'exchange' or 'deposit' | | params.renew | number | 1 or 0 | | cb | Method | | ### ~~resTv2.withdraw(params, cb) ⇒ Promise~~ ***Deprecated*** Requests a withdrawl from a wallet **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-auth-withdrawal | Param | Type | Description | | --- | --- | --- | | params | Object | | | params.withdraw_type | string | name of currency | | params.walletselected | string | 'trading', 'exchange, or 'deposit' | | params.amount | string | | | params.address | string | | | params.payment_id | string | optional, for monero | | params.account_name | string | | | params.account_number | string | | | params.swift | string | | | params.bank_name | string | | | params.bank_address | string | | | params.bank_city | string | | | params.bank_country | string | | | params.detail_payment | string | message to beneficiary | | params.expressWire | number | 1 or 0 | | params.intermediary_bank_name | string | | | params.intermediary_bank_address | string | | | params.intermediary_bank_city | string | | | params.intermediary_bank_country | string | | | params.intermediary_bank_account | string | | | params.intermediary_bank_swift | string | | | cb | Method | | ### ~~resTv2.transfer(params, cb) ⇒ Promise~~ ***Deprecated*** Execute a balance transfer between wallets **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-auth-transfer-between-wallets | Param | Type | Description | | --- | --- | --- | | params | Object | | | params.amount | number | amount to transfer | | params.currency | string | currency of funds to transfer | | params.walletFrom | string | wallet to transfer from | | params.walletTo | string | wallet to transfer to | | cb | Method | | ### ~~resTv2.keyPermissions(cb) ⇒ Promise~~ ***Deprecated*** Fetch the permissions of the key being used to generate this request **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#auth-key-permissions | Param | Type | | --- | --- | | cb | Method | ### ~~resTv2.balances(cb) ⇒ Promise~~ ***Deprecated*** Request your wallet balances **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-auth-wallet-balances | Param | Type | | --- | --- | | cb | Method | ### ~~resTv2.claimPosition(params, cb) ⇒ Promise~~ ***Deprecated*** **Kind**: instance method of [RESTv2](#RESTv2) **Returns**: Promise - p **See**: https://docs.bitfinex.com/v1/reference#rest-auth-claim-position | Param | Type | | --- | --- | | params | Object | | params.position_id | number | | params.amount | number | | cb | Method |