abcdefghijklmnopqrstuvwxyz

Kind: global class
Extends:Exchange

• fetchMarkets
• fetchTicker
• fetchTickers
• fetchOrderBook
• fetchOHLCV
• createOrder
• cancelOrder
• fetchOrder
• fetchOpenOrders
• fetchOrderTrades
• fetchMyTrades
• fetchBalance

retrieves data on all markets for ace

Kind: instance method oface
Returns:Array.<object> - an array of objects representing market data
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#oapi-api---market-pair

ace.fetchMarkets(params)

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

Kind: instance method oface
Returns:object - aticker structure
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#oapi-api---trade-data

ace.fetchTicker(symbol,params)

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

Kind: instance method oface
Returns:object - a dictionary ofticker structures
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#oapi-api---trade-data

ace.fetchTickers(symbols,params)

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

Kind: instance method oface
Returns:object - A dictionary oforder book structures indexed by market symbols
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---order-books

ace.fetchOrderBook(symbol,limit,params)

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

Kind: instance method oface
Returns:Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---klinecandlestick-data

ace.fetchOHLCV(symbol,timeframe,since,limit,params)

create a trade order

Kind: instance method oface
Returns:object - anorder structure
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---new-order

ace.createOrder(symbol,type,side,amount,price,params)

cancels an open order

Kind: instance method oface
Returns:object - Anorder structure
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---cancel-order

ace.cancelOrder(id,symbol,params)

fetches information on an order made by the user

Kind: instance method oface
Returns:object - Anorder structure
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---order-status

ace.fetchOrder(symbol,params)

fetch all unfilled currently open orders

Kind: instance method oface
Returns:Array.<object> - a list oforder structures
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---order-list

ace.fetchOpenOrders(symbol,since,limit,params)

fetch all the trades made from a single order

Kind: instance method oface
Returns:Array.<object> - a list oftrade structures
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---order-history

ace.fetchOrderTrades(id,symbol,since,limit,params)

fetch all trades made by the user

Kind: instance method oface
Returns:Array.<object> - a list oftrade structures
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---trade-list

ace.fetchMyTrades(symbol,since,limit,params)

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

Kind: instance method oface
Returns:object - abalance structure
See:https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---account-balance

ace.fetchBalance(params)

Kind: global class
Extends:Exchange

• fetchMarkets
• fetchTrades
• fetchOrderBook
• fetchOHLCV
• createOrder
• cancelOrder
• fetchOrder
• fetchOpenOrders

retrieves data on all markets for alpaca

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

alpaca.fetchMarkets(params)

get the list of most recent trades for a particular symbol

Kind: instance method ofalpaca
Returns:Array.<object> - a list oftrade structures

alpaca.fetchTrades(symbol,since,limit,params)

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

Kind: instance method ofalpaca
Returns:object - A dictionary oforder book structures indexed by market symbols

alpaca.fetchOrderBook(symbol,limit,params)

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

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

alpaca.fetchOHLCV(symbol,timeframe,since,limit,params)

create a trade order

Kind: instance method ofalpaca
Returns:object - anorder structure

alpaca.createOrder(symbol,type,side,amount,price,params)

cancels an open order

Kind: instance method ofalpaca
Returns:object - Anorder structure

alpaca.cancelOrder(id,symbol,params)

fetches information on an order made by the user

Kind: instance method ofalpaca
Returns:object - Anorder structure

alpaca.fetchOrder(symbol,params)

fetch all unfilled currently open orders

Kind: instance method ofalpaca
Returns:Array.<object> - a list oforder structures

alpaca.fetchOpenOrders(symbol,since,limit,params)

Kind: global class
Extends:Exchange

• fetchCurrencies
• fetchMarkets
• fetchTime
• fetchAccounts
• fetchBalance
• fetchOrderBook
• fetchTicker
• fetchTickers
• fetchOHLCV
• fetchTrades
• fetchTradingFees
• createOrder
• fetchOrder
• fetchOpenOrders
• fetchClosedOrders
• cancelOrder
• cancelAllOrders
• fetchDepositAddress
• fetchDeposits
• fetchWithdrawals
• fetchTransactions
• fetchPositions
• fetchFundingRates
• reduceMargin
• addMargin
• setLeverage
• setMarginMode
• fetchLeverageTiers
• fetchDepositWithdrawFees
• transfer

