CCXT

API Spec by Method

CCXT unified API specification — every method and the exchanges that implement it.

addMargin

add margin

Kind: instance
Returns: object - a margin structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
amountfloatYesamount of margin to add
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance bitget delta digifinex gate hashkey hitbtc hyperliquid kucoin lighter mexc mudrex okx poloniex polymarket weex woo woofipro xt zebpay


approveBuilderCode

approves a builder code to charge fees on the account orders

Kind: instance
Returns: object - the api result

ParamTypeRequiredDescription
builderCodestringYesthe builder code to approve
maxFeeRatestringYesthe maximum fee rate the builder may charge
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: pacifica


bindAgentWallet

binds an agent wallet that can sign trading actions for the account

Kind: instance
Returns: object - the api result

ParamTypeRequiredDescription
agentAddressstringYesthe public key of the agent wallet
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: pacifica


borrowCrossMargin

create a loan to borrow margin

Kind: instance
Returns: object - a margin loan structure

ParamTypeRequiredDescription
codestringYesunified currency code of the currency to borrow
amountfloatYesthe amount to borrow
paramsobjectNoextra parameters specific to the exchange API endpoint
params.portfolioMarginbooleanNoset to true if you would like to borrow margin in a portfolio margin account

Supported exchanges: binance bitget bybit gate htx kucoin okx


borrowIsolatedMargin

create a loan to borrow margin

Kind: instance
Returns: object - a margin loan structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol, required for isolated margin
codestringYesunified currency code of the currency to borrow
amountfloatYesthe amount to borrow
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitget gate htx kucoin


calculateFee

calculates the presumptive fee that would be charged for an order

Kind: instance
Returns: object - contains the rate, the percentage multiplied to the order amount to obtain the fee amount, and cost, the total value of the fee in units of the quote currency, for the order

ParamTypeDescription
symbolstringunified market symbol
typestringnot used by btcmarkets.calculateFee
sidestringnot used by btcmarkets.calculateFee
amountfloathow much you want to trade, in units of the base currency on most exchanges, or number of contracts
pricefloatthe price for the order to be filled at, in units of the quote currency
takerOrMakerstring'taker' or 'maker'
paramsobject

Supported exchanges: btcmarkets


calculatePricePrecision

Helper function to calculate the Hyperliquid DECIMAL_PLACES price precision

Kind: instance
Returns: int - The calculated price precision

ParamTypeDescription
pricefloatthe price to use in the calculation
amountPrecisionintthe amountPrecision to use in the calculation
maxDecimalsintthe maxDecimals to use in the calculation

Supported exchanges: hyperliquid


cancelAllContractOrders

helper method for cancelling all contract orders

Kind: instance
Returns: Response from the exchange

ParamTypeRequiredDescription
symbolstringYesunified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
paramsobjectNoextra parameters specific to the exchange API endpoint
params.triggerobjectNoWhen true, all the trigger orders will be cancelled

Supported exchanges: kucoin


cancelAllOrders

cancel all open orders in a market

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

ParamTypeRequiredDescription
symbolstringNoalpaca cancelAllOrders cannot setting symbol, it will cancel all open orders
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack bigone binance bingx bitfinex bitget bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom btse bullish bybit cex coinbaseexchange coinbaseinternational coinsph cryptocom deepcoin delta deribit derive extended foxbit gate grvt hashkey hibachi hitbtc hollaex htx kraken krakenfutures kucoin latoken lbank lighter mexc modetrade nado ndax onetrading pacifica paradex phemex poloniex polymarket revolutx toobit weex whitebit woo woofipro xt zebpay


cancelAllOrdersAfter

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

Kind: instance
Returns: object - the api result

ParamTypeRequiredDescription
timeoutnumberYestime in milliseconds, 0 represents cancel the timer
paramsobjectNoextra parameters specific to the exchange API endpoint
params.typestringNospot or swap market
params.subTypestringNo'linear' or 'inverse' (default is 'linear'), 'inverse' is not supported

Supported exchanges: bingx bitvavo btse bybit extended htx hyperliquid kraken krakenfutures lighter okx polymarket whitebit woo


cancelAllOrdersWs

cancel all open orders in a market

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

ParamTypeRequiredDescription
symbolstringNounified market symbol of the market to cancel orders in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitvavo coinbaseinternational cryptocom gate lighter nado okx pacifica


cancelAllSpotOrders

helper method for cancelling all spot orders

Kind: instance
Returns: Response from the exchange

ParamTypeRequiredDescription
symbolstringYesunified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
paramsobjectNoextra parameters specific to the exchange API endpoint
params.triggerboolNoinvalid for isolated margin true if cancelling all stop orders
params.marginModestringNo'cross' or 'isolated'
params.orderIdsstringNostop orders only Comma separated order IDs
params.hfboolNofalse, // true for hf order

Supported exchanges: kucoin


cancelAllUtaOrders

helper method for cancelling all uta orders

Kind: instance
Returns: Response from the exchange

ParamTypeRequiredDescription
symbolstringYesunified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
paramsobjectNoextra parameters specific to the exchange API endpoint
params.triggerboolNotrue if cancelling all stop orders
params.marginModestringNo'CROSS' or 'ISOLATED'

Supported exchanges: kucoin


cancelContractOrder

helper method for cancelling contract orders

Kind: instance
Returns: object - An order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint
params.clientOrderIdstringNocancel order by client order id

Supported exchanges: kucoin


cancelOrder

cancels an open order

Kind: instance
Returns: object - An order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coincheck coinmate coinone coinsph coinspot cryptocom cryptomus deepcoin delta deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade mudrex nado ndax okx onetrading p2b pacifica paradex paymium phemex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zaif zebpay


cancelOrderWs

cancel multiple orders

Kind: instance
Returns: object - an list of order structures

ParamTypeRequiredDescription
idstringYesorder id
symbolstringNounified market symbol, default is undefined
paramsobjectNoextra parameters specific to the exchange API endpoint
params.cancelRestrictionsstring, undefinedNoSupported values: ONLY_NEW - Cancel will succeed if the order status is NEW. ONLY_PARTIALLY_FILLED - Cancel will succeed if order status is PARTIALLY_FILLED.
params.triggerbooleanNoset to true if you would like to cancel a conditional order

Supported exchanges: binance bitvavo bybit cex coinbaseinternational cryptocom gate hyperliquid lighter nado okx pacifica


cancelOrders

cancel multiple orders

Kind: instance
Returns: object - an list of order structures

ParamTypeRequiredDescription
idsArray<string>Yesorder ids
symbolstringNounified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint EXCHANGE SPECIFIC PARAMETERS
params.origClientOrderIdListArray<string>Nomax length 10 e.g. ["my_id_1","my_id_2"], encode the double quotes. No space after comma
params.recvWindowArray<int>No

Supported exchanges: aster binance bingx bitfinex bitget bithumb bitopro bitso bittrade blofin btcmarkets bybit coinbase cryptocom deepcoin digifinex dydx extended gate hashkey hibachi htx hyperliquid kraken krakenfutures kucoin mexc modetrade nado okx onetrading pacifica paradex poloniex polymarket toobit weex woofipro xt


cancelOrdersForSymbols

cancel multiple orders for multiple symbols

Kind: instance
Returns: object - an list of order structures

ParamTypeRequiredDescription
ordersArray<CancellationRequest>Yeslist of order ids with symbol, example [{"id": "a", "symbol": "BTC/USDT"}, {"id": "b", "symbol": "ETH/USDT"}]
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bybit cryptocom digifinex gate hyperliquid okx


cancelOrdersRequest

build the request payload for cancelling multiple orders

Kind: instance
Returns: object - the raw request object to be sent to the exchange

ParamTypeRequiredDescription
idsArray<string>Yesorder ids
symbolstringYesunified market symbol
paramsobjectNo
params.fastbooleanNowhether to send the cancel with the fast flag, rejected for trigger orders, (default is false)

Supported exchanges: hyperliquid


cancelOrdersWs

cancel multiple orders

Kind: instance
Returns: object - a list of order structures

ParamTypeRequiredDescription
idsArray<string>Yesorder ids
symbolstringYesnot used by cancelOrders()
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: cex hyperliquid nado okx pacifica


cancelSpotOrder

helper method for cancelling spot orders

Kind: instance
Returns: Response from the exchange

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint
params.triggerboolNoTrue if cancelling a stop order
params.hfboolNofalse, // true for hf order
params.syncboolNofalse, // true to use the hf sync call
params.marginModestringNo'cross' or 'isolated'

Supported exchanges: kucoin


cancelTwapOrder

cancels a running twap order

Kind: instance
Returns: object - An order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint
params.expiresAfterintNotime in ms after which the twap order expires
params.vaultAddressstringNothe vault address for order

Supported exchanges: hyperliquid


cancelUtaOrder

helper method for cancelling uta orders

Kind: instance
Returns: Response from the exchange

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint
params.accountModestringNo'unified' or 'classic' (default is 'unified')
params.clientOrderIdstringNoclient order id, required if id is not provided
params.marginModestringNo'cross' or 'isolated', required if fetching a margin order (unified accountMode supports only cross margin)

Supported exchanges: kucoin


closeAllPositions

closes open positions for a market

Kind: instance
Returns: Array<object> - a list of position structures

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.recvWindowstringNorequest valid time window value

Supported exchanges: bingx bitget delta mexc weex


closePosition

closes open positions for a market

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesUnified CCXT market symbol
sidestringNonot used by bingx
paramsobjectNoextra parameters specific to the exchange API endpoint
params.positionIdstring, undefinedNothe id of the position you would like to close, only supported for linear swap

Supported exchanges: bingx bitget blofin btse coinbase cryptocom deepcoin gate hitbtc htx kucoin mudrex okx weex zebpay


createApiKey

creates an api key for the account

Kind: instance
Returns: object - the api result

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: pacifica


createContractOrder

create a trade order on contract market

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
typestringYes'market', 'limit', 'OCO', 'PEG', 'TWAP' or 'TRAILING'
sidestringYes'buy' or 'sell'
amountfloatYeshow much of you want to trade in units of the base currency
pricefloatNothe price that the order is to be fulfilled, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint
params.clientOrderIdstringNoa unique id for the order
params.postOnlyboolNoif true, the order will only be posted to the order book and not executed immediately, default is false
params.reduceOnlyboolNoif true, the order will only reduce a current position, not increase it, default is false
params.timeInForcestringNo'GTC', 'IOC', 'FOK', 'PO', 'HALFSEC', 'HALFMIN', 'FIVEMIN', 'HOUR', 'TWELVEHOUR', 'DAY', 'WEEK' or 'MONTH'
params.hedgedboolNotrue for hedged mode, false for one way mode, default is false
params.marginModestringNo'cross' or 'isolated', default is 'cross' - the exchange does not have cross/isolated margin modes but instead has 'ONE_WAY', 'HEDGE' and 'ISOLATED' position modes, so this param will be converted to the appropriate position mode
params.positionModestringNo'ONE_WAY', 'HEDGE' or 'ISOLATED' - if not provided, it will be derived from the marginMode and hedged params
params.triggerPricefloatNothe price that a trigger order is triggered at, same as takeProfitPrice
params.stopLossPricefloatNothe price that a stop loss order is triggered at
params.takeProfitPricefloatNothe price that a take profit order is triggered at
params.triggerPriceTypestringNo'last', 'mark' or 'index', default is 'mark'
params.trailingAmountfloatNothe quote amount to trail away from the current market price
params.trailingPercentfloatNothe percent to trail away from the current market price
params.takeProfitobjectNotakeProfit object in params containing the triggerPrice at which the attached take profit order will be triggered
params.takeProfit.triggerPricefloatNotake profit trigger price
params.takeProfit.priceTypestringNo'last', 'mark' or 'index', default is 'mark'
params.stopLossobjectNostopLoss object in params containing the triggerPrice at which the attached stop loss order will be triggered
params.stopLoss.triggerPricefloatNostop loss trigger price
params.stopLoss.priceTypestringNo'last', 'mark' or 'index', default is 'mark'
params.deviationfloatNoPEG orders only the offset applied to the pegged reference price
params.stealthfloatNoPEG orders only the portion of the order size displayed on the book
params.stopPricefloatNoNB - It is NOT the stopLossPrice!!! OCO orders only the limit price of the stop loss leg

Supported exchanges: btse kucoin weex


createContractOrders

helper method for creating contract orders in batch

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
ordersArrayYeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: kucoin


createConvertTrade

converts between a tokenized stock and its quote currency through a bounded RFQ

Kind: instance
Returns: object - conversion result; RFQ submission may remain open and is not necessarily a fill

ParamTypeRequiredDescription
idstringYesRFQ identifier when accepting a quote, or a numeric client identifier for a new RFQ
fromCodestringYesthe currency to convert from
toCodestringYesthe currency to convert to
amountfloatNoamount in units of the from currency
paramsobjectNoextra parameters specific to the exchange API endpoint
params.quoteIdstringNoaccept this quote for RFQ id supplied as id
params.pricefloatNoprice bound from fetchConvertQuote; required when buying stock
params.baseAmountfloatNostock quantity when converting quote currency to stock
params.clientOrderIdintNorequester client identifier for a newly submitted RFQ

Supported exchanges: backpack binance bitget bybit coinbase okx phemex whitebit woo


createDepositAddress

create a currency deposit address

Kind: instance
Returns: object - an address structure

ParamTypeRequiredDescription
codestringYesunified currency code of the currency for the deposit address
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bitfinex bithumb coinbase coinbaseexchange deribit gemini hitbtc kraken kucoin luno mexc ndax paymium poloniex upbit whitebit


createGiftCode

create gift code

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

ParamTypeRequiredDescription
codestringYesgift code
amountfloatYesamount of currency for the gift
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance


