bitfinex

bitfinex

Kind: global class
Extends: Exchange

• fetchStatus
• fetchMarkets
• fetchCurrencies
• fetchBalance
• transfer
• fetchOrderBook
• fetchTickers
• fetchTicker
• fetchTrades
• fetchOHLCV
• createOrder
• createOrders
• cancelAllOrders
• cancelOrder
• cancelOrders
• fetchOpenOrder
• fetchClosedOrder
• fetchOpenOrders
• fetchClosedOrders
• fetchOrderTrades
• fetchMyTrades
• createDepositAddress
• fetchDepositAddress
• fetchTradingFees
• fetchDepositsWithdrawals
• withdraw
• fetchPositions
• fetchLedger
• fetchFundingRates
• fetchFundingRateHistory
• fetchOpenInterests
• fetchOpenInterest
• fetchOpenInterestHistory
• fetchLiquidations
• setMargin
• fetchOrder
• editOrder
• watchOHLCV
• unWatchOHLCV
• watchTrades
• unWatchTrades
• watchMyTrades
• watchTicker
• unWatchTicker
• watchOrderBook
• watchBalance
• watchOrders

fetchStatus

the latest known information on the availability of the exchange API

Kind: instance method of bitfinex
Returns: object - a status structure

See: https://docs.bitfinex.com/reference/rest-public-platform-status

bitfinex.fetchStatus (params?)

fetchMarkets

retrieves data on all markets for bitfinex

Kind: instance method of bitfinex
Returns: Array<object> - an array of objects representing market data

See: https://docs.bitfinex.com/reference/rest-public-conf

bitfinex.fetchMarkets (params?)

fetchCurrencies

fetches all available currencies on an exchange

Kind: instance method of bitfinex
Returns: object - an associative dictionary of currencies

See: https://docs.bitfinex.com/reference/rest-public-conf

bitfinex.fetchCurrencies (params?)

fetchBalance

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of bitfinex
Returns: object - a balance structure

See: https://docs.bitfinex.com/reference/rest-auth-wallets

bitfinex.fetchBalance (params?)

transfer

transfer currency internally between wallets on the same account

Kind: instance method of bitfinex
Returns: object - a transfer structure

See: https://docs.bitfinex.com/reference/rest-auth-transfer

bitfinex.transfer (code, amount, fromAccount, toAccount, params?)

fetchOrderBook

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of bitfinex
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://docs.bitfinex.com/reference/rest-public-book

bitfinex.fetchOrderBook (symbol, limit?, params?)

fetchTickers

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of bitfinex
Returns: object - a dictionary of ticker structures

See: https://docs.bitfinex.com/reference/rest-public-tickers

bitfinex.fetchTickers (symbols, params?)

fetchTicker

fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bitfinex
Returns: object - a ticker structure

See: https://docs.bitfinex.com/reference/rest-public-ticker

bitfinex.fetchTicker (symbol, params?)

fetchTrades

get the list of most recent trades for a particular symbol

Kind: instance method of bitfinex
Returns: Array<Trade> - a list of trade structures

See: https://docs.bitfinex.com/reference/rest-public-trades

bitfinex.fetchTrades (symbol, since?, limit?, params?)

fetchOHLCV

fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of bitfinex
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.bitfinex.com/reference/rest-public-candles

bitfinex.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

createOrder

create an order on the exchange

Kind: instance method of bitfinex
Returns: object - an order structure

See: https://docs.bitfinex.com/reference/rest-auth-submit-order

bitfinex.createOrder (symbol, type, side, amount, price?, params?)

createOrders

create a list of trade orders

Kind: instance method of bitfinex
Returns: object - an order structure

See: https://docs.bitfinex.com/reference/rest-auth-order-multi

bitfinex.createOrders (orders, params?)

cancelAllOrders

cancel all open orders

Kind: instance method of bitfinex
Returns: Array<object> - a list of order structures

See: https://docs.bitfinex.com/reference/rest-auth-cancel-orders-multiple

bitfinex.cancelAllOrders (symbol, params?)

