btse

🔌 Looking for raw exchange endpoints? See the btse implicit API — every endpoint in this exchange's API exposed as an implicit method.

btse

Kind: global class
Extends: Exchange

• fetchTime
• fetchMarkets
• fetchOHLCV
• fetchOrderBook
• fetchFundingRateHistory
• fetchBalance
• fetchLeverageTiers
• fetchMarketLeverageTiers
• fetchTickers
• fetchTicker
• fetchOpenInterest
• fetchOpenInterests
• fetchFundingRate
• fetchFundingRates
• fetchTrades
• fetchMyTrades
• fetchOrderTrades
• createOrder
• createSpotOrder
• createContractOrder
• fetchOpenOrder
• editOrder
• cancelOrder
• cancelAllOrders
• cancelAllOrdersAfter
• fetchOpenOrders
• fetchTradingFees
• fetchDepositsWithdrawals
• fetchDeposits
• fetchWithdrawals
• fetchLedger
• fetchTradingFee
• fetchPositions
• fetchPositionsForSymbol
• fetchPositionMode
• setPositionMode
• fetchMarginMode
• setMarginMode
• closePosition
• fetchLeverage
• setLeverage

fetchTime

fetches the current integer timestamp in milliseconds from the exchange server

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

See: https://btsecom.github.io/docs/spotV3_3/en/#query-server-time

btse.fetchTime (params?)

fetchMarkets

retrieves data on all markets for btse

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

See: https://docs.btse.com/markets/rest/get-markets/

btse.fetchMarkets (params?)

fetchOHLCV

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

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

See: https://docs.btse.com/markets/rest/get-klines/

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

fetchOrderBook

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

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

See: https://docs.btse.com/markets/rest/get-orderbook/

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

fetchFundingRateHistory

fetches historical funding rate prices

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

See: https://docs.btse.com/markets/rest/get-funding-rate-history/

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

fetchBalance

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

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

See

• https://docs.btse.com/wallet/rest/get-user-assets/
• https://btsecom.github.io/docs/futuresV2_3/en/#query-wallet-balance

btse.fetchBalance (params?)

fetchLeverageTiers

retrieve information on the maximum leverage, for different trade sizes

Kind: instance method of btse
Returns: object - a dictionary of leverage tiers structures, indexed by market symbols

See: https://docs.btse.com/markets/rest/get-market-risk-limits/

btse.fetchLeverageTiers (symbols, params?)

fetchMarketLeverageTiers

retrieve information on the maximum leverage, for different trade sizes for a single market

Kind: instance method of btse
Returns: object - a leverage tiers structure

See: https://docs.btse.com/markets/rest/get-market-risk-limits/

btse.fetchMarketLeverageTiers (symbol, params?)

fetchTickers

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

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

See: https://docs.btse.com/markets/rest/get-24-hr-ticker/

btse.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 btse
Returns: object - a ticker structure

See: https://docs.btse.com/markets/rest/get-24-hr-ticker/

btse.fetchTicker (symbol, params?)

fetchOpenInterest

Retrieves the open interest of a derivative trading pair

Kind: instance method of btse
Returns: object - an open interest structure/docs/manual#interest-history-structure

See: https://docs.btse.com/markets/rest/get-24-hr-ticker/

btse.fetchOpenInterest (symbol, params?)

fetchOpenInterests

Retrieves the open interest for a list of symbols

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

See: https://docs.btse.com/markets/rest/get-24-hr-ticker/

btse.fetchOpenInterests (symbols?, params?)

fetchFundingRate

fetch the current funding rate

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

See: https://docs.btse.com/markets/rest/get-24-hr-ticker/

btse.fetchFundingRate (symbol, params?)

fetchFundingRates

fetch the funding rate for multiple markets

Kind: instance method of btse
Returns: Array<object> - a list of funding rates structures, indexe by market symbols

See: https://docs.btse.com/markets/rest/get-24-hr-ticker/

btse.fetchFundingRates (symbols, params?)

fetchTrades

get the list of most recent trades for a particular symbol

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

See: https://docs.btse.com/markets/rest/get-trades/

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

fetchMyTrades

fetch all trades made by the user

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

See

• https://docs.btse.com/spot/rest/get-trade-history/
• https://docs.btse.com/futures/rest/get-trade-history/

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

fetchOrderTrades

fetch all the trades made from a single order

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

See

• https://btsecom.github.io/docs/spotV3_3/en/#query-user-trades-fills
• https://btsecom.github.io/docs/futuresV2_3/en/#query-trades-fills-2

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

createOrder

create a trade order

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

See

• https://btsecom.github.io/docs/spotV3_3/en/#create-new-order
• https://btsecom.github.io/docs/futuresV2_3/en/#create-new-order
• https://btsecom.github.io/docs/futuresV2_3/en/#create-new-algo-order

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

createSpotOrder

create a trade order on spot market

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

See

• https://docs.btse.com/spot/rest/place-order
• https://docs.btse.com/spot/rest/place-algo-order

btse.createSpotOrder (symbol, type, side, amount, price?, params?)

createContractOrder