createMarketBuyOrderWithCost

create a market buy order by providing the symbol and cost

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
costfloatYeshow much you want to trade in units of the quote currency
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca bigone binance bingx bitget bithumb bitrue bittrade bybit coinbase deepcoin digifinex gate hashkey htx kraken kucoin lbank mexc okx whitebit woo xt


createMarketOrderWithCost

create a market order by providing the symbol, side and cost

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
sidestringYes'buy' or 'sell'
costfloatYeshow much you want to trade in units of the quote currency
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca binance bingx deepcoin kraken kucoin whitebit


createMarketSellOrderWithCost

create a market sell order by providing the symbol and cost

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
costfloatYeshow much you want to trade in units of the quote currency
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca binance bingx bybit deepcoin kucoin mexc okx woo


createOrder

create a trade order

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
typestringYes'market', 'limit' or 'stop_limit'
sidestringYes'buy' or 'sell'
amountfloatYeshow much of currency you want to trade in units of base currency
pricefloatNothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint
params.triggerPricefloatNoThe price at which a trigger order is triggered at
params.timeInForcestringNo'GTC' or 'IOC', the venue supports only these two for crypto orders, defaults to 'GTC'
params.costfloatNomarket orders only the cost of the order in units of the quote currency

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coincheck coinmate coinone coinsph coinspot cryptocom cryptomus deepcoin delta deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade mudrex nado ndax okx onetrading p2b pacifica paradex paymium phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zaif zebpay


createOrderWs

create a trade order

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
typestringYes'market' or 'limit'
sidestringYes'buy' or 'sell'
amountfloatYeshow much of currency you want to trade in units of base currency
pricefloat, undefinedNothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint
params.testbooleanYestest order, default false
params.returnRateLimitsbooleanYesset to true to return rate limit information, default false

Supported exchanges: binance bitvavo bybit cex coinbaseinternational cryptocom gate hyperliquid lighter nado okx pacifica


createOrders

create a list of trade orders

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
ordersArrayYeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bingx bitfinex bitget bithumb blofin bybit cryptocom digifinex foxbit gate hashkey hibachi htx hyperliquid kraken krakenfutures kucoin mexc modetrade okx pacifica paradex poloniex polymarket woofipro


createOrdersRequest

create a list of trade orders

Kind: instance
Returns: object - an order structure

ParamTypeDescription
ordersArraylist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params

Supported exchanges: hyperliquid


createOrdersWs

create a list of trade orders

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
ordersArrayYeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: gate hyperliquid


createProxyCredentials

provisions fresh trading session credentials - generates a proxy keypair, registers it with an EIP-712 CreateProxy message signed by the wallet key and caches the returned secret, the venue keeps the session valid for the requested lifetime

Kind: instance
Returns: object - the session credentials, holding the proxy address, the proxy private key, the secret and the expiry timestamp

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: polymarket


createSpotOrder

create a trade order on spot market

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
typestringYes'market', 'limit', 'OCO', 'PEG', 'TWAP' or 'TRAILING'
sidestringYes'buy' or 'sell'
amountfloatYeshow much of you want to trade in units of the base currency
pricefloatNothe price that the order is to be fulfilled, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint
params.clientOrderIdstringNoa unique id for the order
params.postOnlyboolNoif true, the order will only be posted to the order book and not executed immediately, default is false
params.timeInForcestringNo'GTC', 'IOC' or 'FOK'
params.costfloatNomarket buy and trailing buy orders only the quote quantity that can be used as an alternative for the amount
params.triggerPricefloatNothe price that a trigger order is triggered at, same as takeProfitPrice
params.stopLossPricefloatNothe price that a stop loss order is triggered at
params.takeProfitPricefloatNothe price that a take profit order is triggered at
params.triggerPriceTypestringNo'last', 'mark' or 'index', default is 'last'
params.trailingAmountfloatNothe quote amount to trail away from the current market price
params.trailingPercentfloatNothe percent to trail away from the current market price
params.deviationfloatNoPEG orders only how much should the order price deviate from the pegged price, in percent from -10 to 10
params.stealthfloatNoPEG orders only how many percent of the order is to be displayed on the orderbook, from 1 to 100
params.stopPricefloatNoNB - It is NOT stopLossPrice or triggerPrice!!! OCO orders only the limit price of the stop loss leg

Supported exchanges: btse hashkey kucoin weex


createSpotOrders

helper method for creating spot orders in batch

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
ordersArrayYeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
paramsobjectNoextra parameters specific to the exchange API endpoint
params.hfboolNofalse, // true for hf orders
params.syncboolNofalse, // true to use the hf sync call

Supported exchanges: kucoin


createSubAccount

creates a sub-account under the main account

Kind: instance
Returns: object - a response object

ParamTypeRequiredDescription
namestringYesthe name of the sub-account
paramsobjectNoextra parameters specific to the exchange API endpoint
params.expiresAfterintNotime in ms after which the sub-account will expire

Supported exchanges: hyperliquid pacifica


createSwapOrder

create a trade order on swap market

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
typestringYes'market' or 'limit' or 'STOP'
sidestringYes'buy' or 'sell'
amountfloatYeshow much of you want to trade in units of the base currency
pricefloatNothe price that the order is to be fulfilled, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint
params.postOnlyboolNoif true, the order will only be posted to the order book and not executed immediately
params.reduceOnlyboolNotrue or false whether the order is reduce only
params.triggerPricefloatNoThe price at which a trigger order is triggered at
params.timeInForcestringNo'GTC', 'FOK', 'IOC', 'LIMIT_MAKER' or 'PO'
params.clientOrderIdstringNoa unique id for the order

Supported exchanges: hashkey


createTrailingAmountOrder

create a trailing order by providing the symbol, type, side, amount, price and trailingAmount

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
typestringYes'market' or 'limit'
sidestringYes'buy' or 'sell'
amountfloatYeshow much you want to trade in units of the base currency, or number of contracts
pricefloatNothe price for the order to be filled at, in units of the quote currency, ignored in market orders
trailingAmountfloatYesthe quote amount to trail away from the current market price
trailingTriggerPricefloatYesthe price to activate a trailing order, default uses the price argument
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: woo


createTrailingPercentOrder

create a trailing order by providing the symbol, type, side, amount, price and trailingPercent

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
typestringYes'market' or 'limit'
sidestringYes'buy' or 'sell'
amountfloatYeshow much you want to trade in units of the base currency, or number of contracts
pricefloatNothe price for the order to be filled at, in units of the quote currency, ignored in market orders
trailingPercentfloatYesthe percent to trail away from the current market price
trailingTriggerPricefloatYesthe price to activate a trailing order, default uses the price argument
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: htx woo


createTwapOrder

create a trade order that is executed as a TWAP order over a specified duration.

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to create an order in
sidestringYes'buy' or 'sell'
amountfloatYeshow much of currency you want to trade in units of base currency, only required for sale
durationintYesthe duration of the TWAP order in milliseconds
paramsobjectNoextra parameters specific to the exchange API endpoint
params.frequencystringYesrequired order interval in seconds, 15, 20, 30, 60 or 120
params.pricestringNoorder price, required for purchase
params.generationintNoonly generation 2 is supported if you want to use the API generation 1 or 2, default is 2

Supported exchanges: bithumb hyperliquid


createUtaOrder

helper method for creating uta orders

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
symbolstringYesUnified CCXT market symbol
typestringYes'limit' or 'market'
sidestringYes'buy' or 'sell'
amountfloatYesthe amount of currency to trade
pricefloatNothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint
params.clientOrderIdstringNoclient order id, defaults to uuid if not passed
params.costfloatNothe cost of the order in units of quote currency
params.timeInForcestringNoGTC, GTD, IOC, FOK or PO
params.postOnlyboolNoPost only flag, invalid when timeInForce is IOC or FOK (default is false)
params.reduceOnlyboolNocontract markets only A mark to reduce the position size only. Set to false by default
params.triggerPricefloatNoThe price a trigger order is triggered at
params.triggerDirectionstringNo'ascending' or 'descending', the direction the triggerPrice is triggered from, requires triggerPrice
params.triggerPriceTypestringNocontract markets only "last", "mark", "index" - defaults to "mark"
params.stopLossPricefloatNoprice to trigger stop-loss orders
params.takeProfitPricefloatNoprice to trigger take-profit orders
params.marginModestringNo'cross' or 'isolated', (default is 'cross' for margin orders, default is 'isolated' for contract orders) Exchange-specific parameters -------------------------------------------------
params.accountModestringNo'unified' or 'classic', default is 'unified'
params.stpstringNo'', // self trade prevention, CN, CO, CB or DC
params.cancelAfterintNoCancel After N Seconds (Calculated from the time of entering the matching engine), only effective when timeInForce is GTD
params.sizeUnitstringNocontracts only 'BASECCY' (amount of base currency) or 'UNIT' (number of contracts), default is 'UNIT' Classic account parameters
params.autoBorrowboolNoclassic margin orders only
params.autoRepayboolNoclassic margin orders only
params.hedgedstringNoclassic contract orders only true for hedged mode, false for one way mode, default is false
params.leverageintNoclassic contract orders with isolated marginMode only Leverage size of the order

Supported exchanges: kucoin


createVault

creates a value

Kind: instance
Returns: object - the api result

ParamTypeRequiredDescription
namestringYesThe name of the vault
descriptionstringYesThe description of the vault
initialUsdnumberYesThe initialUsd of the vault
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: hyperliquid


deposit

make a deposit

Kind: instance
Returns: object - a transaction structure

ParamTypeRequiredDescription
codestringYesunified currency code
amountfloatYesthe amount to deposit
idstringYesthe payment method id to be used for the deposit, can be retrieved from v2PrivateGetPaymentMethods
paramsobjectNoextra parameters specific to the exchange API endpoint
params.accountIdstringNothe id of the account to deposit into

Supported exchanges: coinbase


editContractOrder

edit a trade order

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
idstringYescancel order id
symbolstringYesunified symbol of the market to create an order in
typestringYes'market' or 'limit'
sidestringYes'buy' or 'sell'
amountfloatYeshow much of currency you want to trade in units of base currency
pricefloatNothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint
params.portfolioMarginbooleanNoset to true if you would like to edit an order in a portfolio margin account

Supported exchanges: binance


editOrder

edit a trade order

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringNounified symbol of the market to create an order in
typestringNo'market', 'limit' or 'stop_limit'
sidestringNo'buy' or 'sell'
amountfloatNohow much of the currency you want to trade in units of the base currency
pricefloatNothe price for the order, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint
params.triggerPricestringNothe price to trigger a stop order
params.timeInForcestringNo'GTC' or 'IOC', the venue supports only these two for crypto orders, defaults to 'GTC'
params.clientOrderIdstringNoa unique identifier for the order, automatically generated if not sent

Supported exchanges: alpaca binance bingx bitfinex bitget bitstamp bitvavo btse bullish bybit coinbase coinbaseinternational cryptocom deepcoin delta deribit derive extended foxbit gate hibachi hyperliquid kraken krakenfutures kucoin lighter modetrade mudrex nado ndax okx pacifica paradex phemex poloniex polymarket revolutx upbit whitebit woo woofipro xt


editOrderWs

edit a trade order

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified symbol of the market to create an order in
typestringYes'market' or 'limit'
sidestringYes'buy' or 'sell'
amountfloatYeshow much of the currency you want to trade in units of the base currency
pricefloat, undefinedNothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitvavo bybit cex coinbaseinternational cryptocom gate hyperliquid nado okx pacifica


editOrders

edit a list of trade orders

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
ordersArrayYeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bybit hibachi hyperliquid okx


enableDemoTrading

enables or disables demo trading mode

Kind: instance

ParamTypeRequiredDescription
enablebooleanNotrue if demo trading should be enabled, false otherwise

Supported exchanges: binance bitget bybit


enableUserDexAbstraction

If set, actions on HIP-3 perps will automatically transfer collateral from validator-operated USDC perps balance for HIP-3 DEXs where USDC is the collateral token, and spot otherwise

Kind: instance
Returns: dictionary response from the exchange

ParamTypeRequiredDescription
enabledbooleanYeswhether to enable user dex abstraction
paramsobjectNoextra parameters specific to the exchange API endpoint
params.typestringNo'userDexAbstraction' or 'agentEnableDexAbstraction' default is 'userDexAbstraction'

Supported exchanges: hyperliquid


fetchADLRank

fetches the auto deleveraging rank and risk percentage for a symbol

Kind: instance
Returns: object - an auto de leverage structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the auto deleveraging rank for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance


fetchAccount

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

Kind: instance
Returns: object - a balance structure

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex extended


fetchAccountIdByType

fetch all the accounts by a type and marginModeassociated with a profile

Kind: instance
Returns: object - a dictionary of account structures indexed by the account type

ParamTypeRequiredDescription
typestringYes'spot', 'swap' or 'future
marginModestringNo'cross' or 'isolated'
symbolstringNounified ccxt market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: htx


fetchAccountSettings

fetch account's market settings. Settings are cached for walletAddress. To refresh the cache, call loadAccountSettings with refresh=true

Kind: instance
Returns: object - Dict repacked from list by symbol key

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.accountstringNowill default to walletAddress if not provided

Supported exchanges: pacifica


fetchAccounts

fetch all the accounts associated with a profile

Kind: instance
Returns: object - a dictionary of account structures indexed by the account type

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bittrade bitvavo bullish coinbase coinbaseexchange cryptocom deribit derive dydx extended hashkey htx kucoin lighter luno mexc ndax okx whitebit woo


fetchAllGreeks

fetches all option contracts greeks, financial metrics used to measure the factors that affect the price of an options contract