fetches all available currencies on an exchange

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

ascendex.fetchCurrencies(params)

retrieves data on all markets for ascendex

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

ascendex.fetchMarkets(params)

fetches the current integer timestamp in milliseconds from the ascendex server

Kind: instance method ofascendex
Returns:int - the current integer timestamp in milliseconds from the ascendex server

ascendex.fetchTime(params)

fetch all the accounts associated with a profile

Kind: instance method ofascendex
Returns:object - a dictionary ofaccount structures indexed by the account type

ascendex.fetchAccounts(params)

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

Kind: instance method ofascendex
Returns:object - abalance structure

ascendex.fetchBalance(params)

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

Kind: instance method ofascendex
Returns:object - A dictionary oforder book structures indexed by market symbols

ascendex.fetchOrderBook(symbol,limit,params)

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

Kind: instance method ofascendex
Returns:object - aticker structure

ascendex.fetchTicker(symbol,params)

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

Kind: instance method ofascendex
Returns:object - a dictionary ofticker structures
See

• https://ascendex.github.io/ascendex-pro-api/#ticker
• https://ascendex.github.io/ascendex-futures-pro-api-v2/#ticker

ascendex.fetchTickers(symbols,params)

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

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

ascendex.fetchOHLCV(symbol,timeframe,since,limit,params)

get the list of most recent trades for a particular symbol

Kind: instance method ofascendex
Returns:Array.<object> - a list oftrade structures
See:https://ascendex.github.io/ascendex-pro-api/#market-trades

ascendex.fetchTrades(symbol,since,limit,params)

fetch the trading fees for multiple markets

Kind: instance method ofascendex
Returns:object - a dictionary offee structures indexed by market symbols

ascendex.fetchTradingFees(params)

Create an order on the exchange

Kind: instance method ofascendex
Returns:An order structure

ascendex.createOrder(symbol,type,side,amount,price,params)

fetches information on an order made by the user

Kind: instance method ofascendex
Returns:object - Anorder structure

ascendex.fetchOrder(symbol,params)

fetch all unfilled currently open orders

Kind: instance method ofascendex
Returns:Array.<object> - a list oforder structures

ascendex.fetchOpenOrders(symbol,since,limit,params)

fetches information on multiple closed orders made by the user

Kind: instance method ofascendex
Returns:Array.<object> - a list oforder structures
See:https://ascendex.github.io/ascendex-pro-api/#list-history-orders-v2

ascendex.fetchClosedOrders(symbol,since,limit,params)

cancels an open order

Kind: instance method ofascendex
Returns:object - Anorder structure

ascendex.cancelOrder(id,symbol,params)

cancel all open orders

Kind: instance method ofascendex
Returns:Array.<object> - a list oforder structures

ascendex.cancelAllOrders(symbol,params)

fetch the deposit address for a currency associated with this account

Kind: instance method ofascendex
Returns:object - anaddress structure

ascendex.fetchDepositAddress(code,params)

fetch all deposits made to an account

Kind: instance method ofascendex
Returns:Array.<object> - a list oftransaction structures

ascendex.fetchDeposits(code,since,limit,params)

fetch all withdrawals made from an account

Kind: instance method ofascendex
Returns:Array.<object> - a list oftransaction structures

ascendex.fetchWithdrawals(code,since,limit,params)

DEPRECATED, use fetchDepositsWithdrawals instead

Kind: instance method ofascendex
Returns:object - a list oftransaction structure

ascendex.fetchTransactions(code,since,limit,params)

fetch all open positions

Kind: instance method ofascendex
Returns:Array.<object> - a list ofposition structure

ascendex.fetchPositions(symbols,params)

fetch the funding rate for multiple markets

Kind: instance method ofascendex
Returns:object - a dictionary offunding rates structures, indexe by market symbols

ascendex.fetchFundingRates(symbols,params)

remove margin from a position

Kind: instance method ofascendex
Returns:object - amargin structure

ascendex.reduceMargin(symbol,amount,params)