create a trade order on contract market

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

See

• https://docs.btse.com/futures/rest/place-order
• https://docs.btse.com/futures/rest/place-algo-order

btse.createContractOrder (symbol, type, side, amount, price?, params?)

fetchOpenOrder

fetches information on an open order made by the user

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

See

• https://docs.btse.com/spot/rest/get-order
• https://docs.btse.com/futures/rest/get-orders

btse.fetchOpenOrder (id, symbol?, params?)

editOrder

edit a trade order

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

See

• https://docs.btse.com/spot/rest/amend-order
• https://docs.btse.com/futures/rest/amend-order

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

cancelOrder

cancels an open order

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

See

• https://docs.btse.com/spot/rest/cancel-order
• https://docs.btse.com/futures/rest/cancel-order

btse.cancelOrder (id, symbol, params?)

cancelAllOrders

cancel all open orders in a market

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

See

• https://docs.btse.com/spot/rest/cancel-all-orders
• https://btsecom.github.io/docs/futuresV2_3/en/#cancel-order

btse.cancelAllOrders (symbol?, params?)

cancelAllOrdersAfter

dead man's switch, cancel all orders after the given timeout

Kind: instance method of btse
Returns: object - the api result

See

• https://docs.btse.com/spot/rest/cancel-all-after
• https://docs.btse.com/futures/rest/cancel-all-after

btse.cancelAllOrdersAfter (timeout, params?)

fetchOpenOrders

fetch all unfilled currently open orders

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

See

• https://docs.btse.com/spot/rest/get-orders
• https://docs.btse.com/futures/rest/get-orders

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

fetchTradingFees

fetch the trading fees for multiple markets

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

See

• https://docs.btse.com/spot/rest/get-fees
• https://btsecom.github.io/docs/futuresV2_3/en/#query-account-fee

btse.fetchTradingFees (params?)

fetchDepositsWithdrawals

fetch history of deposits and withdrawals

Kind: instance method of btse
Returns: Array<object> - a list of transaction structures

See: https://docs.btse.com/wallet/rest/get-user-wallet-history

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

fetchDeposits

fetch all deposits made to an account

Kind: instance method of btse
Returns: Array<object> - a list of transaction structures

See: https://docs.btse.com/wallet/rest/get-user-wallet-history

btse.fetchDeposits (code?, since?, limit?, params?)

fetchWithdrawals

fetch all withdrawals made from an account

Kind: instance method of btse
Returns: Array<object> - a list of transaction structures

See: https://docs.btse.com/wallet/rest/get-user-wallet-history

btse.fetchWithdrawals (code?, since?, limit?, 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 btse
Returns: Array<object> - a list of ledger structures

See: https://docs.btse.com/wallet/rest/get-user-wallet-history

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

fetchTradingFee

fetch the trading fees for a market

Kind: instance method of btse
Returns: object - a fee structure

See

• https://docs.btse.com/spot/rest/get-fees
• https://btsecom.github.io/docs/futuresV2_3/en/#query-account-fee

btse.fetchTradingFee (symbol, params?)

fetchPositions

fetch all open positions

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

See: https://docs.btse.com/futures/rest/get-positions/

btse.fetchPositions (symbols?, params?)

fetchPositionsForSymbol

fetch all open positions for specific symbol

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

See: https://docs.btse.com/futures/rest/get-positions/

btse.fetchPositionsForSymbol (symbol, params?)

fetchPositionMode

fetchs the position mode, hedged or one way, hedged for btse is set identically for all linear markets or all inverse markets

Kind: instance method of btse
Returns: object - an object detailing whether the market is in hedged or one-way mode

See: https://docs.btse.com/futures/rest/get-position-mode

btse.fetchPositionMode (symbol, params?)

setPositionMode

NB!!! This method also sets margin mode to cross on btse. Set hedged to true or false for a cross-margin market.

Kind: instance method of btse
Returns: object - response from the exchange

See: https://docs.btse.com/futures/rest/change-position-mode

btse.setPositionMode (hedged, symbol, params?)

fetchMarginMode

fetches the margin mode of a specific symbol

Kind: instance method of btse
Returns: object - a margin mode structure

See: https://docs.btse.com/futures/rest/get-leverage

btse.fetchMarginMode (symbol, params?)

setMarginMode

set margin mode to 'cross' or 'isolated'

Kind: instance method of btse
Returns: object - response from the exchange

See: https://docs.btse.com/futures/rest/change-position-mode

btse.setMarginMode (marginMode, symbol, params?)

closePosition

closes an open position for a market

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

See: https://docs.btse.com/futures/rest/close-position/

btse.closePosition (symbol, side?, params?)

fetchLeverage

fetch the leverage for a market

Kind: instance method of btse
Returns: object - a leverage structure

See: https://docs.btse.com/futures/rest/get-leverage

btse.fetchLeverage (symbol, params?)

setLeverage

set the level of leverage for a market

Kind: instance method of btse
Returns: object - response from the exchange

See: https://docs.btse.com/futures/rest/change-leverage

btse.setLeverage (leverage, symbol, params?)