Kind: instance
Returns: object - a dictionary of greeks structures indexed by market symbol

ParamTypeRequiredDescription
symbolsArray<string>Nounified symbols of the markets to fetch greeks for, all markets are returned if not assigned
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bybit okx paradex


fetchApiKeys

fetches the api keys of the account

Kind: instance
Returns: object - the api result

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: pacifica


fetchBalance

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

Kind: instance
Returns: object - a balance structure. note that info is the composite { account, positions } wrapper of both raw venue payloads, not the bare account payload it was before crypto positions were included — read info['account']['cash'] where info['cash'] used to be read

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coincheck coinmate coinone coinsph coinspot cryptocom cryptomus deepcoin delta deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade mudrex nado ndax okx onetrading p2b pacifica paradex paymium phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zaif zebpay


fetchBalanceWs

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

Kind: instance
Returns: object - a balance structure

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.typestring, undefinedNo'spot', 'margin', 'swap', 'future', 'savings' or 'funding', use params.subType 'inverse' for COIN-M
params.marginModestring, undefinedNo'cross' or 'isolated', for margin trading, uses this.options.defaultMarginMode if not passed, defaults to undefined/None/null
params.symbolsArray<string>, undefinedNounified market symbols, only used in isolated margin mode
params.methodstring, undefinedNomethod to use. Can be account.balance, account.status, v2/account.balance or v2/account.status

Supported exchanges: binance bitvavo cex coinbaseinternational


fetchBidsAsks

fetches the bid and ask price and volume for multiple markets

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

ParamTypeRequiredDescription
symbolsArray<string>, undefinedYesunified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned
paramsobjectNoextra parameters specific to the exchange API endpoint
params.subTypestringNo"linear" or "inverse"

Supported exchanges: aster binance bingx bitrue bybit coinbase kucoinfutures mexc polymarket tokocrypto toobit weex xt


fetchBorrowInterest

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

Kind: instance
Returns: Array<object> - a list of borrow interest structures

ParamTypeRequiredDescription
codestringNounified currency code
symbolstringNounified market symbol when fetch interest in isolated markets
sinceintNothe earliest time in ms to fetch borrrow interest for
limitintNothe maximum number of structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.portfolioMarginbooleanNoset to true if you would like to fetch the borrow interest in a portfolio margin account

Supported exchanges: binance bitget bybit derive gate htx kucoin okx whitebit


fetchBorrowRateHistories

retrieves a history of a multiple currencies borrow interest rate at specific time slots, returns all currencies if no symbols passed, default is undefined

Kind: instance
Returns: object - a dictionary of borrow rate structures indexed by the market symbol

ParamTypeRequiredDescription
codesArray<string>, undefinedYeslist of unified currency codes, default is undefined
sinceintNotimestamp in ms of the earliest borrowRate, default is undefined
limitintNomax number of borrow rate prices to return, default is undefined
paramsobjectNoextra parameters specific to the exchange API endpoint
params.marginModestringNo'cross' or 'isolated' default is 'cross'
params.untilintNothe latest time in ms to fetch entries for

Supported exchanges: kucoin okx


fetchBorrowRateHistory

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

Kind: instance
Returns: Array<object> - an array of borrow rate structures

ParamTypeRequiredDescription
codestringYesunified currency code
sinceintNotimestamp for the earliest borrow rate
limitintNothe maximum number of borrow rate structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bullish bybit derive kucoin okx


fetchBuilderApprovals

fetches the builder codes approved by an account

Kind: instance
Returns: Array<object> - the api result

ParamTypeDescription
addressstringthe account address

Supported exchanges: pacifica


fetchCanceledAndClosedOrders

fetches information on multiple canceled orders made by the user

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

ParamTypeRequiredDescription
symbolstringNounified market symbol of the market the orders were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.portfolioMarginbooleanNoset to true if you would like to fetch orders in a portfolio margin account
params.triggerbooleanNoset to true if you would like to fetch portfolio margin account trigger or conditional orders
params.stockbooleanNoset to true if you would like to fetch tokenized stock orders

Supported exchanges: binance bingx bitget bullish bybit deepcoin derive hashkey hyperliquid nado pacifica weex


fetchCanceledOrders

fetches information on multiple canceled orders made by the user

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

ParamTypeRequiredDescription
symbolstringNounified market symbol of the market the orders were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.portfolioMarginbooleanNoset to true if you would like to fetch orders in a portfolio margin account
params.triggerbooleanNoset to true if you would like to fetch portfolio margin account trigger or conditional orders
params.stockbooleanNoset to true if you would like to fetch tokenized stock orders

Supported exchanges: binance bingx bitget bithumb bitteam blockchaincom bullish bybit coinbase deepcoin derive extended hibachi htx hyperliquid krakenfutures mexc nado okx pacifica upbit weex xt


fetchClosedOrder

fetch an open order by it's id

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified market symbol, default is undefined
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bitfinex bybit cex deepcoin


fetchClosedOrders

fetches information on multiple closed orders made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market orders were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNothe latest time in ms to fetch orders for
params.directionstringNothe ordering of the results, 'asc' or 'desc', defaults to 'asc' when since is set

Supported exchanges: alpaca bigone binance bingx bitfinex bitflyer bitget bithumb bitopro bitrue bitteam bittrade blockchaincom blofin btcmarkets bullish bybit cex coinbase coinbaseexchange coinsph deepcoin delta deribit derive dydx extended foxbit gate hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin lighter luno mexc modetrade mudrex nado okx onetrading p2b pacifica phemex poloniex revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zaif


fetchClosedOrdersWs

fetch closed orders

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol
sinceintNothe earliest time in ms to fetch open orders for
limitintNothe maximum number of open orders structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance gate


fetchContractBalance

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

Kind: instance
Returns: object - a balance structure

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.codeobjectNothe unified currency code to fetch the balance for, if not provided, the default .options['fetchBalance']['code'] will be used

Supported exchanges: kucoin


fetchContractDepositAddress

fetch the deposit address for a currency associated with this account

Kind: instance
Returns: object - an address structure

ParamTypeRequiredDescription
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: kucoin


fetchContractDeposits

helper method for fetching deposits for futures accounts

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

ParamTypeRequiredDescription
codestringYesunified currency code
sinceintNothe earliest time in ms to fetch deposits for
limitintNothe maximum number of deposits structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: kucoin


fetchContractOrder

fetc contract order

Kind: instance
Returns: object - An order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: kucoin


fetchContractOrdersByStatus

fetches a list of contract orders placed on the exchange

Kind: instance
Returns: An array of order structures

ParamTypeRequiredDescription
statusstringYes'active' or 'closed', only 'active' is valid for stop orders
symbolstringYesunified symbol for the market to retrieve orders from
sinceintNotimestamp in ms of the earliest order to retrieve
limitintNoThe maximum number of orders to retrieve
paramsobjectNoexchange specific parameters
params.triggerboolNoset to true to retrieve untriggered stop orders
params.untilintNoEnd time in ms
params.sidestringNobuy or sell
params.typestringNolimit or market
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges: kucoin


fetchContractWithdrawals

helper method for fetching withdrawals for futures accounts

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

ParamTypeRequiredDescription
codestringYesunified currency code
sinceintNothe earliest time in ms to fetch withdrawals for
limitintNothe maximum number of withdrawals structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: kucoin


fetchConvertCurrencies

fetches all available currencies that can be converted

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitget bybit okx woo


fetchConvertQuote

fetches an indicative quote for converting between a tokenized stock and its quote currency

Kind: instance
Returns: object - indicative conversion estimate; the price is a bound and is not guaranteed

ParamTypeRequiredDescription
fromCodestringYesthe currency to convert from
toCodestringYesthe currency to convert to
amountfloatYesamount in units of the from currency
paramsobjectNoextra parameters specific to the exchange API endpoint
params.pricefloatNooptional limit price when converting quote currency to stock

Supported exchanges: backpack binance bitget bybit coinbase okx phemex whitebit woo


fetchConvertTrade

fetch the data for a conversion trade

Kind: instance
Returns: object - a conversion structure

ParamTypeRequiredDescription
idstringYesthe id of the trade that you want to fetch
codestringNothe unified currency code of the conversion trade
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bybit coinbase okx woo


fetchConvertTradeHistory

fetch the users history of conversion trades

Kind: instance
Returns: Array<object> - a list of conversion structures

ParamTypeRequiredDescription
codestringNothe unified currency code
sinceintNothe earliest time in ms to fetch conversions for
limitintNothe maximum number of conversion structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNotimestamp in ms of the latest conversion to fetch

Supported exchanges: binance bitget bybit okx phemex whitebit woo


fetchCrossBorrowRate

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

Kind: instance
Returns: object - a borrow rate structure

ParamTypeRequiredDescription
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitget bybit digifinex kucoin okx


fetchCrossBorrowRates

fetch the borrow interest rates of all currencies

Kind: instance
Returns: object - a list of borrow rate structures

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: digifinex okx


fetchCurrencies

fetches all available currencies on an exchange

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex aster backpack bigone binance bingx bitfinex bitget bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blofin bullish bybit cex coinbase coinbaseexchange coinbaseinternational coinone coinsph cryptocom cryptomus delta deribit derive digifinex extended gate gemini grvt hashkey hitbtc hollaex htx hyperliquid kraken kucoin latoken lbank lighter luno mexc modetrade nado ndax okx onetrading phemex poloniex polymarket revolutx toobit weex whitebit woo woofipro xt zebpay


fetchCurrenciesWs

fetches all available currencies on an exchange

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bitvavo


fetchDeposit

fetch data on a currency deposit via the deposit id, looks back 30 days for uta accounts and 90 days otherwise

Kind: instance
Returns: object - a transaction structure

ParamTypeRequiredDescription
idstringYesdeposit id
codestringNounified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint
params.utabooleanNoset to true for the unified trading account (uta), defaults to false

Supported exchanges: bitget bithumb bitso blockchaincom blofin coinbase okx upbit whitebit


fetchDepositAddress

fetch the deposit address for a currency associated with this account

Kind: instance
Returns: object - an address structure

ParamTypeRequiredDescription
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitget bithumb bitso bitstamp bitvavo blockchaincom blofin bullish bybit cex coinbase coinsph cryptocom deepcoin delta deribit digifinex foxbit gate gemini hashkey hibachi hitbtc htx independentreserve kraken kucoin lbank luno mexc ndax okx paymium phemex poloniex tokocrypto toobit upbit whitebit woo xt


fetchDepositAddresses

fetch deposit addresses for multiple currencies (when available)

Kind: instance
Returns: object - a dictionary of address structures indexed by currency code

ParamTypeRequiredDescription
codesArray<string>Nolist of unified currency codes, default is undefined (all currencies)
paramsobjectNoextra parameters specific to the exchange API endpoint
params.generationintNoonly generation 2 is supported if you want to use the API generation 1 or 2, default is 2

Supported exchanges: bithumb coinbase coinone deepcoin hollaex indodax paymium upbit


fetchDepositAddressesByNetwork

fetch the deposit addresses for a currency associated with this account

Kind: instance
Returns: object - a dictionary address structures, indexed by the network

ParamTypeRequiredDescription
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bingx bybit cryptocom gate gemini htx kucoin mexc okx


fetchDepositMethodId

fetch the deposit id for a fiat currency associated with this account

Kind: instance
Returns: object - a deposit id structure

ParamTypeRequiredDescription
idstringYesthe deposit payment method id
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: coinbase


fetchDepositMethodIds

fetch the deposit id for a fiat currency associated with this account

Kind: instance
Returns: object - an array of deposit id structures

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: coinbase


fetchDepositMethods

fetch deposit methods for a currency associated with this account

Kind: instance
Returns: object - of deposit methods

ParamTypeRequiredDescription
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: kraken


fetchDepositWithdrawFee

fetch the withdrawal fee for a currency; indodax charges no crypto deposit fees, see https://github.com/ccxt/ccxt/issues/25800

Kind: instance
Returns: object - a fee structure

ParamTypeRequiredDescription
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: indodax kucoin luno


fetchDepositWithdrawFees

fetch deposit and withdraw fees

Kind: instance
Returns: Array<object> - a list of fee structures

ParamTypeRequiredDescription
codesArray<string>, undefinedYesnot used by fetchDepositWithdrawFees ()
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bingx bitget bitopro bitrue bitso bitstamp bitvavo blofin bybit cryptocom deribit digifinex gate hitbtc hollaex htx kucoin lbank mexc okx poloniex whitebit


fetchDeposits

fetch all deposits made to an account

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

ParamTypeRequiredDescription
codestringNounified currency code
sinceintNothe earliest time in ms to fetch deposits for
limitintNothe maximum number of deposit structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca backpack bigone binance bingx bitbns bitflyer bitget bithumb bitopro bitrue bitso bittrade bitvavo blockchaincom blofin btcmarkets btse bybit coinbase coinbaseexchange coinbaseinternational coincheck coinsph cryptocom deepcoin deribit derive digifinex dydx extended foxbit gate grvt hashkey hibachi hitbtc hollaex htx hyperliquid kraken kucoin lbank lighter mexc modetrade nado ndax okx pacifica paradex phemex poloniex polymarket tokocrypto toobit upbit whitebit woo woofipro xt


fetchDepositsWithdrawals

fetch history of deposits and withdrawals

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

ParamTypeRequiredDescription
codestringNounified currency code for the currency of the deposit/withdrawals, default is undefined
sinceintNotimestamp in ms of the earliest deposit/withdrawal, default is undefined
limitintNomax number of deposit/withdrawals to return, default is undefined
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca bitfinex bitstamp bitteam btcmarkets btse bullish cex coinbase coinbaseexchange coinbaseinternational coinmate dydx gemini hibachi hitbtc indodax modetrade poloniex whitebit woo woofipro