add margin

Kind: instance method ofascendex
Returns:object - amargin structure

ascendex.addMargin(symbol,amount,params)

set the level of leverage for a market

Kind: instance method ofascendex
Returns:object - response from the exchange

ascendex.setLeverage(leverage,symbol,params)

set margin mode to 'cross' or 'isolated'

Kind: instance method ofascendex
Returns:object - response from the exchange

ascendex.setMarginMode(marginMode,symbol,params)

retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes

Kind: instance method ofascendex
Returns:object - a dictionary ofleverage tiers structures, indexed by market symbols

ascendex.fetchLeverageTiers(symbols,params)

fetch deposit and withdraw fees

Kind: instance method ofascendex
Returns:object - a list offee structures
See:https://ascendex.github.io/ascendex-pro-api/#list-all-assets

ascendex.fetchDepositWithdrawFees(codes,params)

transfer currency internally between wallets on the same account

Kind: instance method ofascendex
Returns:object - atransfer structure

ascendex.transfer(code,amount,fromAccount,toAccount,params)

Kind: global class
Extends:Exchange

• fetchMarkets
• fetchTicker
• fetchTickers
• fetchTime
• fetchOrderBook
• fetchTrades
• fetchOHLCV
• fetchBalance
• createOrder
• cancelOrder
• cancelAllOrders
• fetchOrder
• fetchOrders
• fetchMyTrades
• fetchOpenOrders
• fetchClosedOrders
• fetchDepositAddress
• fetchDeposits
• fetchWithdrawals
• transfer
• withdraw

retrieves data on all markets for bigone

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

bigone.fetchMarkets(params)

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

Kind: instance method ofbigone
Returns:object - aticker structure

bigone.fetchTicker(symbol,params)

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

Kind: instance method ofbigone
Returns:object - a dictionary ofticker structures

bigone.fetchTickers(symbols,params)

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method ofbigone
Returns:int - the current integer timestamp in milliseconds from the exchange server

bigone.fetchTime(params)

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

Kind: instance method ofbigone
Returns:object - A dictionary oforder book structures indexed by market symbols

bigone.fetchOrderBook(symbol,limit,params)

get the list of most recent trades for a particular symbol

Kind: instance method ofbigone
Returns:Array.<object> - a list oftrade structures

bigone.fetchTrades(symbol,since,limit,params)

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

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

bigone.fetchOHLCV(symbol,timeframe,since,limit,params)

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

Kind: instance method ofbigone
Returns:object - abalance structure

bigone.fetchBalance(params)

create a trade order

Kind: instance method ofbigone
Returns:object - anorder structure

bigone.createOrder(symbol,type,side,amount,price,params)

cancels an open order

Kind: instance method ofbigone
Returns:object - Anorder structure

bigone.cancelOrder(id,symbol,params)

cancel all open orders

Kind: instance method ofbigone
Returns:Array.<object> - a list oforder structures

bigone.cancelAllOrders(symbol,params)

fetches information on an order made by the user

Kind: instance method ofbigone
Returns:object - Anorder structure

bigone.fetchOrder(symbol,params)

fetches information on multiple orders made by the user

Kind: instance method ofbigone
Returns:Array.<object> - a list oforder structures

bigone.fetchOrders(symbol,since,limit,params)

fetch all trades made by the user

Kind: instance method ofbigone
Returns:Array.<object> - a list oftrade structures

bigone.fetchMyTrades(symbol,since,limit,params)

fetch all unfilled currently open orders

Kind: instance method ofbigone
Returns:Array.<object> - a list oforder structures

bigone.fetchOpenOrders(symbol,since,limit,params)

fetches information on multiple closed orders made by the user

Kind: instance method ofbigone
Returns:Array.<object> - a list oforder structures

bigone.fetchClosedOrders(symbol,since,limit,params)

fetch the deposit address for a currency associated with this account

Kind: instance method ofbigone
Returns:object - anaddress structure

bigone.fetchDepositAddress(code,params)

fetch all deposits made to an account

Kind: instance method ofbigone
Returns:Array.<object> - a list oftransaction structures

bigone.fetchDeposits(code,since,limit,params)

fetch all withdrawals made from an account