cancelOrder

cancels an open order

Kind: instance method of bitfinex
Returns: object - An order structure

See: https://docs.bitfinex.com/reference/rest-auth-cancel-order

bitfinex.cancelOrder (id, symbol, params?)

cancelOrders

cancel multiple orders at the same time

Kind: instance method of bitfinex
Returns: object - an array of order structures

See: https://docs.bitfinex.com/reference/rest-auth-cancel-orders-multiple

bitfinex.cancelOrders (ids, symbol, params?)

fetchOpenOrder

fetch an open order by it's id

Kind: instance method of bitfinex
Returns: object - an order structure

See

• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol

bitfinex.fetchOpenOrder (id, symbol, params?)

fetchClosedOrder

fetch an open order by it's id

Kind: instance method of bitfinex
Returns: object - an order structure

See

• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol

bitfinex.fetchClosedOrder (id, symbol, params?)

fetchOpenOrders

fetch all unfilled currently open orders

Kind: instance method of bitfinex
Returns: Array<Order> - a list of order structures

See

• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol

bitfinex.fetchOpenOrders (symbol, since?, limit?, params?)

fetchClosedOrders

fetches information on multiple closed orders made by the user

Kind: instance method of bitfinex
Returns: Array<Order> - a list of order structures

See

• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol

bitfinex.fetchClosedOrders (symbol, since?, limit?, params?)

fetchOrderTrades

fetch all the trades made from a single order

Kind: instance method of bitfinex
Returns: Array<object> - a list of trade structures

See: https://docs.bitfinex.com/reference/rest-auth-order-trades

bitfinex.fetchOrderTrades (id, symbol, since?, limit?, params?)

fetchMyTrades

fetch all trades made by the user

Kind: instance method of bitfinex
Returns: Array<Trade> - a list of trade structures

See

• https://docs.bitfinex.com/reference/rest-auth-trades
• https://docs.bitfinex.com/reference/rest-auth-trades-by-symbol

bitfinex.fetchMyTrades (symbol, since?, limit?, params?)

createDepositAddress

create a currency deposit address

Kind: instance method of bitfinex
Returns: object - an address structure

See: https://docs.bitfinex.com/reference/rest-auth-deposit-address

bitfinex.createDepositAddress (code, params?)

fetchDepositAddress

fetch the deposit address for a currency associated with this account

Kind: instance method of bitfinex
Returns: object - an address structure

See: https://docs.bitfinex.com/reference/rest-auth-deposit-address

bitfinex.fetchDepositAddress (code, params?)

fetchTradingFees

fetch the trading fees for multiple markets

Kind: instance method of bitfinex
Returns: object - a dictionary of fee structures indexed by market symbols

See: https://docs.bitfinex.com/reference/rest-auth-summary

bitfinex.fetchTradingFees (params?)

fetchDepositsWithdrawals

fetch history of deposits and withdrawals

Kind: instance method of bitfinex
Returns: object - a list of transaction structure

See

• https://docs.bitfinex.com/reference/movement-info
• https://docs.bitfinex.com/reference/rest-auth-movements

bitfinex.fetchDepositsWithdrawals (code?, since?, limit?, params?)

withdraw

make a withdrawal

Kind: instance method of bitfinex
Returns: object - a transaction structure

See: https://docs.bitfinex.com/reference/rest-auth-withdraw

bitfinex.withdraw (code, amount, address, tag, params?)

fetchPositions

fetch all open positions

Kind: instance method of bitfinex
Returns: Array<object> - a list of position structure

See: https://docs.bitfinex.com/reference/rest-auth-positions

bitfinex.fetchPositions (symbols, params?)

fetchLedger

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of bitfinex
Returns: object - a ledger structure

See: https://docs.bitfinex.com/reference/rest-auth-ledgers

bitfinex.fetchLedger (code?, since?, limit?, params?)

fetchFundingRates

fetch the current funding rate for multiple symbols

Kind: instance method of bitfinex
Returns: Array<object> - a list of funding rate structures