fetchDepositsWs

fetch all deposits made to an account

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

ParamTypeRequiredDescription
codestringYesunified currency code
sinceintNothe earliest time in ms to fetch deposits for
limitintNothe maximum number of deposits structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bitvavo


fetchFundingHistory

fetches information on multiple orders made by the user classic accounts only

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market orders were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve, default 100
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilobjectNoend time, ms
params.sidebooleanNoBUY or SELL
params.pagebooleanNoPage numbers start from 0

Supported exchanges: apex aster backpack binance bingx bitget bybit derive digifinex extended gate grvt htx hyperliquid krakenfutures kucoin mexc modetrade nado okx pacifica paradex phemex polymarket weex whitebit woo woofipro xt


fetchFundingInterval

fetch the current funding rate interval

Kind: instance
Returns: object - a funding rate structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint
params.utabooleanNoset to true for the unified trading account (uta), defaults to false

Supported exchanges: bitget digifinex kucoin mexc modetrade okx woo woofipro xt


fetchFundingIntervals

fetch the funding rate interval for multiple markets

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

ParamTypeRequiredDescription
symbolsArray<string>Nolist of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance bitget


fetchFundingLimits

fetch the deposit and withdrawal limits for a currency

Kind: instance
Returns: object - a funding limits structure

ParamTypeRequiredDescription
codesArray<string>, undefinedYesunified currency codes
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: whitebit


fetchFundingRate

fetch the current funding rate

Kind: instance
Returns: object - a funding rate structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bingx bitflyer bitget bitstamp blofin btse cryptocom deepcoin delta deribit derive digifinex gate hashkey hibachi hitbtc htx hyperliquid kucoin lbank mexc modetrade nado okx paradex phemex polymarket whitebit woo woofipro xt


fetchFundingRateHistory

fetches historical funding rate prices

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

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the funding rate history for
sinceintNotimestamp in ms of the earliest funding rate to fetch
limitintNothe maximum amount of funding rate structures to fetch
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNotimestamp in ms of the latest funding rate
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges: apex aster backpack binance bingx bitfinex bitget bitstamp blofin btse bullish bybit coinbaseinternational cryptocom deepcoin deribit derive digifinex dydx extended gate grvt hashkey hibachi hitbtc htx hyperliquid krakenfutures kucoin mexc modetrade okx pacifica paradex phemex polymarket toobit weex whitebit woo woofipro xt


fetchFundingRates

fetch the current funding rate for multiple symbols

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

ParamTypeRequiredDescription
symbolsArray<string>Nolist of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance bingx bitfinex bitget btse bybit deepcoin delta gate hashkey hitbtc htx hyperliquid krakenfutures kucoin lbank lighter modetrade nado okx pacifica paradex polymarket toobit weex whitebit woo woofipro


fetchGreeks

fetches an option contracts greeks, financial metrics used to measure the factors that affect the price of an options contract

Kind: instance
Returns: object - a greeks structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch greeks for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bybit delta deribit derive gate okx paradex


fetchHip3Markets

retrieves data on all hip3 markets for hyperliquid

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: hyperliquid


fetchIsolatedBorrowRate

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

Kind: instance
Returns: object - an isolated borrow rate structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint EXCHANGE SPECIFIC PARAMETERS
params.vipLevelobjectNouser's current specific margin data will be returned if viplevel is omitted

Supported exchanges: binance bitget


fetchIsolatedBorrowRates

fetch the borrow interest rates of all currencies

Kind: instance
Returns: object - a borrow rate structure

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.symbolobjectNounified market symbol EXCHANGE SPECIFIC PARAMETERS
params.vipLevelobjectNouser's current specific margin data will be returned if viplevel is omitted

Supported exchanges: binance htx


fetchL3OrderBook

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

Kind: instance
Returns: object - an order book structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
limitintNomax number of orders to return, default is undefined
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: blockchaincom


fetchLastPrices

fetches the last price for multiple markets

Kind: instance
Returns: object - a dictionary of lastprices structures

ParamTypeRequiredDescription
symbolsArray<string>, undefinedYesunified symbols of the markets to fetch the last prices
paramsobjectNoextra parameters specific to the exchange API endpoint
params.subTypestringNo"linear" or "inverse"

Supported exchanges: aster binance hashkey htx toobit weex


fetchLedger

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

Kind: instance
Returns: object - a ledger structure

ParamTypeRequiredDescription
codestringNounified currency code
sinceintNotimestamp in ms of the earliest ledger entry
limitintNomax number of ledger entries to return
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNotimestamp in ms of the latest ledger entry

Supported exchanges: aster binance bitfinex bitget bitso bitstamp bitvavo blofin btse bybit cex coinbase coinbaseexchange cryptocom deepcoin delta digifinex dydx extended foxbit gate hashkey hibachi htx hyperliquid kraken krakenfutures kucoin luno modetrade ndax okx pacifica toobit weex woo woofipro xt


fetchLedgerEntry

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

Kind: instance
Returns: object - a ledger structure

ParamTypeRequiredDescription
idstringYesthe identification number of the ledger entry
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance


fetchLeverage

fetch the set leverage for a market

Kind: instance
Returns: object - a leverage structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bingx bitget blofin btse bybit coinbaseinternational delta extended gate hashkey hitbtc krakenfutures kucoin mexc modetrade mudrex okx pacifica paradex poloniex polymarket toobit weex woo woofipro zebpay


fetchLeverageTiers

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

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

ParamTypeRequiredDescription
symbolsArray<string>, undefinedYeslist of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint
params.portfolioMarginbooleanNoset to true if you would like to fetch the leverage tiers for a portfolio margin account
params.subTypestringNo"linear" or "inverse"

Supported exchanges: binance btse bybit digifinex gate hashkey htx krakenfutures kucoin mexc phemex xt


fetchLeverages

fetch the set leverage for all markets

Kind: instance
Returns: object - a list of leverage structures

ParamTypeRequiredDescription
symbolsArray<string>Noa list of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance blofin gate grvt krakenfutures weex zebpay


fetchLiquidations

retrieves the public liquidations of a trading pair

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

ParamTypeRequiredDescription
symbolstringYesunified CCXT market symbol
sinceintNothe earliest time in ms to fetch liquidations for
limitintNothe maximum number of liquidation structures to retrieve
paramsobjectNoexchange specific parameters
params.untilintNotimestamp in ms of the latest liquidation
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters

Supported exchanges: bitfinex deribit gate htx


fetchLongShortRatioHistory

fetches the long short ratio history for a unified market symbol

Kind: instance
Returns: Array<object> - an array of long short ratio structures

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the long short ratio for
timeframestringNothe period for the ratio, default is 24 hours
sinceintNothe earliest time in ms to fetch ratios for
limitintNothe maximum number of long short ratio structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNotimestamp in ms of the latest ratio to fetch

Supported exchanges: binance bitget bybit okx


fetchMarginAdjustmentHistory

fetches the history of margin added or reduced from contract isolated positions

Kind: instance
Returns: Array<object> - a list of margin structures

ParamTypeRequiredDescription
symbolstringYesunified market symbol
typestringNo"add" or "reduce"
sinceintNotimestamp in ms of the earliest change to fetch
limitintNothe maximum amount of changes to fetch
paramsobjectYesextra parameters specific to the exchange API endpoint
params.untilintNotimestamp in ms of the latest change to fetch

Supported exchanges: aster binance okx


fetchMarginMode

fetches the margin mode of a specific symbol

Kind: instance
Returns: object - a margin mode structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint
params.subTypestringNo"linear" or "inverse"

Supported exchanges: binance bingx bitget blofin btse bybit delta kucoin pacifica paradex polymarket weex woofipro


fetchMarginModes

fetches margin mode of the user

Kind: instance
Returns: object - a list of margin mode structures

ParamTypeRequiredDescription
symbolsArray<string>Yesunified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance grvt hitbtc weex woofipro


fetchMarkOHLCV

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

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

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch OHLCV data for
timeframestringYesthe length of time each candle represents
sinceintNotimestamp in ms of the earliest candle to fetch
limitintNothe maximum amount of candles to fetch
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: mudrex


fetchMarkPrice

fetches mark price for the market

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

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.subTypestringNo"linear" or "inverse"

Supported exchanges: binance bingx bitget blofin kucoin okx weex


fetchMarkPrices

fetches mark prices for multiple markets

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

ParamTypeRequiredDescription
symbolsArray<string>Nounified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
paramsobjectNoextra parameters specific to the exchange API endpoint
params.subTypestringNo"linear" or "inverse"

Supported exchanges: binance bingx kucoin okx weex


fetchMarketLeverageTiers

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

Kind: instance
Returns: object - a leverage tiers structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol, inverse (Coin-M) markets are not supported
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bingx bitget btse bybit digifinex gate kucoin okx xt


fetchMarkets

retrieves data on all markets for alpaca

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack bigone binance bingx bitbank bitbns bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coinmate coinone coinsph cryptocom cryptomus deepcoin delta deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade mudrex nado ndax okx onetrading p2b pacifica paradex phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zaif zebpay


fetchMarketsWs

retrieves data on all markets for bitvavo

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bitvavo


fetchMyContractTrades

fetch all contract trades made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol
sinceintNothe earliest time in ms to fetch trades for
limitintNothe maximum number of trades structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNoEnd time in ms
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges: kucoin


fetchMyDustTrades

fetch all dust trades made by the user

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

ParamTypeRequiredDescription
symbolstringYesnot used by fetchMyDustTrades ()
sinceintNothe earliest time in ms to fetch my dust trades for
limitintNothe maximum number of dust trades to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.typestringNo'spot' or 'margin', default spot

Supported exchanges: binance


fetchMyLiquidations

retrieves the users liquidated positions

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

ParamTypeRequiredDescription
symbolstringNounified CCXT market symbol
sinceintNothe earliest time in ms to fetch liquidations for
limitintNothe maximum number of liquidation structures to retrieve
paramsobjectNoexchange specific parameters for the binance api endpoint
params.untilintNotimestamp in ms of the latest liquidation
params.paginatebooleanNospot only default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.portfolioMarginbooleanNoset to true if you would like to fetch liquidations in a portfolio margin account
params.typestringNo"spot"
params.subTypestringNo"linear" or "inverse"

Supported exchanges: binance bingx bitget bybit deribit gate hyperliquid paradex


fetchMySettlementHistory

fetches historical settlement records of the user

Kind: instance
Returns: Array<object> - a list of [settlement history objects]

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the settlement history
sinceintNotimestamp in ms
limitintNonumber of records
paramsobjectNoexchange specific params

Supported exchanges: binance bybit derive gate hibachi okx


fetchMySpotTrades

fetch all spot trades made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol
sinceintNothe earliest time in ms to fetch trades for
limitintNothe maximum number of trades structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNothe latest time in ms to fetch entries for
params.hfboolNofalse, // true for hf order
params.marginModestringNo'cross' or 'isolated', only for margin trades
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges: kucoin


fetchMyTrades

fetch all trades made by the user

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

ParamTypeRequiredDescription
symbolstringNounified market symbol
sinceintNothe earliest time in ms to fetch trades for
limitintNothe maximum number of trade structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNothe latest time in ms to fetch trades for
params.page_tokenstringNopage_token - used for paging

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitflyer bitget bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcmarkets btcturk btse bullish bybit coinbase coinbaseexchange coinbaseinternational coincheck coinmate coinone coinsph coinspot cryptocom deepcoin delta deribit derive digifinex extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade mudrex nado ndax okx onetrading p2b pacifica paradex phemex poloniex polymarket revolutx tokocrypto toobit weex whitebit woo woofipro xt zebpay


fetchMyTradesWs

fetch all trades made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol
sinceint, undefinedNothe earliest time in ms to fetch trades for
limitint, undefinedNothe maximum number of trades structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.endTimeintNothe latest time in ms to fetch trades for
params.fromIdintNofirst trade Id to fetch

Supported exchanges: binance bitvavo coinbaseinternational


fetchMyUtaTrades

fetch all trades made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol
sinceintNothe earliest time in ms to fetch trades for
limitintNothe maximum number of trades structures to retrieve (default is 50, max is 200)
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNothe latest time in ms to fetch entries for
params.accountModestringNo'unified' or 'classic', defaults to 'unified'
params.marginModestringNo'cross' or 'isolated', only for margin trades (unified accountMode support only cross margin)
params.sidestringNo'BUY' or 'SELL' (both if not provided)
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges: kucoin


fetchOHLCV

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

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

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch OHLCV data for
timeframestringYesthe length of time each candle represents
sinceintNotimestamp in ms of the earliest candle to fetch
limitintNothe maximum amount of candles to fetch
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNotimestamp in ms of the latest candle to fetch
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.paginationCallsintNothe maximum number of requests while following next_page_token, default 10 — when the cap is reached the result is silently truncated to the pages already fetched, so raise it for long ranges, 10 requests cover roughly 30 days of 1h candles
params.locstringNocrypto location, default: us
params.methodstringNomethod, default: marketPublicGetV1beta3CryptoLocBars

Supported exchanges: alpaca apex aster backpack bigone binance bingx bitbank bitfinex bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blofin btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coinsph cryptocom deepcoin delta deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid indodax kraken krakenfutures kucoin lbank lighter luno mercado mexc modetrade mudrex nado ndax okx onetrading p2b pacifica paradex phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zebpay


fetchOHLCVWs

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

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