Kind: instance method ofbigone
Returns:Array.<object> - a list oftransaction structures

bigone.fetchWithdrawals(code,since,limit,params)

transfer currency internally between wallets on the same account

Kind: instance method ofbigone
Returns:object - atransfer structure

bigone.transfer(code,amount,fromAccount,toAccount,params)

make a withdrawal

Kind: instance method ofbigone
Returns:object - atransaction structure

bigone.withdraw(code,amount,address,tag,params)

Kind: global class
Extends:Exchange

• fetchTime
• fetchCurrencies
• fetchMarkets
• fetchBalance
• fetchOrderBook
• fetchStatus
• fetchTicker
• fetchBidsAsks
• fetchLastPrices
• fetchTickers
• fetchOHLCV
• fetchTrades
• editSpotOrder
• editOrder
• editOrder
• createOrder
• fetchOrder
• fetchOrders
• fetchOpenOrders
• fetchClosedOrders
• fetchCanceledOrders
• cancelOrder
• cancelAllOrders
• fetchOrderTrades
• fetchMyTrades
• fetchMyDustTrades
• fetchDeposits
• fetchWithdrawals
• transfer
• fetchTransfers
• fetchDepositAddress
• fetchTransactionFees
• fetchDepositWithdrawFees
• withdraw
• fetchTradingFee
• fetchTradingFees
• futuresTransfer
• fetchFundingRate
• fetchFundingRateHistory
• fetchFundingRates
• fetchLeverageTiers
• fetchPosition
• fetchOptionPositions
• fetchPositions
• fetchAccountPositions
• fetchPositionsRisk
• fetchFundingHistory
• setLeverage
• setMarginMode
• setPositionMode
• fetchSettlementHistory
• fetchLedger
• reduceMargin
• addMargin
• fetchBorrowRate
• fetchBorrowRateHistory
• createGiftCode
• redeemGiftCode
• verifyGiftCode
• fetchBorrowInterest
• repayMargin
• borrowMargin
• fetchOpenInterestHistory
• fetchOpenInterest

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method ofbinance
Returns:int - the current integer timestamp in milliseconds from the exchange server
See

• https://binance-docs.github.io/apidocs/spot/en/#check-server-time // spot
• https://binance-docs.github.io/apidocs/futures/en/#check-server-time // swap
• https://binance-docs.github.io/apidocs/delivery/en/#check-server-time // future

binance.fetchTime(params)

fetches all available currencies on an exchange

Kind: instance method ofbinance
Returns:object - an associative dictionary of currencies
See:https://binance-docs.github.io/apidocs/spot/en/#all-coins-39-information-user_data

binance.fetchCurrencies(params)

retrieves data on all markets for binance

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

• https://binance-docs.github.io/apidocs/spot/en/#exchange-information // spot
• https://binance-docs.github.io/apidocs/futures/en/#exchange-information // swap
• https://binance-docs.github.io/apidocs/delivery/en/#exchange-information // future
• https://binance-docs.github.io/apidocs/voptions/en/#exchange-information // option

binance.fetchMarkets(params)

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

Kind: instance method ofbinance
Returns:object - abalance structure
See

• https://binance-docs.github.io/apidocs/spot/en/#account-information-user_data // spot
• https://binance-docs.github.io/apidocs/spot/en/#query-cross-margin-account-details-user_data // cross margin
• https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-account-info-user_data // isolated margin
• https://binance-docs.github.io/apidocs/spot/en/#lending-account-user_data // lending
• https://binance-docs.github.io/apidocs/spot/en/#funding-wallet-user_data // funding
• https://binance-docs.github.io/apidocs/futures/en/#account-information-v2-user_data // swap
• https://binance-docs.github.io/apidocs/delivery/en/#account-information-user_data // future
• https://binance-docs.github.io/apidocs/voptions/en/#option-account-information-trade // option

binance.fetchBalance(params)

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

Kind: instance method ofbinance
Returns:object - A dictionary oforder book structures indexed by market symbols
See

• https://binance-docs.github.io/apidocs/spot/en/#order-book // spot
• https://binance-docs.github.io/apidocs/futures/en/#order-book // swap
• https://binance-docs.github.io/apidocs/delivery/en/#order-book // future
• https://binance-docs.github.io/apidocs/voptions/en/#order-book // option