See: https://docs.bitfinex.com/reference/rest-public-derivatives-status

bitfinex.fetchFundingRates (symbols, params?)

fetchFundingRateHistory

fetches historical funding rate prices

Kind: instance method of bitfinex
Returns: object - a funding rate structure

See: https://docs.bitfinex.com/reference/rest-public-derivatives-status-history

bitfinex.fetchFundingRateHistory (symbol, since?, limit?, params?)

fetchOpenInterests

Retrieves the open interest for a list of symbols

Kind: instance method of bitfinex
Returns: Array<object> - a list of open interest structures

See: https://docs.bitfinex.com/reference/rest-public-derivatives-status

bitfinex.fetchOpenInterests (symbols?, params?)

fetchOpenInterest

retrieves the open interest of a contract trading pair

Kind: instance method of bitfinex
Returns: object - an open interest structure

See: https://docs.bitfinex.com/reference/rest-public-derivatives-status

bitfinex.fetchOpenInterest (symbol, params?)

fetchOpenInterestHistory

retrieves the open interest history of a currency

Kind: instance method of bitfinex
Returns: An array of open interest structures

See: https://docs.bitfinex.com/reference/rest-public-derivatives-status-history

bitfinex.fetchOpenInterestHistory (symbol, timeframe, since?, limit?, params?)

fetchLiquidations

retrieves the public liquidations of a trading pair

Kind: instance method of bitfinex
Returns: object - an array of liquidation structures

See: https://docs.bitfinex.com/reference/rest-public-liquidations

bitfinex.fetchLiquidations (symbol, since?, limit?, params?)

setMargin

either adds or reduces margin in a swap position in order to set the margin to a specific value

Kind: instance method of bitfinex
Returns: object - A margin structure

See: https://docs.bitfinex.com/reference/rest-auth-deriv-pos-collateral-set

bitfinex.setMargin (symbol, amount, params?)

fetchOrder

fetches information on an order made by the user

Kind: instance method of bitfinex
Returns: object - an order structure

See

• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
• https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol

bitfinex.fetchOrder (id, symbol?, params?)

editOrder

edit a trade order

Kind: instance method of bitfinex
Returns: object - an order structure

See: https://docs.bitfinex.com/reference/rest-auth-update-order

bitfinex.editOrder (id, symbol, type, side, amount, price?, params?)

watchOHLCV

watches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of bitfinex
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

bitfinex.watchOHLCV (symbol, timeframe, since?, limit?, params?)

unWatchOHLCV

unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of bitfinex
Returns: bool - true if successfully unsubscribed, false otherwise

bitfinex.unWatchOHLCV (symbol, timeframe, params?)

watchTrades

get the list of most recent trades for a particular symbol

Kind: instance method of bitfinex
Returns: Array<object> - a list of trade structures

bitfinex.watchTrades (symbol, since?, limit?, params?)

unWatchTrades

unWatches the list of most recent trades for a particular symbol

Kind: instance method of bitfinex
Returns: Array<object> - a list of trade structures

bitfinex.unWatchTrades (symbol, params?)

watchMyTrades

watches information on multiple trades made by the user

Kind: instance method of bitfinex
Returns: Array<object> - a list of trade structures

bitfinex.watchMyTrades (symbol, since?, limit?, params?)

watchTicker

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bitfinex
Returns: object - a ticker structure

bitfinex.watchTicker (symbol, params?)

unWatchTicker

unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bitfinex
Returns: object - a ticker structure

bitfinex.unWatchTicker (symbol, params?)

watchOrderBook

watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of bitfinex
Returns: object - A dictionary of order book structures indexed by market symbols

bitfinex.watchOrderBook (symbol, limit?, params?)

watchBalance

watch balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of bitfinex
Returns: object - a balance structure

bitfinex.watchBalance (params?)

watchOrders

watches information on multiple orders made by the user

Kind: instance method of bitfinex
Returns: Array<object> - a list of order structures

bitfinex.watchOrders (symbol, since?, limit?, params?)