ParamTypeDescription
symbolstringunified symbol of the market to query OHLCV data for
timeframestringthe length of time each candle represents
sinceinttimestamp in ms of the earliest candle to fetch
limitintthe maximum amount of candles to fetch
paramsobjectextra parameters specific to the exchange API endpoint
params.untilinttimestamp in ms of the earliest candle to fetch EXCHANGE SPECIFIC PARAMETERS
params.timeZonestringdefault=0 (UTC)

Supported exchanges: binance bitvavo


fetchOpenInterest

retrieves the open interest of a contract trading pair

Kind: instance
Returns: object - an open interest structure/docs/manual#open-interest-structure

ParamTypeRequiredDescription
symbolstringYesunified CCXT market symbol
paramsobjectNoexchange specific parameters

Supported exchanges: apex backpack binance bingx bitfinex bitget btse bullish bybit delta deribit derive gemini hibachi hitbtc htx hyperliquid modetrade nado okx pacifica paradex phemex polymarket weex woofipro xt


fetchOpenInterestHistory

Retrieves the open interest history of a currency

Kind: instance
Returns: object - an array of open interest structure

ParamTypeRequiredDescription
symbolstringYesUnified CCXT market symbol
timeframestringYes"5m","15m","30m","1h","2h","4h","6h","12h", or "1d"
sinceintNothe time(ms) of the earliest record to retrieve as a unix timestamp
limitintNodefault 30, max 500
paramsobjectNoexchange specific parameters
params.untilintNothe time(ms) of the latest record to retrieve as a unix timestamp
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges: binance bitfinex bybit extended gate htx kucoin okx


fetchOpenInterests

Retrieves the open interest for a list of symbols

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

ParamTypeRequiredDescription
symbolsArray<string>Noa list of unified CCXT market symbols
paramsobjectNoexchange specific parameters

Supported exchanges: bitfinex btse hitbtc htx hyperliquid kucoin modetrade nado okx pacifica polymarket woofipro


fetchOpenOrder

fetch an open order by the id

Kind: instance
Returns: object - an order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bitfinex btse bybit cex deepcoin hitbtc hollaex


fetchOpenOrders

fetch all unfilled currently open orders

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market orders were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNothe latest time in ms to fetch orders for
params.directionstringNothe ordering of the results, 'asc' or 'desc', defaults to 'asc' when since is set

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coincheck coinmate coinone coinsph cryptocom cryptomus deepcoin delta deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade mudrex nado ndax okx onetrading p2b pacifica paradex phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zaif zebpay


fetchOpenOrdersWs

fetch all unfilled currently open orders

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol
sinceint, undefinedNothe earliest time in ms to fetch open orders for
limitint, undefinedNothe maximum number of open orders structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitvavo cex coinbaseinternational gate


fetchOption

fetches option data that is commonly found in an option chain

Kind: instance
Returns: object - an option chain structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bybit delta deribit derive gate okx


fetchOptionChain

fetches data for an underlying asset that is commonly found in an option chain

Kind: instance
Returns: object - a list of option chain structures

ParamTypeRequiredDescription
codestringYesbase currency to fetch an option chain for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bybit deribit gate okx


fetchOptionPositions

fetch data on open options positions

Kind: instance
Returns: Array<object> - a list of position structures

ParamTypeRequiredDescription
symbolsArray<string>, undefinedYeslist of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance


fetchOrder

fetches information on an order made by the user

Kind: instance
Returns: object - An order structure

ParamTypeRequiredDescription
idstringYesthe order id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcmarkets bullish bybit coinbase coinbaseexchange coinbaseinternational coinmate coinone coinsph cryptocom delta deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin latoken lbank luno mercado mexc modetrade mudrex nado ndax okx onetrading pacifica paradex phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zebpay


fetchOrderBook

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

Kind: instance
Returns: object - an order book structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the order book for
limitintNothe maximum amount of order book entries to return
paramsobjectNoextra parameters specific to the exchange API endpoint
params.locstringNocrypto location, default: us

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coincheck coinmate coinone coinsph coinspot cryptocom cryptomus deepcoin delta deribit digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade nado ndax okx onetrading p2b pacifica paradex paymium phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zaif zebpay


fetchOrderBookWs

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

Kind: instance
Returns: object - A dictionary of order book structures

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the order book for
limitintNothe maximum amount of order book entries to return
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance


fetchOrderBooks

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

Kind: instance
Returns: object - a dictionary of order book structures indexed by market symbol

ParamTypeRequiredDescription
symbolsArray<string>Nolist of unified market symbols, all symbols fetched if undefined, default is undefined
limitintNomax number of entries per orderbook to return, default is undefined
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: hitbtc hollaex upbit


fetchOrderClassic

fetches information on an order made by the user classic accounts only

Kind: instance
Returns: object - An order structure

ParamTypeRequiredDescription
idstringYesthe order id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bybit


fetchOrderTrades

fetch all the trades made from a single order

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

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified market symbol
sinceintNothe earliest time in ms to fetch trades for
limitintNothe maximum number of trades to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex binance bitfinex bitso bittrade btse bullish bybit coinbaseexchange coinsph deepcoin deribit derive gate hitbtc htx kraken kucoin mexc modetrade ndax okx onetrading p2b poloniex weex whitebit woo woofipro zebpay


fetchOrderWs

fetches information on an order made by the user

Kind: instance
Returns: object - An order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringNounified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitvavo cex coinbaseinternational gate


fetchOrders

fetches information on multiple orders made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market orders were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNothe latest time in ms to fetch orders for
params.directionstringNothe ordering of the results, 'asc' or 'desc', defaults to 'asc' when since is set

Supported exchanges: alpaca apex aster backpack bigone binance bingx bitflyer bithumb bitopro bitteam bittrade bitvavo blockchaincom btcbox btcmarkets btcturk bullish cex coinbase coinbaseexchange coinmate cryptocom cryptomus digifinex dydx extended foxbit gemini grvt hollaex htx hyperliquid krakenfutures latoken lbank luno mercado mexc modetrade mudrex nado ndax pacifica paradex phemex polymarket revolutx tokocrypto toobit weex whitebit woo woofipro xt


fetchOrdersByIds

fetch orders by the list of order id

Kind: instance
Returns: Array<object> - a list of order structure

ParamTypeRequiredDescription
idsArray<string>Nolist of order id
symbolstringNounified ccxt market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: kraken


fetchOrdersByStatus

fetches a list of orders placed on the exchange

Kind: instance
Returns: An array of order structures

ParamTypeRequiredDescription
statusstringYes'active' or 'closed', only 'active' is valid for stop orders
symbolstringYesunified symbol for the market to retrieve orders from
sinceintNotimestamp in ms of the earliest order to retrieve
limitintNoThe maximum number of orders to retrieve
paramsobjectNoexchange specific parameters
params.utabooleanNotrue for fetch orders with uta endpoint (default is false) Check fetchSpotOrdersByStatus(), fetchContractOrdersByStatus() and fetchUtaOrdersByStatus() for more details on the extra parameters that can be used in params

Supported exchanges: kucoin


fetchOrdersClassic

fetches information on multiple orders made by the user classic accounts only

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market orders were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.triggerbooleanNotrue if trigger order
params.stopbooleanNoalias for trigger
params.typestringNomarket type, ['swap', 'option', 'spot']
params.subTypestringNomarket subType, ['linear', 'inverse']
params.orderFilterstringNo'Order' or 'StopOrder' or 'tpslOrder'
params.untilintNothe latest time in ms to fetch entries for
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges: bybit


fetchOrdersWs

fetches information on multiple orders made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market orders were made in
sinceint, undefinedNothe earliest time in ms to fetch orders for
limitint, undefinedNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.orderIdintNoorder id to begin at
params.startTimeintNoearliest time in ms to retrieve orders for
params.endTimeintNolatest time in ms to retrieve orders for
params.limitintNothe maximum number of order structures to retrieve

Supported exchanges: binance bitvavo coinbaseinternational gate


fetchPortfolioDetails

Fetch details for a specific portfolio by UUID

Kind: instance
Returns: Array<any> - An account structure </docs/manual#account-structure>

ParamTypeRequiredDescription
portfolioUuidstringYesThe unique identifier of the portfolio to fetch
paramsDictNoExtra parameters specific to the exchange API endpoint

Supported exchanges: coinbase


fetchPortfolios

fetch all the portfolios

Kind: instance
Returns: object - a dictionary of account structures indexed by the account type

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: coinbase


fetchPosition

fetch data on an open position

Kind: instance
Returns: object - a position structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market the position is held in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bingx bitget blofin bybit coinbase coinbaseinternational cryptocom delta deribit digifinex dydx extended gate hitbtc htx hyperliquid kucoin lighter mexc modetrade okx pacifica paradex polymarket weex whitebit woo woofipro xt


fetchPositionHistory

fetches historical positions

Kind: instance
Returns: Array<object> - a list of position structures

ParamTypeRequiredDescription
symbolstringYesunified contract symbol
sinceintNothe earliest time in ms to fetch positions for
limitintNothe maximum amount of records to fetch
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNothe latest time in ms to fetch positions for

Supported exchanges: bingx phemex whitebit


fetchPositionMode

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

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

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the order book for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance bingx blofin btse kucoin mexc okx poloniex weex


fetchPositionWs

fetch data on an open position

Kind: instance
Returns: object - a position structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market the position is held in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance


fetchPositions

fetch all open positions

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

ParamTypeRequiredDescription
symbolsArray<string>Nolist of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex aster backpack binance bingx bitfinex bitflyer bitget blofin btse bullish bybit coinbase coinbaseinternational cryptocom deepcoin delta deribit derive digifinex dydx extended gate grvt hashkey hibachi hitbtc htx hyperliquid kraken krakenfutures kucoin lighter mexc modetrade mudrex nado okx pacifica paradex phemex poloniex polymarket toobit weex whitebit woo woofipro xt zebpay


fetchPositionsADLRank

fetches the auto deleveraging rank and risk percentage for a list of symbols that have open positions

Kind: instance
Returns: Array<object> - an array of auto de leverage structure

ParamTypeRequiredDescription
symbolsArray<string>Nolist of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint
params.portfolioMarginbooleanNoset to true for the portfolio margin account

Supported exchanges: binance blofin bybit delta htx kucoin phemex woo


fetchPositionsForSymbol

fetch all open positions for specific symbol

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: btse deepcoin hashkey okx weex


fetchPositionsHistory

fetches historical positions

Kind: instance
Returns: Array<object> - a list of position structures

ParamTypeRequiredDescription
symbolsArray<string>Nounified contract symbols
sinceintNotimestamp in ms of the earliest position to fetch, default=3 months ago, max range for params["until"] - since is 3 months
limitintNothe maximum amount of records to fetch, default=20, max=100
paramsobjectYesextra parameters specific to the exchange API endpoint
params.untilintNotimestamp in ms of the latest position to fetch, max range for params["until"] - since is 3 months
params.productTypestringNoUSDT-FUTURES (default), COIN-FUTURES, USDC-FUTURES, SUSDT-FUTURES, SCOIN-FUTURES, or SUSDC-FUTURES
params.utabooleanNoset to true for the unified trading account (uta), defaults to false

Supported exchanges: bitget blofin bybit extended gate krakenfutures kucoin mexc mudrex okx xt


fetchPositionsRisk

fetch positions risk

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

ParamTypeRequiredDescription
symbolsArray<string>, undefinedYeslist of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster


fetchPositionsWs

fetch all open positions

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

ParamTypeRequiredDescription
symbolsArray<string>Nolist of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint
params.returnRateLimitsbooleanNoset to true to return rate limit informations, defaults to false.
params.methodstring, undefinedNomethod to use. Can be account.position or v2/account.position

Supported exchanges: binance coinbaseinternational


fetchSettlementHistory

fetches historical settlement records

Kind: instance
Returns: Array<object> - a list of settlement history objects

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the settlement history
sinceintNotimestamp in ms
limitintNonumber of records, default 100, max 100
paramsobjectNoexchange specific params

Supported exchanges: binance bybit cryptocom delta derive gate htx okx


fetchSpotMarkets

retrieves data on all spot markets for hyperliquid

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: hyperliquid


fetchSpotOrder

fetch a spot order

Kind: instance
Returns: An order structure

ParamTypeRequiredDescription
idstringYesOrder id
symbolstringYesnot sent to exchange except for trigger orders with clientOid, but used internally by CCXT to filter
paramsobjectNoexchange specific parameters
params.triggerboolNotrue if fetching a trigger order
params.hfboolNofalse, // true for hf order
params.clientOidboolNounique order id created by users to identify their orders
params.marginModeobjectNo'cross' or 'isolated'

Supported exchanges: kucoin


fetchSpotOrdersByStatus

fetch a list of spot orders

Kind: instance
Returns: An array of order structures

ParamTypeRequiredDescription
statusstringYesnot used for stop orders 'open' or 'closed'
symbolstringYesunified market symbol
sinceintNotimestamp in ms of the earliest order
limitintNomax number of orders to return
paramsobjectNoexchange specific params
params.untilintNoend time in ms
params.sidestringNobuy or sell
params.typestringNolimit, market, limit_stop or market_stop
params.tradeTypestringNoTRADE for spot trading, MARGIN_TRADE or MARGIN_ISOLATED_TRADE for Margin Trading
params.currentPageintNotrigger orders only current page
params.orderIdsstringNotrigger orders only comma separated order ID list
params.triggerboolNoTrue if fetching a trigger order
params.hfboolNofalse, // true for hf order
params.marginModestringNo'cross' or 'isolated', only for margin orders

Supported exchanges: kucoin


fetchStatus

the latest known information on the availability of the exchange API