binance.fetchOrderBook(symbol,limit,params)

the latest known information on the availability of the exchange API

Kind: instance method ofbinance
Returns:object - astatus structure
See:https://binance-docs.github.io/apidocs/spot/en/#system-status-system

binance.fetchStatus(params)

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

Kind: instance method ofbinance
Returns:object - aticker structure
See

• https://binance-docs.github.io/apidocs/spot/en/#24hr-ticker-price-change-statistics // spot
• https://binance-docs.github.io/apidocs/futures/en/#24hr-ticker-price-change-statistics // swap
• https://binance-docs.github.io/apidocs/delivery/en/#24hr-ticker-price-change-statistics // future
• https://binance-docs.github.io/apidocs/voptions/en/#24hr-ticker-price-change-statistics // option

binance.fetchTicker(symbol,params)

fetches the bid and ask price and volume for multiple markets

Kind: instance method ofbinance
Returns:object - a dictionary ofticker structures
See

• https://binance-docs.github.io/apidocs/spot/en/#symbol-order-book-ticker // spot
• https://binance-docs.github.io/apidocs/futures/en/#symbol-order-book-ticker // swap
• https://binance-docs.github.io/apidocs/delivery/en/#symbol-order-book-ticker // future

binance.fetchBidsAsks(symbols,params)

fetches the last price for multiple markets

Kind: instance method ofbinance
Returns:object - a dictionary ofticker structures
See

• https://binance-docs.github.io/apidocs/spot/en/#symbol-price-ticker // spot
• https://binance-docs.github.io/apidocs/future/en/#symbol-price-ticker // swap
• https://binance-docs.github.io/apidocs/delivery/en/#symbol-price-ticker // future

binance.fetchLastPrices(symbols,params)

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

Kind: instance method ofbinance
Returns:object - a dictionary ofticker structures
See

• https://binance-docs.github.io/apidocs/spot/en/#24hr-ticker-price-change-statistics // spot
• https://binance-docs.github.io/apidocs/futures/en/#24hr-ticker-price-change-statistics // swap
• https://binance-docs.github.io/apidocs/delivery/en/#24hr-ticker-price-change-statistics // future
• https://binance-docs.github.io/apidocs/voptions/en/#24hr-ticker-price-change-statistics // option

binance.fetchTickers(symbols,params)

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

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

binance.fetchOHLCV(symbol,timeframe,since,limit,params)

get the list of most recent trades for a particular symbolDefault fetchTradesMethod

Kind: instance method ofbinance
Returns:Array.<object> - a list oftrade structures
See

• https://binance-docs.github.io/apidocs/spot/en/#compressed-aggregate-trades-list // publicGetAggTrades (spot)
• https://binance-docs.github.io/apidocs/futures/en/#compressed-aggregate-trades-list // fapiPublicGetAggTrades (swap)
• https://binance-docs.github.io/apidocs/delivery/en/#compressed-aggregate-trades-list // dapiPublicGetAggTrades (future)
• https://binance-docs.github.io/apidocs/voptions/en/#recent-trades-list // eapiPublicGetTrades (option)Other fetchTradesMethod
• https://binance-docs.github.io/apidocs/spot/en/#recent-trades-list // publicGetTrades (spot)
• https://binance-docs.github.io/apidocs/futures/en/#recent-trades-list // fapiPublicGetTrades (swap)
• https://binance-docs.github.io/apidocs/delivery/en/#recent-trades-list // dapiPublicGetTrades (future)
• https://binance-docs.github.io/apidocs/spot/en/#old-trade-lookup-market_data // publicGetHistoricalTrades (spot)
• https://binance-docs.github.io/apidocs/future/en/#old-trade-lookup-market_data // fapiPublicGetHistoricalTrades (swap)
• https://binance-docs.github.io/apidocs/delivery/en/#old-trade-lookup-market_data // dapiPublicGetHistoricalTrades (future)
• https://binance-docs.github.io/apidocs/voptions/en/#old-trade-lookup-market_data // eapiPublicGetHistoricalTrades (option)

binance.fetchTrades(symbol,since,limit,params)

edit a trade order

Kind: instance method ofbinance
Returns:object - anorder structure
See:https://binance-docs.github.io/apidocs/spot/en/#cancel-an-existing-order-and-send-a-new-order-trade

binance.editSpotOrder(id,symbol,type,side,amount,price,params)

edit a trade order

Kind: instance method ofbinance
Returns:object - anorder structure
See

• https://binance-docs.github.io/apidocs/futures/en/#modify-order-trade
• https://binance-docs.github.io/apidocs/delivery/en/#modify-order-trade

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

edit a trade order

Kind: instance method ofbinance
Returns:object - anorder structure
See

• https://binance-docs.github.io/apidocs/spot/en/#cancel-an-existing-order-and-send-a-new-order-trade
• https://binance-docs.github.io/apidocs/futures/en/#modify-order-trade
• https://binance-docs.github.io/apidocs/delivery/en/#modify-order-trade

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

create a trade order

Kind: instance method ofbinance
Returns:object - anorder structure
See

• https://binance-docs.github.io/apidocs/spot/en/#new-order-trade
• https://binance-docs.github.io/apidocs/spot/en/#test-new-order-trade
• https://binance-docs.github.io/apidocs/futures/en/#new-order-trade
• https://binance-docs.github.io/apidocs/delivery/en/#new-order-trade
• https://binance-docs.github.io/apidocs/voptions/en/#new-order-trade

binance.createOrder(symbol,type,side,amount,price,params)

fetches information on an order made by the user

Kind: instance method ofbinance
Returns:object - Anorder structure

binance.fetchOrder(symbol,params)

fetches information on multiple orders made by the user

Kind: instance method ofbinance
Returns:Array.<object> - a list oforder structures

binance.fetchOrders(symbol,since,limit,params)

fetch all unfilled currently open orders

Kind: instance method ofbinance
Returns:Array.<object> - a list oforder structures

binance.fetchOpenOrders(symbol,since,limit,params)

fetches information on multiple closed orders made by the user

Kind: instance method ofbinance
Returns:Array.<object> - a list oforder structures

binance.fetchClosedOrders(symbol,since,limit,params)

fetches information on multiple canceled orders made by the user

Kind: instance method ofbinance
Returns:Array.<object> - a list oforder structures
See

• https://binance-docs.github.io/apidocs/spot/en/#all-orders-user_data
• https://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-all-orders-user_data
• https://binance-docs.github.io/apidocs/voptions/en/#query-option-order-history-trade

binance.fetchCanceledOrders(symbol,since,limit,params)

cancels an open order

Kind: instance method ofbinance
Returns:object - Anorder structure

binance.cancelOrder(id,symbol,params)

cancel all open orders in a market

Kind: instance method ofbinance
Returns:Array.<object> - a list oforder structures
See

• https://binance-docs.github.io/apidocs/spot/en/#cancel-all-open-orders-on-a-symbol-trade
• https://binance-docs.github.io/apidocs/futures/en/#cancel-all-open-orders-trade
• https://binance-docs.github.io/apidocs/delivery/en/#cancel-all-open-orders-trade
• https://binance-docs.github.io/apidocs/voptions/en/#cancel-all-option-orders-on-specific-symbol-trade
• https://binance-docs.github.io/apidocs/spot/en/#margin-account-cancel-order-trade

binance.cancelAllOrders(symbol,params)

fetch all the trades made from a single order

Kind: instance method ofbinance
Returns:Array.<object> - a list oftrade structures

binance.fetchOrderTrades(id,symbol,since,limit,params)

fetch all trades made by the user

Kind: instance method ofbinance
Returns:Array.<object> - a list oftrade structures

binance.fetchMyTrades(symbol,since,limit,params)

fetch all dust trades made by the user

Kind: instance method ofbinance
Returns:Array.<object> - a list oftrade structures

binance.fetchMyDustTrades(symbol,since,limit,params)

fetch all deposits made to an account

Kind: instance method ofbinance
Returns:Array.<object> - a list oftransaction structures

binance.fetchDeposits(code,since,limit,params)