Kind: instance
Returns: object - a status structure

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: backpack binance bitbns bitfinex bitrue bybit coincheck coinsph delta deribit digifinex foxbit hashkey htx hyperliquid kraken kucoin lighter mexc modetrade nado ndax okx paradex polymarket toobit weex whitebit woo woofipro zebpay


fetchSwapMarkets

retrieves data on all swap markets for hyperliquid

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: hyperliquid pacifica


fetchTicker

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

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.locstringNocrypto location, default: us

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coincheck coinmate coinone coinsph coinspot cryptocom cryptomus delta deribit derive digifinex extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx independentreserve indodax kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade mudrex nado ndax okx onetrading p2b paradex paymium phemex poloniex polymarket revolutx tokocrypto upbit whitebit woo woofipro xt zaif zebpay


fetchTickerWs

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

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.methodstringNomethod to use can be ticker.price or ticker.book
params.returnRateLimitsbooleanNoreturn the rate limits for the exchange

Supported exchanges: binance cex


fetchTickers

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

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

ParamTypeRequiredDescription
symbolsArray<string>Nounified symbols of the markets to fetch tickers for, defaults to all markets
paramsobjectNoextra parameters specific to the exchange API endpoint
params.locstringNocrypto location, default: us

Supported exchanges: alpaca apex aster backpack bigone binance bingx bitbns bitfinex bitget bithumb bitopro bitrue bitstamp bitteam bittrade bitvavo blockchaincom blofin btcbox btcturk btse bybit cex coinbase coinbaseexchange coinbaseinternational coinmate coinone coinsph coinspot cryptocom deepcoin delta deribit digifinex extended foxbit gate gemini hashkey hitbtc hollaex htx hyperliquid indodax kraken krakenfutures kucoin latoken lbank lighter luno mexc modetrade mudrex nado ndax okx onetrading p2b pacifica paradex phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zebpay


fetchTime

fetches the current integer timestamp in milliseconds from the exchange server

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack bigone binance bingx bitget bitrue bittrade bitvavo btcmarkets btse bullish bybit cex coinbase coinbaseexchange coinbaseinternational coinmate coinsph delta deribit derive digifinex dydx gate hashkey hibachi htx hyperliquid indodax kraken kucoin latoken lbank lighter mexc modetrade nado okx onetrading paradex poloniex polymarket tokocrypto toobit weex whitebit woo woofipro xt zebpay


fetchTrades

get the list of most recent trades for a particular symbol

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

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch trades for
sinceintNotimestamp in ms of the earliest trade to fetch
limitintNothe maximum amount of trades to fetch
paramsobjectNoextra parameters specific to the exchange API endpoint
params.locstringNocrypto location, default: us
params.methodstringNomethod, default: marketPublicGetV1beta3CryptoLocTrades

Supported exchanges: alpaca apex aster backpack bigone binance bingx bit2c bitbank bitbns bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bitteam bittrade bitvavo blofin btcbox btcmarkets btcturk btse bullish bybit cex coinbase coinbaseexchange coincheck coinmate coinone coinsph coinspot cryptocom cryptomus deepcoin delta deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken krakenfutures kucoin latoken lbank lighter luno mercado mexc modetrade nado ndax okx p2b pacifica paradex paymium phemex poloniex polymarket revolutx tokocrypto toobit upbit weex whitebit woo woofipro xt zaif zebpay


fetchTradesWs

fetch all trades made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol
sinceintNothe earliest time in ms to fetch trades for
limitintNothe maximum number of trades structures to retrieve, default=500, max=1000
paramsobjectNoextra parameters specific to the exchange API endpoint EXCHANGE SPECIFIC PARAMETERS
params.fromIdintNotrade ID to begin at

Supported exchanges: binance


fetchTradingFee

fetch the trading fees for a market

Kind: instance
Returns: object - a fee structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance bingx bitflyer bitget bitstamp bitvavo btse bybit coinmate coinsph cryptocom digifinex extended gate hashkey hitbtc htx hyperliquid kraken kucoin latoken lbank luno mexc okx pacifica paradex upbit weex woo xt zebpay


fetchTradingFees

fetch the trading fees for multiple markets

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.subTypestringNo"linear" or "inverse"

Supported exchanges: binance bit2c bitbank bitfinex bitget bitopro bitso bitstamp bitvavo blockchaincom btse bybit cex coinbase coinbaseexchange coincheck coinsph cryptocom cryptomus deribit extended foxbit gate gemini hashkey hibachi hitbtc hollaex independentreserve krakenfutures lbank modetrade onetrading pacifica paradex poloniex polymarket toobit upbit whitebit woo woofipro xt zebpay


fetchTradingFeesWs

fetch the trading fees for multiple markets

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

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bitvavo


fetchTradingLimits

fetch the trading limits for a market

Kind: instance
Returns: object - a trading limits structure

ParamTypeRequiredDescription
symbolsArray<string>, undefinedYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: whitebit


fetchTransactionFee

fetch the fee for a transaction

Kind: instance
Returns: object - a fee structure

ParamTypeRequiredDescription
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: indodax kucoin


fetchTransactionFees

please use fetchDepositWithdrawFees instead

Kind: instance
Returns: Array<object> - a list of fee structures

ParamTypeRequiredDescription
codesArray<string>, undefinedYesnot used by fetchTransactionFees ()
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitso bitstamp gate lbank mexc whitebit


fetchTransactions

fetch history of deposits, withdrawals, and transfers

Kind: instance
Returns: Array<Transaction> - a list of transaction structures

ParamTypeRequiredDescription
codestringNounified currency code
sinceintNothe earliest time in ms to fetch transactions for
limitintNothe maximum number of transaction structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters

Supported exchanges: extended foxbit latoken whitebit


fetchTransfer

fetches a transfer

Kind: instance
Returns: object - a transfer structure

ParamTypeRequiredDescription
idstringYestransfer id
codestringNounified currency code of the currency transferred
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bitvavo mexc okx poloniex


fetchTransfers

fetch a history of internal transfers made on an account

Kind: instance
Returns: Array<object> - a list of transfer structures

ParamTypeRequiredDescription
codestringYesunified currency code of the currency transferred
sinceintNothe earliest time in ms to fetch transfers for
limitintNothe maximum number of transfers structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.untilintNothe latest time in ms to fetch transfers for
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.internalbooleanNodefault false, when true will fetch pay trade history

Supported exchanges: binance bingx bitget bitrue bitvavo bullish bybit coinbaseinternational deribit derive digifinex dydx extended grvt htx kucoin latoken lighter mexc okx paradex phemex poloniex weex woo


fetchUnderlyingAssets

fetches the market ids of underlying assets for a specific contract market type

Kind: instance
Returns: Array<object> - a list of underlying assets

ParamTypeRequiredDescription
paramsobjectNoexchange specific params
params.typestringNothe contract market type, 'option', 'swap' or 'future', the default is 'option'

Supported exchanges: gate okx


fetchUtaBalance

helper method for fetching balance with unified trading account (uta) endpoint

Kind: instance
Returns: object - a balance structure

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.typestringNo'unified', 'spot', 'funding', 'cross', 'isolated' or 'swap' (default is 'unified')
params.marginModestringNo'cross' or 'isolated', margin type for fetching margin balance, only applicable if type is margin (default is cross)

Supported exchanges: kucoin


fetchUtaOrder

fetch uta order

Kind: instance
Returns: object - An order structure

ParamTypeRequiredDescription
idstringYesorder id
symbolstringYesunified symbol of the market the order was made in
paramsobjectNoextra parameters specific to the exchange API endpoint
params.accountModestringNo'unified' or 'classic' (default is 'unified')
params.clientOrderIdstringNoclient order id, required if id is not provided
params.marginModestringNo'cross' or 'isolated', required if fetching a margin order (unified accountMode supports only cross margin)

Supported exchanges: kucoin


fetchUtaOrdersByStatus

helper method for fetching orders by status with uta endpoint

Kind: instance
Returns: An array of order structures

ParamTypeRequiredDescription
statusstringYes'active' or 'closed', only 'active' is valid for stop orders
symbolstringYesunified symbol for the market to retrieve orders from
sinceintNotimestamp in ms of the earliest order to retrieve
limitintNoThe maximum number of orders to retrieve
paramsobjectNoexchange specific parameters
params.untilintNoEnd time in ms
params.sidestringNoclosed orders only 'BUY' or 'SELL'
params.accountModestringNo'unified' or 'classic' (default is unified)
params.marginModestringNo'cross' or 'isolated', only for margin orders (unified accountMode supports only cross margin)
params.paginatebooleanNodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges: kucoin


fetchVolatilityHistory

fetch the historical volatility of an option market based on an underlying asset

Kind: instance
Returns: Array<object> - a list of volatility history objects

ParamTypeRequiredDescription
codestringYesunified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint
params.periodintNothe period in days to fetch the volatility for: 7,14,21,30,60,90,180,270

Supported exchanges: bybit deribit


fetchWithdrawal

fetch data on a currency withdrawal via the withdrawal id, looks back 30 days for uta accounts and 90 days otherwise

Kind: instance
Returns: object - a transaction structure

ParamTypeRequiredDescription
idstringYeswithdrawal id
codestringNounified currency code
paramsobjectNoextra parameters specific to the exchange API endpoint
params.utabooleanNoset to true for the unified trading account (uta), defaults to false

Supported exchanges: bitget bithumb bitopro blockchaincom blofin hollaex okx upbit


fetchWithdrawalWhitelist

fetch a list of allowed withdrawal addresses

Kind: instance
Returns: Array<object> - a list response from the exchange

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.generationintNoonly generation 2 is supported if you want to use the API generation 1 or 2, default is 2

Supported exchanges: bithumb


fetchWithdrawals

fetch all withdrawals made from an account

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

ParamTypeRequiredDescription
codestringNounified currency code
sinceintNothe earliest time in ms to fetch withdrawals for
limitintNothe maximum number of withdrawal structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca backpack bigone binance bingx bitbns bitflyer bitget bithumb bitopro bitrue bitstamp bittrade bitvavo blockchaincom blofin btcmarkets btse bybit coinbase coinbaseexchange coinbaseinternational coincheck coinsph cryptocom deepcoin deribit derive digifinex dydx extended foxbit gate grvt hashkey hibachi hitbtc hollaex htx hyperliquid kraken kucoin lbank lighter mexc modetrade nado ndax okx pacifica paradex phemex poloniex polymarket tokocrypto toobit upbit whitebit woo woofipro xt


fetchWithdrawalsWs

fetch all withdrawals made from an account

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

ParamTypeRequiredDescription
codestringYesunified currency code
sinceintNothe earliest time in ms to fetch withdrawals for
limitintNothe maximum number of withdrawals structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bitvavo


isUTAEnabled

returns true or false so the user can check if unified account is enabled

Kind: instance
Returns: boolean - true if unified account is enabled, false otherwise

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: kucoin


isUnifiedEnabled

returns [enableUnifiedMargin, enableUnifiedAccount] so the user can check if unified account is enabled

Kind: instance
Returns: any - [enableUnifiedMargin, enableUnifiedAccount]

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bybit hyperliquid


loadMigrationStatus

loads the migration status for the account (hf or not)

Kind: instance
Returns: any - ignore

ParamTypeDescription
forcebooleanload account state for non hf

Supported exchanges: kucoin


loadUnifiedStatus

returns unifiedAccount so the user can check if the unified account is enabled

Kind: instance
Returns: boolean - true or false if the enabled unified account is enabled or not and sets the unifiedAccount option if it is undefined

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: gate


parseMarket

parses a classic or uta instrument into a unified market

Kind: instance
Returns: object - a market structure

ParamTypeDescription
marketobjectthe exchange instrument

Supported exchanges: bitget


preLoadLighterLibrary

if the required credentials are available in options, it will pre-load the lighter Signer to avoid delaying sensitive calls like createOrder the first time they're executed

Kind: instance
Returns: boolean - true if the signer was loaded, false otherwise

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: lighter


redeemGiftCode

redeem gift code

Kind: instance
Returns: object - response from the exchange

ParamTypeRequiredDescription
giftcardCodestringYes
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance


reduceMargin

remove margin from a position

Kind: instance
Returns: object - a margin structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
amountfloatYesthe amount of margin to remove
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance bitget delta digifinex gate hashkey hitbtc hyperliquid kucoin lighter mexc mudrex okx poloniex polymarket weex woo woofipro xt zebpay


repayCrossMargin

repay borrowed margin and interest

Kind: instance
Returns: object - a margin loan structure

ParamTypeRequiredDescription
codestringYesunified currency code of the currency to repay
amountfloatYesthe amount to repay
paramsobjectNoextra parameters specific to the exchange API endpoint
params.portfolioMarginbooleanNoset to true if you would like to repay margin in a portfolio margin account
params.repayCrossMarginMethodstringNoportfolio margin only 'papiPostRepayLoan' (default), 'papiPostMarginRepayDebt' (alternative)
params.specifyRepayAssetsstringNoportfolio margin papiPostMarginRepayDebt only specific asset list to repay debt

Supported exchanges: binance bitget bybit gate htx kucoin okx


repayIsolatedMargin

repay borrowed margin and interest

Kind: instance
Returns: object - a margin loan structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol, required for isolated margin
codestringYesunified currency code of the currency to repay
amountfloatYesthe amount to repay
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bitget gate htx kucoin


repayMargin

repay borrowed margin and interest

Kind: instance
Returns: object - a margin loan structure

ParamTypeRequiredDescription
codestringYesunified currency code of the currency to repay
amountfloatYesthe amount to repay
symbolstringYesnot used by woo.repayMargin ()
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: woo


reserveRequestWeight

Instead of trading to increase the address based rate limits, this action allows reserving additional actions for 0.0005 USDC per request. The cost is paid from the Perps balance.

Kind: instance
Returns: object - a response object

ParamTypeRequiredDescription
weightnumberYesthe weight to reserve, 1 weight = 1 action, 0.0005 USDC per action
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: hyperliquid


revokeApiKey

revokes an api key of the account

Kind: instance
Returns: object - the api result

ParamTypeRequiredDescription
apiKeystringYesthe api key to revoke
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: pacifica


revokeBuilderCode

revokes a previously approved builder code

Kind: instance
Returns: object - the api result

ParamTypeRequiredDescription
builderCodestringYesthe builder code to revoke
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: pacifica


setAgentAbstraction

set agent abstraction mode

Kind: instance
Returns: dictionary response from the exchange

ParamTypeRequiredDescription
abstractionstringYesone of the strings ["i", "u", "p"] where "i" is "disabled", "u" is "unifiedAccount", and "p" is "portfolioMargin"
paramsobjectNo

Supported exchanges: hyperliquid


setContractLeverage

set the level of leverage for a market

Kind: instance
Returns: object - response from the exchange

ParamTypeRequiredDescription
leveragefloatYesthe rate of leverage
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint
params.utabooleanNoset to true for the unified trading account (uta)

Supported exchanges: kucoin


setLeverage

set the level of leverage for a market

Kind: instance
Returns: object - response from the exchange

ParamTypeRequiredDescription
leveragefloatYesthe rate of leverage
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex aster binance bingx bitget bitrue blofin btse bybit coinbaseinternational deepcoin delta digifinex extended gate grvt hashkey hitbtc htx hyperliquid krakenfutures kucoin lighter mexc modetrade mudrex okx pacifica paradex phemex poloniex polymarket toobit weex whitebit woo woofipro xt zebpay


setMargin

Either adds or reduces margin in an isolated position in order to set the margin to a specific value

Kind: instance
Returns: object - A margin structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market to set margin in
amountfloatYesthe amount to set the margin to
paramsobjectNoparameters specific to the exchange API endpoint
params.positionSidestringNo"LONG" or "SHORT", required for Coin-M

Supported exchanges: bingx bitfinex bitrue lighter phemex


setMarginMode

set margin mode to 'cross' or 'isolated'

Kind: instance
Returns: object - response from the exchange

ParamTypeRequiredDescription
marginModestringYes'cross' or 'isolated'
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance bingx bitget blofin btse bybit delta digifinex hashkey hyperliquid kucoin lighter mexc okx pacifica paradex phemex polymarket toobit weex woofipro xt


setPositionMode

set hedged to true or false for a market

Kind: instance
Returns: object - response from the exchange

ParamTypeRequiredDescription
hedgedboolYesset to true to use dualSidePosition
symbolstringYesnot used by setPositionMode ()
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster binance bingx bitget blofin btse bybit gate htx kucoin mexc okx phemex poloniex weex woo


setSandboxMode

enables or disables demo trading mode, if enabled will send PAPTRADING=1 in headers

Kind: instance

Param
enabled

Supported exchanges: bitget


setUserAbstraction

set user abstraction mode

Kind: instance
Returns: dictionary response from the exchange

ParamTypeRequiredDescription
abstractionstringYesone of the strings ["disabled", "unifiedAccount", "portfolioMargin"],
paramsobjectNo
params.typestringNo'userSetAbstraction' or 'agentSetAbstraction' default is 'userSetAbstraction'

Supported exchanges: hyperliquid


signIn

sign in, must be called prior to using other authenticated methods

Kind: instance
Returns: response from exchange

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster bullish grvt ndax


transfer

transfer currency internally between wallets on the same account

Kind: instance
Returns: object - a transfer structure

ParamTypeRequiredDescription
codestringYesunified currency code
amountfloatYesamount to transfer
fromAccountstringYesaccount to transfer from
toAccountstringYesaccount to transfer to
paramsobjectNoextra parameters specific to the exchange API endpoint
params.transferIdstringNoUUID, which is unique across the platform

Supported exchanges: apex aster bigone binance bingx bitfinex bitget bitrue bitstamp bitvavo blofin bullish bybit cex coinbase deepcoin deribit derive digifinex dydx extended gate grvt hashkey hitbtc htx hyperliquid kraken krakenfutures kucoin kucoinfutures latoken lighter mexc mudrex okx pacifica paymium phemex poloniex toobit whitebit woo xt


transferClassic

transfer currency internally between wallets on the same account with classic endpoints

Kind: instance
Returns: object - a transfer structure

ParamTypeRequiredDescription
codestringYesunified currency code
amountfloatYesamount to transfer
fromAccountstringYesaccount to transfer from
toAccountstringYesaccount to transfer to
paramsobjectNoextra parameters specific to the exchange API endpoint
params.transferTypestringNoINTERNAL, PARENT_TO_SUB, SUB_TO_PARENT (default is INTERNAL)
params.fromUserIdstringNorequired if transferType is SUB_TO_PARENT
params.toUserIdstringNorequired if transferType is PARENT_TO_SUB

Supported exchanges: kucoin


transferOut

transfer from spot wallet to futures wallet

Kind: instance
Returns: a transfer structure

ParamTypeRequiredDescription
codestrYesUnified currency code
amountfloatYesSize of the transfer
paramsdictNoExchange specific parameters

Supported exchanges: kraken krakenfutures


transferUta

transfer currency internally between wallets on the same account with uta endpoint

Kind: instance
Returns: object - a transfer structure

ParamTypeRequiredDescription
codestringYesunified currency code
amountfloatYesamount to transfer
fromAccountstringYesaccount to transfer from
toAccountstringYesaccount to transfer to
paramsobjectNoextra parameters specific to the exchange API endpoint
params.transferTypestringNoINTERNAL, PARENT_TO_SUB, SUB_TO_PARENT, SUB_TO_SUB (default is INTERNAL)
params.fromUserIdstringNorequired if transferType is SUB_TO_PARENT or SUB_TO_SUB
params.toUserIdstringNorequired if transferType is PARENT_TO_SUB or SUB_TO_SUB

Supported exchanges: kucoin


unWatchBalance

unsubscribes from all capital-account asset updates

Kind: instance
Returns: object - unsubscription result

ParamTypeRequiredDescription
paramsobjectNoextra exchange-specific parameters
params.stockbooleanNoaccepts the tokenized stock view selector; explicit because this method has no symbol

Supported exchanges: backpack hyperliquid


unWatchBidsAsks

unWatches best bid & ask for symbols

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance coinbaseinternational mexc nado weex woo


unWatchFundingRate

stops watching the funding rate for a symbol

Kind: instance
Returns: object - the exchange response

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint
params.routestringNoauto (default), deribit, or coinbase; overrides options.route

Supported exchanges: coinbaseinternational kucoin mexc


unWatchFundingRates

stops watching funding rates for multiple symbols

Kind: instance
Returns: object - the exchange response

ParamTypeRequiredDescription
symbolsArray<string>Nounified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint
params.routestringNoauto (default), deribit, or coinbase; overrides options.route

Supported exchanges: coinbaseinternational


unWatchMarkPrice

unWatches a mark price for a specific market

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.use1sFreqbooleanNodefault is true if set to true, the mark price will be updated every second, otherwise every 3 seconds

Supported exchanges: aster binance coinbaseinternational kucoin lighter


unWatchMarkPrices

watches the mark price for all markets

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.use1sFreqbooleanNodefault is true if set to true, the mark price will be updated every second, otherwise every 3 seconds

Supported exchanges: aster binance coinbaseinternational lighter


unWatchMyTrades

unWatches information on multiple trades made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market orders were made in
paramsobjectNoextra parameters specific to the exchange API endpoint
params.unifiedMarginbooleanNouse unified margin account
params.executionFastbooleanNouse fast execution

Supported exchanges: bybit coinbaseinternational derive hyperliquid lighter nado pacifica weex


unWatchOHLCV

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

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

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch OHLCV data for
timeframestringYesthe length of time each candle represents
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bingx bitfinex bitget bitvavo blofin bybit coinbaseinternational cryptocom deepcoin dydx gate htx hyperliquid kucoin mexc nado okx pacifica phemex weex woo


unWatchOHLCVForSymbols

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

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

ParamTypeRequiredDescription
symbolsAndTimeframesArray<Array<string>>Yesarray of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']]
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bitvavo blofin bybit coinbaseinternational nado okx weex


unWatchOrderBook

unsubscribe from the orderbook channel

Kind: instance
Returns: object - A dictionary of order book structures

ParamTypeRequiredDescription
symbolstringYessymbol of the market to unwatch the trades for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.limitintNoorderbook limit, default is undefined

Supported exchanges: aster backpack binance bingx bitget bitvavo bybit coinbaseinternational cryptocom deepcoin derive dydx gate htx hyperliquid kucoin lighter mexc nado okx pacifica weex woo


unWatchOrderBookForSymbols

unsubscribe from the orderbook channel

Kind: instance
Returns: object - A dictionary of order book structures

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to unwatch the trades for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.limitintNoorderbook limit, default is undefined

Supported exchanges: aster backpack binance bitvavo bybit coinbaseinternational cryptocom kucoin nado okx weex


unWatchOrders

unWatches information on multiple orders made by the user

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

ParamTypeRequiredDescription
symbolstringNounified market symbol of the market orders were made in
paramsobjectNoextra parameters specific to the exchange API endpoint
params.stockbooleanNoselects tokenized stock order subscriptions

Supported exchanges: backpack bybit coinbaseinternational derive hyperliquid lighter nado pacifica weex


unWatchPositions

unWatches from the stream channel

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

ParamTypeRequiredDescription
symbolsArray<string>Nolist of unified market symbols to watch positions for
paramsobjectYesextra parameters specific to the exchange API endpoint

Supported exchanges: backpack bybit coinbaseinternational hyperliquid nado weex


unWatchTicker

unWatches a price ticker

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bingx bitfinex bitget bybit coinbaseinternational cryptocom deepcoin derive htx hyperliquid kucoin lighter mexc nado okx weex woo


unWatchTickers

unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bybit coinbaseinternational cryptocom hyperliquid lighter mexc nado okx pacifica weex woo


unWatchTrades

unsubscribe from the trades channel

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market trades were made in
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bingx bitfinex bitget bitvavo blofin bybit coinbaseinternational cryptocom deepcoin derive dydx gate htx hyperliquid kucoin lighter mexc nado okx pacifica phemex weex woo


unWatchTradesForSymbols

unsubscribe from the trades channel

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

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to fetch trades for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bitvavo blofin bybit coinbaseinternational cryptocom gate kucoin nado okx weex


upgradeUnifiedTradeAccount

upgrades the account to unified trade account warning this is irreversible

Kind: instance
Returns: any - nothing

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: bybit


verifyGiftCode

verify gift code

Kind: instance
Returns: object - response from the exchange

ParamTypeRequiredDescription
idstringYesreference number id
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance


watchBalance

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

Kind: instance
Returns: object - a balance structure

ParamTypeRequiredDescription
paramsobjectNoextra parameters specific to the exchange API endpoint
params.typestringNo'spot' or 'swap', default is 'spot'

Supported exchanges: aster backpack binance bingx bitfinex bitget bithumb bitopro blockchaincom blofin bullish bybit cex coinbaseinternational cryptocom deribit derive extended gate hashkey hollaex htx hyperliquid kucoin lighter mexc modetrade okx onetrading phemex toobit upbit weex whitebit woo woofipro


watchBidsAsks

watches best bid & ask for symbols

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: aster backpack binance bitget bitvavo blofin bybit coinbaseinternational cryptocom deribit derive gate gemini kucoin mexc modetrade nado okx weex woo woofipro


watchFundingRate

watch the current funding rate

Kind: instance
Returns: object - a funding rate structure

ParamTypeRequiredDescription
symbolstringYesunified market symbol
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: blofin coinbaseinternational extended kucoin mexc okx woo


watchFundingRates

watch the funding rate for multiple markets

Kind: instance
Returns: object - a dictionary of funding rates structures, indexe by market symbols

ParamTypeRequiredDescription
symbolsArray<string>Yesa list of unified market symbols
paramsobjectNoextra parameters specific to the exchange API endpoint
params.routestringNoauto (default), deribit, or coinbase; overrides options.route

Supported exchanges: coinbaseinternational okx


watchLiquidations

watch the public liquidations of a trading pair

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

ParamTypeRequiredDescription
symbolstringYesunified CCXT market symbol
sinceintNothe earliest time in ms to fetch liquidations for
limitintNothe maximum number of liquidation structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance bybit lighter


watchLiquidationsForSymbols

watch the public liquidations of a trading pair

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

ParamTypeRequiredDescription
symbolsArray<string>Yeslist of unified market symbols
sinceintNothe earliest time in ms to fetch liquidations for
limitintNothe maximum number of liquidation structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance okx


watchMarkPrice

watches a mark price for a specific market

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.use1sFreqbooleanNodefault is true if set to true, the mark price will be updated every second, otherwise every 3 seconds

Supported exchanges: aster binance coinbaseinternational extended kucoin lighter okx


watchMarkPrices

watches the mark price for all markets

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint
params.use1sFreqbooleanNodefault is true if set to true, the mark price will be updated every second, otherwise every 3 seconds

Supported exchanges: aster binance coinbaseinternational lighter okx


watchMyLiquidations

watch the private liquidations of a trading pair

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

ParamTypeRequiredDescription
symbolstringYesunified CCXT market symbol
sinceintNothe earliest time in ms to fetch liquidations for
limitintNothe maximum number of liquidation structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance gate hyperliquid


watchMyLiquidationsForSymbols

watch the private liquidations of a trading pair

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