fetch all withdrawals made from an account

Kind: instance method ofbinance
Returns:Array.<object> - a list oftransaction structures

binance.fetchWithdrawals(code,since,limit,params)

transfer currency internally between wallets on the same account

Kind: instance method ofbinance
Returns:object - atransfer structure
See

• https://binance-docs.github.io/apidocs/spot/en/#user-universal-transfer-user_data
• https://binance-docs.github.io/apidocs/spot/en/#isolated-margin-account-transfer-margin

binance.transfer(code,amount,fromAccount,toAccount,params)

fetch a history of internal transfers made on an account

Kind: instance method ofbinance
Returns:Array.<object> - a list oftransfer structures

binance.fetchTransfers(code,since,limit,params)

fetch the deposit address for a currency associated with this account

Kind: instance method ofbinance
Returns:object - anaddress structure

binance.fetchDepositAddress(code,params)

DEPRECATED please use fetchDepositWithdrawFees instead

Kind: instance method ofbinance
Returns:Array.<object> - a list offee structures

binance.fetchTransactionFees(codes,params)

fetch deposit and withdraw fees

Kind: instance method ofbinance
Returns:Array.<object> - a list offee structures

binance.fetchDepositWithdrawFees(codes,params)

make a withdrawal

Kind: instance method ofbinance
Returns:object - atransaction structure

binance.withdraw(code,amount,address,tag,params)

fetch the trading fees for a market

Kind: instance method ofbinance
Returns:object - afee structure

binance.fetchTradingFee(symbol,params)

fetch the trading fees for multiple markets

Kind: instance method ofbinance
Returns:object - a dictionary offee structures indexed by market symbols

binance.fetchTradingFees(params)

transfer between futures account

Kind: instance method ofbinance
Returns:object - atransfer structure

binance.futuresTransfer(code,amount,type,params)

fetch the current funding rate

Kind: instance method ofbinance
Returns:object - afunding rate structure

binance.fetchFundingRate(symbol,params)

fetches historical funding rate prices

Kind: instance method ofbinance
Returns:Array.<object> - a list offunding rate structures

binance.fetchFundingRateHistory(symbol,since,limit,params)

fetch the funding rate for multiple markets

Kind: instance method ofbinance
Returns:object - a dictionary offunding rates structures, indexe by market symbols

binance.fetchFundingRates(symbols,params)

retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes

Kind: instance method ofbinance
Returns:object - a dictionary ofleverage tiers structures, indexed by market symbols

binance.fetchLeverageTiers(symbols,params)

fetch data on an open position

Kind: instance method ofbinance
Returns:object - aposition structure
See:https://binance-docs.github.io/apidocs/voptions/en/#option-position-information-user_data

binance.fetchPosition(symbol,params)

fetch data on open options positions

Kind: instance method ofbinance
Returns:Array.<object> - a list ofposition structures
See:https://binance-docs.github.io/apidocs/voptions/en/#option-position-information-user_data

binance.fetchOptionPositions(symbols,params)

fetch all open positions

Kind: instance method ofbinance
Returns:Array.<object> - a list ofposition structure

binance.fetchPositions(symbols,params)

fetch account positions

Kind: instance method ofbinance
Returns:object - data on account positions

binance.fetchAccountPositions(symbols,params)

fetch positions risk

Kind: instance method ofbinance
Returns:object - data on the positions risk

binance.fetchPositionsRisk(symbols,params)

fetch the history of funding payments paid and received on this account

Kind: instance method ofbinance
Returns:object - afunding history structure

binance.fetchFundingHistory(symbol,since,limit,params)

set the level of leverage for a market

Kind: instance method ofbinance
Returns:object - response from the exchange

binance.setLeverage(leverage,symbol,params)

set margin mode to 'cross' or 'isolated'

Kind: instance method ofbinance
Returns:object - response from the exchange

binance.setMarginMode(marginMode,symbol,params)

set hedged to true or false for a market

Kind: instance method ofbinance
Returns:object - response from the exchange

binance.setPositionMode(hedged,symbol,params)

fetches historical settlement records

Kind: instance method ofbinance
Returns:Array.<object> - a list of [settlement history objects]
See:https://binance-docs.github.io/apidocs/voptions/en/#historical-exercise-records

binance.fetchSettlementHistory(symbol,since,limit,params)

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

Kind: instance method ofbinance
Returns:object - aledger structure
See

• https://binance-docs.github.io/apidocs/voptions/en/#account-funding-flow-user_data
• https://binance-docs.github.io/apidocs/futures/en/#get-income-history-user_data
• https://binance-docs.github.io/apidocs/delivery/en/#get-income-history-user_data

binance.fetchLedger(code,since,limit,params)

remove margin from a position

Kind: instance method ofbinance
Returns:object - amargin structure
See

• https://binance-docs.github.io/apidocs/delivery/en/#modify-isolated-position-margin-trade
• https://binance-docs.github.io/apidocs/futures/en/#modify-isolated-position-margin-trade

binance.reduceMargin(symbol,amount,params)

add margin

Kind: instance method ofbinance
Returns:object - amargin structure
See

• https://binance-docs.github.io/apidocs/delivery/en/#modify-isolated-position-margin-trade
• https://binance-docs.github.io/apidocs/futures/en/#modify-isolated-position-margin-trade

binance.addMargin(symbol,amount,params)

fetch the rate of interest to borrow a currency for margin trading

Kind: instance method ofbinance
Returns:object - aborrow rate structure

binance.fetchBorrowRate(code,params)

retrieves a history of a currencies borrow interest rate at specific time slots

Kind: instance method ofbinance
Returns:Array.<object> - an array ofborrow rate structures

binance.fetchBorrowRateHistory(code,since,limit,params)

create gift code

Kind: instance method ofbinance
Returns:object - The gift code id, code, currency and amount

binance.createGiftCode(code,amount,params)

redeem gift code

Kind: instance method ofbinance
Returns:object - response from the exchange

binance.redeemGiftCode(giftcardCode,params)

verify gift code

Kind: instance method ofbinance
Returns:object - response from the exchange

binance.verifyGiftCode(id,params)

fetch the interest owed by the user for borrowing currency for margin trading

Kind: instance method ofbinance
Returns:Array.<object> - a list ofborrow interest structures

binance.fetchBorrowInterest(code,symbol,since,limit,params)

repay borrowed margin and interest

Kind: instance method ofbinance
Returns:object - amargin loan structure
See:https://binance-docs.github.io/apidocs/spot/en/#margin-account-repay-margin

binance.repayMargin(code,amount,symbol,params)

create a loan to borrow margin

Kind: instance method ofbinance
Returns:object - amargin loan structure
See:https://binance-docs.github.io/apidocs/spot/en/#margin-account-borrow-margin

binance.borrowMargin(code,amount,symbol,params)

Retrieves the open interest history of a currency

Kind: instance method ofbinance
Returns:object - an array ofopen interest history structure

binance.fetchOpenInterestHistory(symbol,timeframe,since,limit,params)

retrieves the open interest of a contract trading pair

Kind: instance method ofbinance
Returns:object - an open interest structurehttps://docs.ccxt.com/#/?id=interest-history-structure
See

• https://binance-docs.github.io/apidocs/futures/en/#open-interest
• https://binance-docs.github.io/apidocs/delivery/en/#open-interest
• https://binance-docs.github.io/apidocs/voptions/en/#open-interest

binance.fetchOpenInterest(symbol,params)

Kind: global class
Extends:Exchange

• fetchBalance
• fetchOrderBook
• fetchTicker
• fetchTrades
• fetchTradingFees
• createOrder
• cancelOrder
• fetchOpenOrders
• fetchOrder
• fetchMyTrades
• fetchDepositAddress

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

Kind: instance method ofbit2c
Returns:object - abalance structure

bit2c.fetchBalance(params)

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

Kind: instance method ofbit2c
Returns:object - A dictionary oforder book structures indexed by market symbols

bit2c.fetchOrderBook(symbol,limit,params)

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

Kind: instance method ofbit2c
Returns:object - aticker structure

bit2c.fetchTicker(symbol,params)

get the list of most recent trades for a particular symbol

Kind: instance method ofbit2c
Returns:Array.<object> - a list oftrade structures