ParamTypeRequiredDescription
symbolsArray<string>Yeslist of unified market symbols
sinceintNothe earliest time in ms to fetch liquidations for
limitintNothe maximum number of liquidation structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: binance gate hyperliquid okx


watchMyTrades

watches information on multiple trades made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market trades were made in
sinceintNothe earliest time in ms to fetch trades for
limitintNothe maximum number of trade structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.unifiedMarginbooleanNouse unified margin account

Supported exchanges: alpaca apex aster binance bingx bitfinex bitget bitopro bitvavo bullish bybit cex coinbaseinternational cryptocom deepcoin deribit derive extended gate grvt hashkey hollaex htx hyperliquid kucoin lighter mexc modetrade nado okx onetrading pacifica phemex toobit upbit weex whitebit woo woofipro


watchOHLCV

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

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

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch OHLCV data for
timeframestringYesthe length of time each candle represents
sinceintNotimestamp in ms of the earliest candle to fetch
limitintNothe maximum amount of candles to fetch
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack binance bingx bitfinex bitget bittrade bitvavo blockchaincom blofin bybit cex coinbaseinternational cryptocom deepcoin deribit dydx extended gate gemini grvt hashkey htx hyperliquid kucoin mexc modetrade nado ndax okx onetrading pacifica phemex toobit upbit weex whitebit woo woofipro


watchOHLCVForSymbols

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

Kind: instance
Returns: object - A list of candles ordered as timestamp, open, high, low, close, volume

ParamTypeRequiredDescription
symbolsAndTimeframesArray<Array<string>>Yesarray of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']]
sinceintNotimestamp in ms of the earliest candle to fetch
limitintNothe maximum amount of candles to fetch
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex aster backpack binance bitvavo blofin bybit coinbaseinternational deribit grvt nado okx toobit weex


watchOrderBook

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

Kind: instance
Returns: object - an order book structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the order book for
limitintNothe maximum amount of order book entries to return.
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack binance bingx bitfinex bitget bithumb bitopro bittrade bitvavo blockchaincom blofin bullish bybit cex coinbaseinternational coincheck coinone cryptocom deepcoin deribit derive dydx extended gate gemini grvt hashkey hollaex htx hyperliquid independentreserve kucoin lighter luno mexc modetrade nado ndax okx onetrading pacifica phemex toobit upbit weex whitebit woo woofipro


watchOrderBookForSymbols

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

Kind: instance
Returns: object - an order book structure

ParamTypeRequiredDescription
symbolsArray<string>Yesunified array of symbols
limitintNothe maximum amount of order book entries to return.
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex aster backpack binance bitget bitvavo blofin bybit coinbaseinternational cryptocom deribit gemini grvt kucoin nado okx toobit weex


watchOrders

watches information on multiple orders made by the user

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market orders were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack binance bingx bitfinex bitget bithumb bitvavo blofin bullish bybit cex coinbaseinternational cryptocom deepcoin deribit derive extended gate grvt hashkey hollaex htx hyperliquid kucoin mexc modetrade nado okx onetrading pacifica phemex toobit upbit weex whitebit woo woofipro


watchOrdersForSymbols

watches information on multiple orders made by the user across multiple symbols

Kind: instance
Returns: Array<object> - a list of [order structures]{@link /docs/manual#order-structure

ParamTypeRequiredDescription
symbolsArray<string>Yes
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of order structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint
params.triggerbooleanNoset to true for trigger orders

Supported exchanges: blofin coinbaseinternational


watchPosition

watch open positions for a specific symbol

Kind: instance
Returns: object - a position structure

ParamTypeDescription
symbolstring, undefinedunified market symbol
paramsobjectextra parameters specific to the exchange API endpoint

Supported exchanges: kucoin


watchPositions

watch all open positions

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

ParamTypeRequiredDescription
symbolsArray<string>Nolist of unified market symbols
sinceintNothe earliest time in ms to fetch positions for
limitintNothe maximum number of positions to retrieve
paramsobjectYesextra parameters specific to the exchange API endpoint

Supported exchanges: apex aster backpack binance bingx bitget blofin bullish bybit coinbaseinternational cryptocom deepcoin derive extended gate grvt hashkey htx hyperliquid kucoin modetrade nado okx toobit weex woo woofipro


watchTicker

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

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolstringYesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack binance bingx bitfinex bitget bithumb bitopro bittrade bitvavo blockchaincom blofin bullish bybit cex coinbaseinternational coinone cryptocom deepcoin deribit derive gate grvt hashkey htx hyperliquid kucoin lighter mexc modetrade nado ndax okx onetrading pacifica phemex toobit upbit weex whitebit woo woofipro


watchTickers

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list

Kind: instance
Returns: object - a ticker structure

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to fetch the ticker for
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex aster backpack binance bitget bithumb bitvavo blofin bybit cex coinbaseinternational cryptocom deribit gate grvt hyperliquid kucoin lighter mexc modetrade nado okx onetrading pacifica phemex toobit upbit weex whitebit woo woofipro


watchTrades

watches information on multiple trades made in a market

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

ParamTypeRequiredDescription
symbolstringYesunified market symbol of the market trades were made in
sinceintNothe earliest time in ms to fetch orders for
limitintNothe maximum number of trade structures to retrieve
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: alpaca apex aster backpack binance bingx bitfinex bitget bithumb bitopro bittrade bitvavo blockchaincom blofin bullish bybit cex coinbaseinternational coincheck coinone cryptocom deepcoin deribit derive dydx extended gate gemini grvt hashkey hollaex htx hyperliquid independentreserve kucoin lighter luno mexc modetrade nado ndax okx pacifica phemex toobit upbit weex whitebit woo woofipro


watchTradesForSymbols

get the list of most recent trades for a list of symbols

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

ParamTypeRequiredDescription
symbolsArray<string>Yesunified symbol of the market to fetch trades for
sinceintNotimestamp in ms of the earliest trade to fetch
limitintNothe maximum amount of trades to fetch
paramsobjectNoextra parameters specific to the exchange API endpoint

Supported exchanges: apex aster backpack binance bitget bitvavo blofin bybit coinbaseinternational cryptocom deribit gate gemini grvt kucoin nado okx toobit upbit weex


withdraw

make a withdrawal

Kind: instance
Returns: object - a transaction structure

ParamTypeRequiredDescription
codestringYesunified currency code
amountfloatYesthe amount to withdraw
addressstringYesthe address to withdraw to
paramsobjectNoextra parameters specific to the exchange API endpoint
params.tagstringNomemo / destination tag, required for currencies in options['withdrawTagRequiredCurrencies']

Supported exchanges: alpaca aster backpack bigone binance bingx bitbank bitfinex bitflyer bitget bithumb bitopro bitrue bitso bitstamp bittrade bitvavo blockchaincom blofin btcmarkets bullish bybit coinbase coinbaseexchange coinmate coinsph cryptocom deribit derive digifinex dydx extended foxbit gate gemini grvt hashkey hibachi hitbtc hollaex htx hyperliquid independentreserve indodax kraken kucoin lbank lighter mercado mexc modetrade ndax okx pacifica phemex poloniex polymarket tokocrypto toobit upbit whitebit woo woofipro xt zaif


withdrawWs

make a withdrawal

Kind: instance
Returns: object - a transaction structure

ParamTypeRequiredDescription
codestringYesunified currency code
amountfloatYesthe amount to withdraw
addressstringYesthe address to withdraw to
paramsobjectNoextra parameters specific to the exchange API endpoint
params.tagstringNomemo / destination tag, required for currencies in options['withdrawTagRequiredCurrencies']

Supported exchanges: bitvavo

On this page

addMarginapproveBuilderCodebindAgentWalletborrowCrossMarginborrowIsolatedMargincalculateFeecalculatePricePrecisioncancelAllContractOrderscancelAllOrderscancelAllOrdersAftercancelAllOrdersWscancelAllSpotOrderscancelAllUtaOrderscancelContractOrdercancelOrdercancelOrderWscancelOrderscancelOrdersForSymbolscancelOrdersRequestcancelOrdersWscancelSpotOrdercancelTwapOrdercancelUtaOrdercloseAllPositionsclosePositioncreateApiKeycreateContractOrdercreateContractOrderscreateConvertTradecreateDepositAddresscreateGiftCodecreateMarketBuyOrderWithCostcreateMarketOrderWithCostcreateMarketSellOrderWithCostcreateOrdercreateOrderWscreateOrderscreateOrdersRequestcreateOrdersWscreateProxyCredentialscreateSpotOrdercreateSpotOrderscreateSubAccountcreateSwapOrdercreateTrailingAmountOrdercreateTrailingPercentOrdercreateTwapOrdercreateUtaOrdercreateVaultdepositeditContractOrdereditOrdereditOrderWseditOrdersenableDemoTradingenableUserDexAbstractionfetchADLRankfetchAccountfetchAccountIdByTypefetchAccountSettingsfetchAccountsfetchAllGreeksfetchApiKeysfetchBalancefetchBalanceWsfetchBidsAsksfetchBorrowInterestfetchBorrowRateHistoriesfetchBorrowRateHistoryfetchBuilderApprovalsfetchCanceledAndClosedOrdersfetchCanceledOrdersfetchClosedOrderfetchClosedOrdersfetchClosedOrdersWsfetchContractBalancefetchContractDepositAddressfetchContractDepositsfetchContractOrderfetchContractOrdersByStatusfetchContractWithdrawalsfetchConvertCurrenciesfetchConvertQuotefetchConvertTradefetchConvertTradeHistoryfetchCrossBorrowRatefetchCrossBorrowRatesfetchCurrenciesfetchCurrenciesWsfetchDepositfetchDepositAddressfetchDepositAddressesfetchDepositAddressesByNetworkfetchDepositMethodIdfetchDepositMethodIdsfetchDepositMethodsfetchDepositWithdrawFeefetchDepositWithdrawFeesfetchDepositsfetchDepositsWithdrawalsfetchDepositsWsfetchFundingHistoryfetchFundingIntervalfetchFundingIntervalsfetchFundingLimitsfetchFundingRatefetchFundingRateHistoryfetchFundingRatesfetchGreeksfetchHip3MarketsfetchIsolatedBorrowRatefetchIsolatedBorrowRatesfetchL3OrderBookfetchLastPricesfetchLedgerfetchLedgerEntryfetchLeveragefetchLeverageTiersfetchLeveragesfetchLiquidationsfetchLongShortRatioHistoryfetchMarginAdjustmentHistoryfetchMarginModefetchMarginModesfetchMarkOHLCVfetchMarkPricefetchMarkPricesfetchMarketLeverageTiersfetchMarketsfetchMarketsWsfetchMyContractTradesfetchMyDustTradesfetchMyLiquidationsfetchMySettlementHistoryfetchMySpotTradesfetchMyTradesfetchMyTradesWsfetchMyUtaTradesfetchOHLCVfetchOHLCVWsfetchOpenInterestfetchOpenInterestHistoryfetchOpenInterestsfetchOpenOrderfetchOpenOrdersfetchOpenOrdersWsfetchOptionfetchOptionChainfetchOptionPositionsfetchOrderfetchOrderBookfetchOrderBookWsfetchOrderBooksfetchOrderClassicfetchOrderTradesfetchOrderWsfetchOrdersfetchOrdersByIdsfetchOrdersByStatusfetchOrdersClassicfetchOrdersWsfetchPortfolioDetailsfetchPortfoliosfetchPositionfetchPositionHistoryfetchPositionModefetchPositionWsfetchPositionsfetchPositionsADLRankfetchPositionsForSymbolfetchPositionsHistoryfetchPositionsRiskfetchPositionsWsfetchSettlementHistoryfetchSpotMarketsfetchSpotOrderfetchSpotOrdersByStatusfetchStatusfetchSwapMarketsfetchTickerfetchTickerWsfetchTickersfetchTimefetchTradesfetchTradesWsfetchTradingFeefetchTradingFeesfetchTradingFeesWsfetchTradingLimitsfetchTransactionFeefetchTransactionFeesfetchTransactionsfetchTransferfetchTransfersfetchUnderlyingAssetsfetchUtaBalancefetchUtaOrderfetchUtaOrdersByStatusfetchVolatilityHistoryfetchWithdrawalfetchWithdrawalWhitelistfetchWithdrawalsfetchWithdrawalsWsisUTAEnabledisUnifiedEnabledloadMigrationStatusloadUnifiedStatusparseMarketpreLoadLighterLibraryredeemGiftCodereduceMarginrepayCrossMarginrepayIsolatedMarginrepayMarginreserveRequestWeightrevokeApiKeyrevokeBuilderCodesetAgentAbstractionsetContractLeveragesetLeveragesetMarginsetMarginModesetPositionModesetSandboxModesetUserAbstractionsignIntransfertransferClassictransferOuttransferUtaunWatchBalanceunWatchBidsAsksunWatchFundingRateunWatchFundingRatesunWatchMarkPriceunWatchMarkPricesunWatchMyTradesunWatchOHLCVunWatchOHLCVForSymbolsunWatchOrderBookunWatchOrderBookForSymbolsunWatchOrdersunWatchPositionsunWatchTickerunWatchTickersunWatchTradesunWatchTradesForSymbolsupgradeUnifiedTradeAccountverifyGiftCodewatchBalancewatchBidsAskswatchFundingRatewatchFundingRateswatchLiquidationswatchLiquidationsForSymbolswatchMarkPricewatchMarkPriceswatchMyLiquidationswatchMyLiquidationsForSymbolswatchMyTradeswatchOHLCVwatchOHLCVForSymbolswatchOrderBookwatchOrderBookForSymbolswatchOrderswatchOrdersForSymbolswatchPositionwatchPositionswatchTickerwatchTickerswatchTradeswatchTradesForSymbolswithdrawwithdrawWs