baseSpec

addMargin

add margin

Kind: instance
Returns: object - a margin structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
amount	`float`	Yes	amount of margin to add
params	`object`	No	extra parameters specific to the exchange API endpoint
params.account	`Account`	No	account id to use, required

Supported exchanges

borrowCrossMargin

create a loan to borrow margin

Kind: instance
Returns: object - a margin loan structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code of the currency to borrow
amount	`float`	Yes	the amount to borrow
params	`object`	No	extra parameters specific to the exchange API endpoint
params.portfolioMargin	`boolean`	No	set to true if you would like to borrow margin in a portfolio margin account

Supported exchanges

borrowIsolatedMargin

create a loan to borrow margin

Kind: instance
Returns: object - a margin loan structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol, required for isolated margin
code	`string`	Yes	unified currency code of the currency to borrow
amount	`float`	Yes	the amount to borrow
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

calculatePricePrecision

Helper function to calculate the Hyperliquid DECIMAL_PLACES price precision

Kind: instance
Returns: int - The calculated price precision

Param	Type	Description
price	`float`	the price to use in the calculation
amountPrecision	`int`	the amountPrecision to use in the calculation
maxDecimals	`int`	the maxDecimals to use in the calculation

Supported exchanges

hyperliquid

cancelAllContractOrders

helper method for cancelling all contract orders

Kind: instance
Returns: Response from the exchange

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params	`object`	No	extra parameters specific to the exchange API endpoint
params.trigger	`object`	No	When 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

Param	Type	Required	Description
symbol	`string`	Yes	alpaca cancelAllOrders cannot setting symbol, it will cancel all open orders
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

cancelAllOrdersAfter

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

Kind: instance
Returns: object - the api result

Param	Type	Required	Description
timeout	`number`	Yes	time in milliseconds, 0 represents cancel the timer
params	`object`	No	extra parameters specific to the exchange API endpoint
params.type	`string`	No	spot or swap market

Supported exchanges

cancelAllOrdersWs

cancel all open orders in a market

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

Param	Type	Required	Description
symbol	`string`	No	unified market symbol of the market to cancel orders in
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

cancelAllSpotOrders

helper method for cancelling all spot orders

Kind: instance
Returns: Response from the exchange

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params	`object`	No	extra parameters specific to the exchange API endpoint
params.trigger	`bool`	No	invalid for isolated margin true if cancelling all stop orders
params.marginMode	`string`	No	'cross' or 'isolated'
params.orderIds	`string`	No	stop orders only Comma separated order IDs
params.hf	`bool`	No	false, // true for hf order

Supported exchanges

kucoin

cancelAllUtaOrders

helper method for cancelling all uta orders

Kind: instance
Returns: Response from the exchange

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params	`object`	No	extra parameters specific to the exchange API endpoint
params.trigger	`bool`	No	true if cancelling all stop orders
params.marginMode	`string`	No	'CROSS' or 'ISOLATED'

Supported exchanges

kucoin

cancelContractOrder

helper method for cancelling contract orders

Kind: instance
Returns: object - An order structure

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.clientOrderId	`string`	No	cancel order by client order id

Supported exchanges

kucoin

cancelOrder

cancels an open order

Kind: instance
Returns: object - An order structure

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

cancelOrderWs

cancel multiple orders

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

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	No	unified market symbol, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint
params.cancelRestrictions	`string`, `undefined`	No	Supported 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.trigger	`boolean`	No	set to true if you would like to cancel a conditional order

Supported exchanges

cancelOrders

cancel multiple orders

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

Param	Type	Required	Description
ids	`Array<string>`	Yes	order ids
symbol	`string`	No	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint
params.account	`Account`	No	account to cancel orders for, required

Supported exchanges

cancelOrdersForSymbols

cancel multiple orders for multiple symbols

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

Param	Type	Required	Description
orders	`Array<CancellationRequest>`	Yes	list of order ids with symbol, example [{"id": "a", "symbol": "BTC/USDT"}, {"id": "b", "symbol": "ETH/USDT"}]
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

cancelOrdersRequest

build the request payload for cancelling multiple orders

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

Param	Type	Required	Description
ids	`Array<string>`	Yes	order ids
symbol	`string`	Yes	unified market symbol
params	`object`	No

Supported exchanges

hyperliquid

cancelOrdersWs

cancel multiple orders

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

Param	Type	Required	Description
ids	`Array<string>`	Yes	order ids
symbol	`string`	Yes	not used by cex cancelOrders()
params	`object`	No	extra parameters specific to the cex api endpoint

Supported exchanges

cancelSpotOrder

helper method for cancelling spot orders

Kind: instance
Returns: Response from the exchange

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.trigger	`bool`	No	True if cancelling a stop order
params.hf	`bool`	No	false, // true for hf order
params.sync	`bool`	No	false, // true to use the hf sync call
params.marginMode	`string`	No	'cross' or 'isolated'

Supported exchanges

kucoin

cancelTwapOrder

cancels a running twap order

Kind: instance
Returns: object - An order structure

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.expiresAfter	`int`	No	time in ms after which the twap order expires
params.vaultAddress	`string`	No	the vault address for order

Supported exchanges

hyperliquid

cancelUtaOrder

helper method for cancelling uta orders

Kind: instance
Returns: Response from the exchange

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.accountMode	`string`	No	'unified' or 'classic' (default is 'unified')
params.clientOrderId	`string`	No	client order id, required if id is not provided
params.marginMode	`string`	No	'cross' or 'isolated', required if fetching a margin order (unified accountMode supports only cross margin)

Supported exchanges

kucoin

closeAllPositions

closes all open positions for a market type

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.productType	`string`	No	'USDT-FUTURES', 'USDC-FUTURES', 'COIN-FUTURES', 'SUSDT-FUTURES', 'SUSDC-FUTURES' or 'SCOIN-FUTURES'
params.uta	`boolean`	No	set to true for the unified trading account (uta), defaults to false

Supported exchanges

closePosition

closes open positions for a market

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	Unified CCXT market symbol
side	`string`	No	not used by bingx
params	`object`	No	extra parameters specific to the bingx api endpoint
params.positionId	`string`, `undefined`	No	the id of the position you would like to close

Supported exchanges

closePositions

closes open positions for a market

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the bingx api endpoint
params.recvWindow	`string`	No	request valid time window value

Supported exchanges

createAccount

creates a sub-account under the main account

Kind: instance
Returns: object - a response object

Param	Type	Required	Description
name	`string`	Yes	the name of the sub-account
params	`object`	No	extra parameters specific to the exchange API endpoint
params.expiresAfter	`int`	No	time in ms after which the sub-account will expire

Supported exchanges

hyperliquid

createContractOrder

helper method for creating contract orders

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	Unified CCXT market symbol
type	`string`	Yes	'limit' or 'market'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	the amount of currency to trade
price	`float`	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint
params.takeProfit	`object`	No	takeProfit object in params containing the triggerPrice at which the attached take profit order will be triggered and the triggerPriceType
params.stopLoss	`object`	No	stopLoss object in params containing the triggerPrice at which the attached stop loss order will be triggered and the triggerPriceType
params.triggerPrice	`float`	No	The price a trigger order is triggered at
params.stopLossPrice	`float`	No	price to trigger stop-loss orders
params.takeProfitPrice	`float`	No	price to trigger take-profit orders
params.reduceOnly	`bool`	No	A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true.
params.timeInForce	`string`	No	GTC, GTT, IOC, or FOK, default is GTC, limit orders only
params.postOnly	`bool`	No	Post only flag, invalid when timeInForce is IOC or FOK
params.cost	`float`	No	the cost of the order in units of USDT
params.marginMode	`string`	No	'cross' or 'isolated', default is 'isolated'
params.hedged	`bool`	No	swap and future only true for hedged mode, false for one way mode, default is false ----------------- Exchange Specific Parameters -----------------
params.leverage	`float`	No	Leverage size of the order (mandatory param in request, default is 1)
params.clientOid	`string`	No	client order id, defaults to uuid if not passed
params.remark	`string`	No	remark for the order, length cannot exceed 100 utf8 characters
params.stop	`string`	No	'up' or 'down', the direction the triggerPrice is triggered from, requires triggerPrice. down: Triggers when the price reaches or goes below the triggerPrice. up: Triggers when the price reaches or goes above the triggerPrice.
params.triggerPriceType	`string`	No	"last", "mark", "index" - defaults to "mark"
params.stopPriceType	`string`	No	exchange-specific alternative for triggerPriceType: TP, IP or MP
params.closeOrder	`bool`	No	set to true to close position
params.test	`bool`	No	set to true to use the test order endpoint (does not submit order, use to validate params)
params.forceHold	`bool`	No	A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default.\
params.positionSide	`string`	No	swap and future only hedged two-way position side, LONG or SHORT

Supported exchanges

kucoin
weex

createContractOrders

helper method for creating contract orders in batch

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
orders	`Array`	Yes	list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

kucoin

createConvertTrade

convert from one currency to another

Kind: instance
Returns: object - a conversion structure

Param	Type	Required	Description
id	`string`	Yes	the id of the trade that you want to make
fromCode	`string`	Yes	the currency that you want to sell and convert from
toCode	`string`	Yes	the currency that you want to buy and convert into
amount	`float`	No	how much you want to trade in units of the from currency
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

createDepositAddress

create a currency deposit address

Kind: instance
Returns: object - an address structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code of the currency for the deposit address
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

createGiftCode

create gift code

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

Param	Type	Required	Description
code	`string`	Yes	gift code
amount	`float`	Yes	amount of currency for the gift
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

binance

createMarkeSellOrderWithCost

create a market sell order by providing the symbol and cost

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
cost	`float`	Yes	how much you want to trade in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

bybit

createMarketBuyOrderWithCost

create a market buy order by providing the symbol and cost

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
cost	`float`	Yes	how much you want to trade in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

createMarketOrderWithCost

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

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
side	`string`	Yes	'buy' or 'sell'
cost	`float`	Yes	how much you want to trade in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

createMarketSellOrderWithCost

create a market sell order by providing the symbol and cost

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
cost	`float`	Yes	how much you want to trade in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

createOrder

create a trade order

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of currency you want to trade in units of base currency
price	`float`	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint
params.reduceOnly	`bool`	No	true or false whether the order is reduce-only
params.account	`Account`	No	account id to use, required

Supported exchanges

createOrderWs

create a trade order

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of currency you want to trade in units of base currency
price	`float`, `undefined`	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint
params.test	`boolean`	Yes	test order, default false
params.returnRateLimits	`boolean`	Yes	set to true to return rate limit information, default false

Supported exchanges

createOrders

create a list of trade orders

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
orders	`Array`	Yes	list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params	`object`	No	extra parameters specific to the exchange API endpoint
params.account	`Account`	No	account id to use, required

Supported exchanges

createOrdersRequest

create a list of trade orders

Kind: instance
Returns: object - an order structure

Param	Type	Description
orders	`Array`	list 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

Param	Type	Required	Description
orders	`Array`	Yes	list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

createSpotOrder

create a trade order on spot market

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit' or 'LIMIT_MAKER'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of you want to trade in units of the base currency
price	`float`	No	the price that the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint
params.cost	`float`	No	market buy only the quote quantity that can be used as an alternative for the amount
params.test	`bool`	No	whether to use the test endpoint or not, default is false
params.postOnly	`bool`	No	if true, the order will only be posted to the order book and not executed immediately
params.timeInForce	`string`	No	'GTC', 'IOC', or 'PO'
params.clientOrderId	`string`	No	a unique id for the order

Supported exchanges

createSpotOrders

helper method for creating spot orders in batch

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
orders	`Array`	Yes	list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params	`object`	No	extra parameters specific to the exchange API endpoint
params.hf	`bool`	No	false, // true for hf orders
params.sync	`bool`	No	false, // 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

Param	Type	Required	Description
name	`string`	Yes	unused argument
params	`object`	No	extra parameters specific to the exchange API endpoint
params.expiryWindow	`int`	No	time to live in milliseconds
params.subAccountAddress	`string`	No	The public key (address) of the sub-account to use for creation
params.subAccountPrivateKey	`string`	No	The private key of the sub-account to use for creation

Supported exchanges

pacifica

createSwapOrder

create a trade order on swap market

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit' or 'STOP'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of you want to trade in units of the base currency
price	`float`	No	the price that the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint
params.postOnly	`bool`	No	if true, the order will only be posted to the order book and not executed immediately
params.reduceOnly	`bool`	No	true or false whether the order is reduce only
params.triggerPrice	`float`	No	The price at which a trigger order is triggered at
params.timeInForce	`string`	No	'GTC', 'FOK', 'IOC', 'LIMIT_MAKER' or 'PO'
params.clientOrderId	`string`	No	a 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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much you want to trade in units of the base currency, or number of contracts
price	`float`	No	the price for the order to be filled at, in units of the quote currency, ignored in market orders
trailingAmount	`float`	Yes	the quote amount to trail away from the current market price
trailingTriggerPrice	`float`	Yes	the price to activate a trailing order, default uses the price argument
params	`object`	No	extra 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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much you want to trade in units of the base currency, or number of contracts
price	`float`	No	the price for the order to be filled at, in units of the quote currency, ignored in market orders
trailingPercent	`float`	Yes	the percent to trail away from the current market price
trailingTriggerPrice	`float`	Yes	the price to activate a trailing order, default uses the price argument
params	`object`	No	extra 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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of currency you want to trade in units of base currency
duration	`int`	Yes	the duration of the TWAP order in milliseconds
params	`object`	No	extra parameters specific to the exchange API endpoint
params.randomize	`bool`	No	whether to randomize the time intervals of the TWAP order slices (default is false, meaning equal intervals)
params.reduceOnly	`bool`	No	true or false whether the order is reduce-only
params.expiresAfter	`int`	No	time in ms after which the twap order expires
params.vaultAddress	`string`	No	the vault address for order

Supported exchanges

hyperliquid

createUtaOrder

helper method for creating uta orders

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
symbol	`string`	Yes	Unified CCXT market symbol
type	`string`	Yes	'limit' or 'market'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	the amount of currency to trade
price	`float`	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint
params.clientOrderId	`string`	No	client order id, defaults to uuid if not passed
params.cost	`float`	No	the cost of the order in units of quote currency
params.timeInForce	`string`	No	GTC, GTD, IOC, FOK or PO
params.postOnly	`bool`	No	Post only flag, invalid when timeInForce is IOC or FOK (default is false)
params.reduceOnly	`bool`	No	contract markets only A mark to reduce the position size only. Set to false by default
params.triggerPrice	`float`	No	The price a trigger order is triggered at
params.triggerDirection	`string`	No	'ascending' or 'descending', the direction the triggerPrice is triggered from, requires triggerPrice
params.triggerPriceType	`string`	No	contract markets only "last", "mark", "index" - defaults to "mark"
params.stopLossPrice	`float`	No	price to trigger stop-loss orders
params.takeProfitPrice	`float`	No	price to trigger take-profit orders
params.marginMode	`string`	No	'cross' or 'isolated', (default is 'cross' for margin orders, default is 'isolated' for contract orders) Exchange-specific parameters -------------------------------------------------
params.accountMode	`string`	No	'unified' or 'classic', default is 'unified'
params.stp	`string`	No	'', // self trade prevention, CN, CO, CB or DC
params.cancelAfter	`int`	No	Cancel After N Seconds (Calculated from the time of entering the matching engine), only effective when timeInForce is GTD
params.sizeUnit	`string`	No	contracts only 'BASECCY' (amount of base currency) or 'UNIT' (number of contracts), default is 'UNIT' Classic account parameters
params.autoBorrow	`bool`	No	classic margin orders only
params.autoRepay	`bool`	No	classic margin orders only
params.hedged	`string`	No	classic contract orders only true for hedged mode, false for one way mode, default is false
params.leverage	`int`	No	classic 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

Param	Type	Required	Description
name	`string`	Yes	The name of the vault
description	`string`	Yes	The description of the vault
initialUsd	`number`	Yes	The initialUsd of the vault
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

hyperliquid

deposit

make a deposit

Kind: instance
Returns: object - a transaction structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
amount	`float`	Yes	the amount to deposit
id	`string`	Yes	the payment method id to be used for the deposit, can be retrieved from v2PrivateGetPaymentMethods
params	`object`	No	extra parameters specific to the exchange API endpoint
params.accountId	`string`	No	the id of the account to deposit into

Supported exchanges

coinbase

editContractOrder

edit a trade order

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
id	`string`	Yes	cancel order id
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of currency you want to trade in units of base currency
price	`float`	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint
params.portfolioMargin	`boolean`	No	set 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

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	No	unified symbol of the market to create an order in
type	`string`	No	'market', 'limit' or 'stop_limit'
side	`string`	No	'buy' or 'sell'
amount	`float`	No	how much of the currency you want to trade in units of the base currency
price	`float`	No	the price for the order, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint
params.triggerPrice	`string`	No	the price to trigger a stop order
params.timeInForce	`string`	No	for crypto trading either 'gtc' or 'ioc' can be used
params.clientOrderId	`string`	No	a unique identifier for the order, automatically generated if not sent

Supported exchanges

editOrderWs

edit a trade order

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of the currency you want to trade in units of the base currency
price	`float`, `undefined`	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

editOrders

edit a list of trade orders

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
orders	`Array`	Yes	list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

enableDemoTrading

enables or disables demo trading mode

Kind: instance

Param	Type	Required	Description
enable	`boolean`	No	true if demo trading should be enabled, false otherwise

Supported exchanges

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

Param	Type	Required	Description
enabled		Yes
params		Yes
params.type	`string`	No	'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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the auto deleveraging rank for
params	`object`	No	extra 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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

apex

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

Param	Type	Required	Description
type	`string`	Yes	'spot', 'swap' or 'future
marginMode	`string`	No	'cross' or 'isolated'
symbol	`string`	No	unified ccxt market symbol
params	`object`	No	extra 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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.account	`string`	No	will default to walletAddress if not provided

Supported exchanges

pacifica

fetchAccounts

query for accounts owned by the walletAddress. An Account is needed for all trading methods.

Kind: instance
Returns: Array - a list of account structures

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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 greeks structure

Param	Type	Required	Description
symbols	`Array<string>`	No	unified symbols of the markets to fetch greeks for, all markets are returned if not assigned
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchBalance

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

Kind: instance
Returns: object - a balance structure

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.account	`string`	No	account object ID, required

Supported exchanges

fetchBalanceWs

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

Kind: instance
Returns: object - a balance structure

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.type	`string`, `undefined`	No	'future', 'delivery', 'savings', 'funding', or 'spot'
params.marginMode	`string`, `undefined`	No	'cross' or 'isolated', for margin trading, uses this.options.defaultMarginMode if not passed, defaults to undefined/None/null
params.symbols	`Array<string>`, `undefined`	No	unified market symbols, only used in isolated margin mode
params.method	`string`, `undefined`	No	method to use. Can be account.balance, account.status, v2/account.balance or v2/account.status

Supported exchanges

fetchBidsAsks

fetches the bid and ask price and volume for multiple markets

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

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	unified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned
params	`object`	No	extra parameters specific to the exchange API endpoint
params.subType	`string`	No	"linear" or "inverse"

Supported exchanges

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

Param	Type	Required	Description
code	`string`	No	unified currency code
symbol	`string`	No	unified market symbol when fetch interest in isolated markets
since	`int`	No	the earliest time in ms to fetch borrrow interest for
limit	`int`	No	the maximum number of structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.portfolioMargin	`boolean`	No	set to true if you would like to fetch the borrow interest in a portfolio margin account

Supported exchanges

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

Param	Type	Required	Description
codes	`Array<string>`, `undefined`	Yes	list of unified currency codes, default is undefined
since	`int`	No	timestamp in ms of the earliest borrowRate, default is undefined
limit	`int`	No	max number of borrow rate prices to return, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint
params.marginMode	`string`	No	'cross' or 'isolated' default is 'cross'
params.until	`int`	No	the 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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
since	`int`	No	timestamp for the earliest borrow rate
limit	`int`	No	the maximum number of borrow rate structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchCanceledAndClosedOrders

fetches information on multiple canceled orders made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market the orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.paginate	`boolean`	No	default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.portfolioMargin	`boolean`	No	set to true if you would like to fetch orders in a portfolio margin account
params.trigger	`boolean`	No	set to true if you would like to fetch portfolio margin account trigger or conditional orders

Supported exchanges

fetchCanceledOrders

fetches information on multiple canceled orders made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market the orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.paginate	`boolean`	No	default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.portfolioMargin	`boolean`	No	set to true if you would like to fetch orders in a portfolio margin account
params.trigger	`boolean`	No	set to true if you would like to fetch portfolio margin account trigger or conditional orders

Supported exchanges

fetchClosedOrder

fetch an open order by it's id

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified market symbol, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchClosedOrders

fetches information on multiple closed orders made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	the latest time in ms to fetch orders for

Supported exchanges

fetchClosedOrdersWs

fetch closed orders

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch open orders for
limit	`int`	No	the maximum number of open orders structures to retrieve
params	`object`	No	extra 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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.code	`object`	No	the 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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra 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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
since	`int`	No	the earliest time in ms to fetch deposits for
limit	`int`	No	the maximum number of deposits structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

kucoin

fetchContractOrder

fetc contract order

Kind: instance
Returns: object - An order structure

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra 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

Param	Type	Required	Description
status	`string`	Yes	'active' or 'closed', only 'active' is valid for stop orders
symbol	`string`	Yes	unified symbol for the market to retrieve orders from
since	`int`	No	timestamp in ms of the earliest order to retrieve
limit	`int`	No	The maximum number of orders to retrieve
params	`object`	No	exchange specific parameters
params.trigger	`bool`	No	set to true to retrieve untriggered stop orders
params.until	`int`	No	End time in ms
params.side	`string`	No	buy or sell
params.type	`string`	No	limit or market
params.paginate	`boolean`	No	default 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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
since	`int`	No	the earliest time in ms to fetch withdrawals for
limit	`int`	No	the maximum number of withdrawals structures to retrieve
params	`object`	No	extra 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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchConvertQuote

fetch a quote for converting from one currency to another

Kind: instance
Returns: object - a conversion structure

Param	Type	Required	Description
fromCode	`string`	Yes	the currency that you want to sell and convert from
toCode	`string`	Yes	the currency that you want to buy and convert into
amount	`float`	Yes	how much you want to trade in units of the from currency
params	`object`	No	extra parameters specific to the exchange API endpoint
params.walletType	`string`	No	either 'SPOT' or 'FUNDING', the default is 'SPOT'

Supported exchanges

fetchConvertTrade

fetch the data for a conversion trade

Kind: instance
Returns: object - a conversion structure

Param	Type	Required	Description
id	`string`	Yes	the id of the trade that you want to fetch
code	`string`	No	the unified currency code of the conversion trade
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchConvertTradeHistory

fetch the users history of conversion trades

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

Param	Type	Required	Description
code	`string`	No	the unified currency code
since	`int`	No	the earliest time in ms to fetch conversions for
limit	`int`	No	the maximum number of conversion structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	timestamp in ms of the latest conversion to fetch

Supported exchanges

fetchCrossBorrowRate

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

Kind: instance
Returns: object - a borrow rate structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchCrossBorrowRates

fetch the borrow interest rates of all currencies

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchCurrencies

fetches all available currencies on an exchange

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchCurrenciesWs

fetches all available currencies on an exchange

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the bitvavo api endpoint

Supported exchanges

bitvavo

fetchDeposit

fetch information on a deposit

Kind: instance
Returns: object - a transaction structure

Param	Type	Required	Description
id	`string`	Yes	deposit id
code	`string`	Yes	not used by bitmart fetchDeposit ()
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchDepositAddress

fetch the deposit address for a currency associated with this account

Kind: instance
Returns: object - an address structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchDepositAddresses

fetch deposit addresses for multiple currencies (when available)

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

Param	Type	Required	Description
codes	`Array<string>`	No	list of unified currency codes, default is undefined (all currencies)
params	`object`	No	extra parameters specific to the exchange API endpoint
params.accountId	`string`	No	account ID to fetch deposit addresses for

Supported exchanges

fetchDepositAddressesByNetwork

fetch the deposit addresses for a currency associated with this account

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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchDepositMethodId

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

Kind: instance
Returns: object - a deposit id structure

Param	Type	Required	Description
id	`string`	Yes	the deposit payment method id
params	`object`	No	extra 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

Param	Type	Required	Description
params	`object`	No	extra 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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the kraken api endpoint

Supported exchanges

kraken

fetchDepositWithdrawFee

fetch the fee for deposits and withdrawals

Kind: instance
Returns: object - a fee structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint
params.network	`string`	No	the network code of the currency

Supported exchanges

fetchDepositWithdrawFees

fetch deposit and withdraw fees

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

Param	Type	Required	Description
codes	`Array<string>`, `undefined`	Yes	list of unified currency codes
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchDeposits

fetch all deposits made to an account

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

Param	Type	Required	Description
code	`string`	No	unified currency code
since	`int`	No	the earliest time in ms to fetch deposits for
limit	`int`	No	the maximum number of deposit structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchDepositsWithdrawals

fetch history of deposits and withdrawals

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

Param	Type	Required	Description
code	`string`	No	unified currency code for the currency of the deposit/withdrawals, default is undefined
since	`int`	No	timestamp in ms of the earliest deposit/withdrawal, default is undefined
limit	`int`	No	max number of deposit/withdrawals to return, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchDepositsWs

fetch all deposits made to an account

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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
since	`int`	No	the earliest time in ms to fetch deposits for
limit	`int`	No	the maximum number of deposits structures to retrieve
params	`object`	No	extra parameters specific to the bitvavo 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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve, default 100
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`object`	No	end time, ms
params.side	`boolean`	No	BUY or SELL
params.page	`boolean`	No	Page numbers start from 0

Supported exchanges

fetchFundingInterval

fetch the current funding rate interval

Kind: instance
Returns: object - a funding rate structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint
params.uta	`boolean`	No	set to true for the unified trading account (uta), defaults to false

Supported exchanges

fetchFundingIntervals

fetch the funding rate interval for multiple markets

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

Param	Type	Required	Description
symbols	`Array<string>`	No	list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchFundingLimits

fetch the deposit and withdrawal limits for a currency

Kind: instance
Returns: object - a funding limits structure

Param	Type	Required	Description
codes	`Array<string>`, `undefined`	Yes	unified currency codes
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

whitebit

fetchFundingRate

fetch the current funding rate

Kind: instance
Returns: object - a funding rate structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchFundingRateHistory

fetches historical funding rate prices

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the funding rate history for
since	`int`	No	timestamp in ms of the earliest funding rate to fetch
limit	`int`	No	the maximum amount of funding rate structures to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	timestamp in ms of the latest funding rate
params.paginate	`boolean`	No	default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges

fetchFundingRates

fetch the funding rate for multiple markets

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

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch greeks for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchHip3Markets

retrieves data on all hip3 markets for hyperliquid

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

Param	Type	Required	Description
params	`object`	No	extra 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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint EXCHANGE SPECIFIC PARAMETERS
params.vipLevel	`object`	No	user's current specific margin data will be returned if viplevel is omitted

Supported exchanges

fetchIsolatedBorrowRates

fetch the borrow interest rates of all currencies

Kind: instance
Returns: object - a borrow rate structure

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.symbol	`object`	No	unified market symbol EXCHANGE SPECIFIC PARAMETERS
params.vipLevel	`object`	No	user's current specific margin data will be returned if viplevel is omitted

Supported exchanges

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
limit	`int`	No	max number of orders to return, default is undefined
params	`object`	No	extra 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

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	unified symbols of the markets to fetch the last prices
params	`object`	No	extra parameters specific to the exchange API endpoint
params.subType	`string`	No	"linear" or "inverse"

Supported exchanges

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

Param	Type	Required	Description
code	`string`	No	unified currency code
since	`int`	No	timestamp in ms of the earliest ledger entry
limit	`int`	No	max number of ledger entries to return
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	timestamp in ms of the latest ledger entry

Supported exchanges

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

Param	Type	Required	Description
id	`string`	Yes	the identification number of the ledger entry
code	`string`	Yes	unified currency code
params	`object`	No	extra 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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchLeverages

fetch the set leverage for all contract markets

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

Param	Type	Required	Description
symbols	`Array<string>`	No	a list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchLiquidations

retrieves the public liquidations of a trading pair

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

Param	Type	Required	Description
symbol	`string`	Yes	unified CCXT market symbol
since	`int`	No	the earliest time in ms to fetch liquidations for
limit	`int`	No	the maximum number of liquidation structures to retrieve
params	`object`	No	exchange specific parameters
params.until	`int`	No	timestamp in ms of the latest liquidation
params.paginate	`boolean`	No	default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters

Supported exchanges

fetchLongShortRatioHistory

fetches the long short ratio history for a unified market symbol

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the long short ratio for
timeframe	`string`	No	the period for the ratio, default is 24 hours
since	`int`	No	the earliest time in ms to fetch ratios for
limit	`int`	No	the maximum number of long short ratio structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	timestamp in ms of the latest ratio to fetch

Supported exchanges

fetchMarginAdjustmentHistory

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

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
type	`string`	No	"add" or "reduce"
since	`int`	No	timestamp in ms of the earliest change to fetch
limit	`int`	No	the maximum amount of changes to fetch
params	`object`	Yes	extra parameters specific to the exchange api endpoint
params.until	`int`	No	timestamp in ms of the latest change to fetch

Supported exchanges

fetchMarginMode

fetches the margin mode of a specific symbol

Kind: instance
Returns: object - a margin mode structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.subType	`string`	No	"linear" or "inverse"

Supported exchanges

fetchMarginModes

fetches the set margin mode of the user

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

Param	Type	Required	Description
symbols	`Array<string>`	No	a list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchMarkPrice

fetches mark price for the market

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.subType	`string`	No	"linear" or "inverse"

Supported exchanges

fetchMarkPrices

fetches mark prices for multiple markets

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

Param	Type	Required	Description
symbols	`Array<string>`	No	unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params	`object`	No	extra parameters specific to the exchange API endpoint
params.subType	`string`	No	"linear" or "inverse"

Supported exchanges

fetchMarketLeverageTiers

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

Kind: instance
Returns: object - a leverage tiers structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchMarkets

retrieves data on all markets for woo

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchMarketsWs

retrieves data on all markets for bitvavo

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

Param	Type	Required	Description
params	`object`	No	extra 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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trades structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	End time in ms
params.paginate	`boolean`	No	default 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

Param	Type	Required	Description
symbol	`string`	Yes	not used by binance fetchMyDustTrades ()
since	`int`	No	the earliest time in ms to fetch my dust trades for
limit	`int`	No	the maximum number of dust trades to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.type	`string`	No	'spot' or 'margin', default spot

Supported exchanges

binance

fetchMyLiquidations

retrieves the users liquidated positions

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

Param	Type	Required	Description
symbol	`string`	No	unified CCXT market symbol
since	`int`	No	the earliest time in ms to fetch liquidations for
limit	`int`	No	the maximum number of liquidation structures to retrieve
params	`object`	No	exchange specific parameters for the binance api endpoint
params.until	`int`	No	timestamp in ms of the latest liquidation
params.paginate	`boolean`	No	spot only default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.portfolioMargin	`boolean`	No	set to true if you would like to fetch liquidations in a portfolio margin account
params.type	`string`	No	"spot"
params.subType	`string`	No	"linear" or "inverse"

Supported exchanges

fetchMySettlementHistory

fetches historical settlement records of the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the settlement history
since	`int`	No	timestamp in ms
limit	`int`	No	number of records
params	`object`	No	exchange specific params

Supported exchanges

fetchMySpotTrades

fetch all spot trades made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trades structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	the latest time in ms to fetch entries for
params.hf	`bool`	No	false, // true for hf order
params.marginMode	`string`	No	'cross' or 'isolated', only for margin trades
params.paginate	`boolean`	No	default 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

Param	Type	Required	Description
symbol	`string`	No	unified market symbol
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trade structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	the latest time in ms to fetch trades for
params.page_token	`string`	No	page_token - used for paging

Supported exchanges

fetchMyTradesWs

fetch all trades made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`, `undefined`	No	the earliest time in ms to fetch trades for
limit	`int`, `undefined`	No	the maximum number of trades structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.endTime	`int`	No	the latest time in ms to fetch trades for
params.fromId	`int`	No	first trade Id to fetch

Supported exchanges

fetchMyUtaTrades

fetch all trades made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trades structures to retrieve (default is 50, max is 200)
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	the latest time in ms to fetch entries for
params.accountMode	`string`	No	'unified' or 'classic', defaults to 'unified'
params.marginMode	`string`	No	'cross' or 'isolated', only for margin trades (unified accountMode support only cross margin)
params.side	`string`	No	'BUY' or 'SELL' (both if not provided)
params.paginate	`boolean`	No	default 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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch OHLCV data for
timeframe	`string`	Yes	the length of time each candle represents
since	`int`	No	timestamp in ms of the earliest candle to fetch
limit	`int`	No	max=1000, max=100 when since is defined and is less than (now - (999 * (timeframe in ms)))
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Description
symbol	`string`	unified symbol of the market to query OHLCV data for
timeframe	`string`	the length of time each candle represents
since	`int`	timestamp in ms of the earliest candle to fetch
limit	`int`	the maximum amount of candles to fetch
params	`object`	extra parameters specific to the exchange API endpoint
params.until	`int`	timestamp in ms of the earliest candle to fetch EXCHANGE SPECIFIC PARAMETERS
params.timeZone	`string`	default=0 (UTC)

Supported exchanges

fetchOpenInterest

retrieves the open interest of a contract trading pair

Kind: instance
Returns: object - an open interest structurehttps://docs.ccxt.com/?id=open-interest-structure

Param	Type	Required	Description
symbol	`string`	Yes	unified CCXT market symbol
params	`object`	No	exchange specific parameters

Supported exchanges

fetchOpenInterestHistory

Retrieves the open interest history of a currency

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

Param	Type	Required	Description
symbol	`string`	Yes	Unified CCXT market symbol
timeframe	`string`	Yes	"5m","15m","30m","1h","2h","4h","6h","12h", or "1d"
since	`int`	No	the time(ms) of the earliest record to retrieve as a unix timestamp
limit	`int`	No	default 30, max 500
params	`object`	No	exchange specific parameters
params.until	`int`	No	the time(ms) of the latest record to retrieve as a unix timestamp
params.paginate	`boolean`	No	default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters

Supported exchanges

fetchOpenInterests

Retrieves the open interest for a list of symbols

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

Param	Type	Required	Description
symbols	`Array<string>`	No	a list of unified CCXT market symbols
params	`object`	No	exchange specific parameters

Supported exchanges

fetchOpenOrder

fetch an open order by the id

Kind: instance
Returns: object - an order structure

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchOpenOrders

fetch all unfilled currently open orders

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch open orders for
limit	`int`	No	the maximum number of open orders structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.accountNumber	`int`	No	account number to query orders for, required

Supported exchanges

fetchOpenOrdersWs

fetch all unfilled currently open orders

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`, `undefined`	No	the earliest time in ms to fetch open orders for
limit	`int`, `undefined`	No	the maximum number of open orders structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchOption

fetches option data that is commonly found in an option chain

Kind: instance
Returns: object - an option chain structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
code	`string`	Yes	base currency to fetch an option chain for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchOptionPositions

fetch data on open options positions

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

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	list of unified market symbols
params	`object`	No	extra 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

Param	Type	Required	Description
id	`string`	Yes	the order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchOrderBook

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 indexed by market symbols

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the order book for
limit	`int`	No	the maximum amount of order book entries to return
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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 indexed by market symbols

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the order book for
limit	`int`	No	the maximum amount of order book entries to return
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	list of unified market symbols, all symbols fetched if undefined, default is undefined
limit	`int`	No	max number of entries per orderbook to return, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchOrderClassic

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

Kind: instance
Returns: object - An order structure

Param	Type	Required	Description
id	`string`	Yes	the order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra 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

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trades to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchOrderWs

fetches information on an order made by the user

Kind: instance
Returns: object - An order structure

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	No	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchOrders

fetches information on multiple orders made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	the latest time in ms to fetch orders for

Supported exchanges

fetchOrdersByIds

fetch orders by the list of order id

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

Param	Type	Required	Description
ids	`Array<string>`	No	list of order id
symbol	`string`	No	unified ccxt market symbol
params	`object`	No	extra parameters specific to the kraken api endpoint

Supported exchanges

kraken

fetchOrdersByStatus

fetch a list of orders

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

Param	Type	Required	Description
status	`string`	Yes	order status to fetch for
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.trigger	`boolean`	No	set to true for fetching trigger orders
params.marginMode	`string`	No	'cross' or 'isolated' for fetching spot margin orders

Supported exchanges

fetchOrdersClassic

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

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.trigger	`boolean`	No	true if trigger order
params.stop	`boolean`	No	alias for trigger
params.type	`string`	No	market type, ['swap', 'option', 'spot']
params.subType	`string`	No	market subType, ['linear', 'inverse']
params.orderFilter	`string`	No	'Order' or 'StopOrder' or 'tpslOrder'
params.until	`int`	No	the latest time in ms to fetch entries for
params.paginate	`boolean`	No	default 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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`, `undefined`	No	the earliest time in ms to fetch orders for
limit	`int`, `undefined`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.orderId	`int`	No	order id to begin at
params.startTime	`int`	No	earliest time in ms to retrieve orders for
params.endTime	`int`	No	latest time in ms to retrieve orders for
params.limit	`int`	No	the maximum number of order structures to retrieve

Supported exchanges

fetchPortfolioDetails

Fetch details for a specific portfolio by UUID

Kind: instance
Returns: Array<any> - An account structure https://docs.ccxt.com/?id=account-structure

Param	Type	Required	Description
portfolioUuid	`string`	Yes	The unique identifier of the portfolio to fetch
params	`Dict`	No	Extra 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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

coinbase

fetchPosition

fetch data on an open position

Kind: instance
Returns: object - a position structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market the position is held in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.accountNumber	`int`	No	account number to query positions for, required

Supported exchanges

fetchPositionADLRank

fetches the auto deleveraging rank and risk percentage for a list of symbols

Kind: instance
Returns: object - an array of auto de leverage structures

Param	Type	Required	Description
symbols	`Array<string>`	No	list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint
params.code	`string`	No	the currency code to fetch ranks for, USD, BTC or USDT, USDT is the default
params.method	`string`	No	USDT contracts only 'privateGetGAccountsAccountPositions' or 'privateGetGAccountsAccountPositions' default is 'privateGetGAccountsAccountPositions'

Supported exchanges

phemex

fetchPositionHistory

fetches historical positions

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

Param	Type	Required	Description
symbol	`string`	Yes	unified contract symbol
since	`int`	No	the earliest time in ms to fetch positions for
limit	`int`	No	the maximum amount of records to fetch
params	`object`	No	extra parameters specific to the exchange api endpoint
params.until	`int`	No	the latest time in ms to fetch positions for

Supported exchanges

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the order book for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchPositionWs

fetch data on an open position

Kind: instance
Returns: object - a position structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market the position is held in
params	`object`	No	extra 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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint
params.accountNumber	`int`	No	account number to query positions for, required

Supported exchanges

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

Param	Type	Required	Description
symbols	`Array<string>`	No	list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint
params.portfolioMargin	`boolean`	No	set to true for the portfolio margin account

Supported exchanges

fetchPositionsForSymbol

fetch all open positions for specific symbol

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint
params.contractType	`string`	No	FUTURE or DELIVERY, default is FUTURE

Supported exchanges

fetchPositionsHistory

fetches historical positions

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

Param	Type	Required	Description
symbols	`Array<string>`	No	unified contract symbols
since	`int`	No	timestamp in ms of the earliest position to fetch, default=3 months ago, max range for params["until"] - since is 3 months
limit	`int`	No	the maximum amount of records to fetch, default=20, max=100
params	`object`	Yes	extra parameters specific to the exchange api endpoint
params.until	`int`	No	timestamp in ms of the latest position to fetch, max range for params["until"] - since is 3 months
params.productType	`string`	No	USDT-FUTURES (default), COIN-FUTURES, USDC-FUTURES, SUSDT-FUTURES, SCOIN-FUTURES, or SUSDC-FUTURES
params.uta	`boolean`	No	set to true for the unified trading account (uta), defaults to false

Supported exchanges

fetchPositionsRisk

fetch positions risk

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

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	list of unified market symbols
params	`object`	No	extra 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

Param	Type	Required	Description
symbols	`Array<string>`	No	list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint
params.returnRateLimits	`boolean`	No	set to true to return rate limit informations, defaults to false.
params.method	`string`, `undefined`	No	method to use. Can be account.position or v2/account.position

Supported exchanges

binance

fetchSettlementHistory

fetches historical settlement records

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the settlement history
since	`int`	No	timestamp in ms
limit	`int`	No	number of records, default 100, max 100
params	`object`	No	exchange specific params

Supported exchanges

fetchSpotMarkets

retrieves data on all spot markets for hyperliquid

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

hyperliquid

fetchSpotOrder

fetch a spot order

Kind: instance
Returns: An order structure

Param	Type	Required	Description
id	`string`	Yes	Order id
symbol	`string`	Yes	not sent to exchange except for trigger orders with clientOid, but used internally by CCXT to filter
params	`object`	No	exchange specific parameters
params.trigger	`bool`	No	true if fetching a trigger order
params.hf	`bool`	No	false, // true for hf order
params.clientOid	`bool`	No	unique order id created by users to identify their orders
params.marginMode	`object`	No	'cross' or 'isolated'

Supported exchanges

kucoin

fetchSpotOrdersByStatus

fetch a list of spot orders

Kind: instance
Returns: An array of order structures

Param	Type	Required	Description
status	`string`	Yes	not used for stop orders 'open' or 'closed'
symbol	`string`	Yes	unified market symbol
since	`int`	No	timestamp in ms of the earliest order
limit	`int`	No	max number of orders to return
params	`object`	No	exchange specific params
params.until	`int`	No	end time in ms
params.side	`string`	No	buy or sell
params.type	`string`	No	limit, market, limit_stop or market_stop
params.tradeType	`string`	No	TRADE for spot trading, MARGIN_TRADE or MARGIN_ISOLATED_TRADE for Margin Trading
params.currentPage	`int`	No	trigger orders only current page
params.orderIds	`string`	No	trigger orders only comma separated order ID list
params.trigger	`bool`	No	True if fetching a trigger order
params.hf	`bool`	No	false, // true for hf order
params.marginMode	`string`	No	'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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchSwapMarkets

retrieves data on all swap markets for hyperliquid

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.method	`string`	No	method to use can be ticker.price or ticker.book
params.returnRateLimits	`boolean`	No	return the rate limits for the exchange

Supported exchanges

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbols of the markets to fetch tickers for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.loc	`string`	No	crypto location, default: us

Supported exchanges

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchTrades

get the list of most recent trades for a particular symbol

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch trades for
since	`int`	No	timestamp in ms of the earliest trade to fetch
limit	`int`	No	the maximum amount of trades to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	the latest time in ms to fetch trades for

Supported exchanges

fetchTradesWs

fetch all trades made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trades structures to retrieve, default=500, max=1000
params	`object`	No	extra parameters specific to the exchange API endpoint EXCHANGE SPECIFIC PARAMETERS
params.fromId	`int`	No	trade ID to begin at

Supported exchanges

fetchTradingFee

fetch the trading fees for a market

Kind: instance
Returns: object - a fee structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchTradingFees

fetch the trading fees for multiple markets

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.subType	`string`	No	"linear" or "inverse"

Supported exchanges

fetchTradingFeesWs

fetch the trading fees for multiple markets

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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the bitvavo api endpoint

Supported exchanges

bitvavo

fetchTradingLimits

fetch the trading limits for a market

Kind: instance
Returns: object - a trading limits structure

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

whitebit

fetchTransactionFee

please use fetchDepositWithdrawFee instead

Kind: instance
Returns: object - a fee structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint
params.network	`string`	No	the network code of the currency

Supported exchanges

fetchTransactionFees

please use fetchDepositWithdrawFees instead

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

Param	Type	Required	Description
codes	`Array<string>`, `undefined`	Yes	not used by binance fetchTransactionFees ()
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchTransactions

Fetch all transactions (deposits and withdrawals) made from an account.

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

Param	Type	Required	Description
code	`string`	No	unified currency code
since	`int`	No	the earliest time in ms to fetch withdrawals for
limit	`int`	No	the maximum number of withdrawal structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchTransfer

fetches a transfer

Kind: instance
Returns: object - a transfer structure

Param	Type	Required	Description
id	`string`	Yes	transfer id
code	`string`	No	not used by mexc fetchTransfer
params	`object`	Yes	extra parameters specific to the exchange api endpoint

Supported exchanges

mexc

fetchTransfers

fetch a history of internal transfers made on an account

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

Param	Type	Required	Description
code	`string`	Yes	unified currency code of the currency transferred
since	`int`	No	the earliest time in ms to fetch transfers for
limit	`int`	No	the maximum number of transfers structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	the latest time in ms to fetch transfers for
params.paginate	`boolean`	No	default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
params.internal	`boolean`	No	default false, when true will fetch pay trade history

Supported exchanges

fetchUnderlyingAssets

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

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

Param	Type	Required	Description
params	`object`	No	exchange specific params
params.type	`string`	No	the 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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.type	`string`	No	'unified', 'spot', 'funding', 'cross', 'isolated' or 'swap' (default is 'unified')
params.marginMode	`string`	No	'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

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified symbol of the market the order was made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.accountMode	`string`	No	'unified' or 'classic' (default is 'unified')
params.clientOrderId	`string`	No	client order id, required if id is not provided
params.marginMode	`string`	No	'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

Param	Type	Required	Description
status	`string`	Yes	'active' or 'closed', only 'active' is valid for stop orders
symbol	`string`	Yes	unified symbol for the market to retrieve orders from
since	`int`	No	timestamp in ms of the earliest order to retrieve
limit	`int`	No	The maximum number of orders to retrieve
params	`object`	No	exchange specific parameters
params.until	`int`	No	End time in ms
params.side	`string`	No	closed orders only 'BUY' or 'SELL'
params.accountMode	`string`	No	'unified' or 'classic' (default is unified)
params.marginMode	`string`	No	'cross' or 'isolated', only for margin orders (unified accountMode supports only cross margin)
params.paginate	`boolean`	No	default 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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint
params.period	`int`	No	the period in days to fetch the volatility for: 7,14,21,30,60,90,180,270

Supported exchanges

fetchWithdrawal

fetch data on a currency withdrawal via the withdrawal id

Kind: instance
Returns: object - a transaction structure

Param	Type	Required	Description
id	`string`	Yes	withdrawal id
code	`string`	Yes	not used by bitmart.fetchWithdrawal
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchWithdrawals

fetch all withdrawals made from an account

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

Param	Type	Required	Description
code	`string`	No	unified currency code
since	`int`	No	the earliest time in ms to fetch withdrawals for
limit	`int`	No	the maximum number of withdrawal structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

fetchWithdrawalsWs

fetch all withdrawals made from an account

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

Param	Type	Required	Description
code	`string`	Yes	unified currency code
since	`int`	No	the earliest time in ms to fetch withdrawals for
limit	`int`	No	the maximum number of withdrawals structures to retrieve
params	`object`	No	extra parameters specific to the bitvavo 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

Param	Type	Required	Description
params	`object`	No	extra 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]

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

loadMigrationStatus

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

Kind: instance
Returns: any - ignore

Param	Type	Description
force	`boolean`	load 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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

gate

market

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

Param	Type	Description
symbol	`string`	unified market symbol
type	`string`	not used by btcmarkets.calculateFee
side	`string`	not used by btcmarkets.calculateFee
amount	`float`	how much you want to trade, in units of the base currency on most exchanges, or number of contracts
price	`float`	the price for the order to be filled at, in units of the quote currency
takerOrMaker	`string`	'taker' or 'maker'
params	`object`

Supported exchanges

<anonymous>

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

Param
params

Supported exchanges

lighter

redeemGiftCode

redeem gift code

Kind: instance
Returns: object - response from the exchange

Param	Type	Required	Description
giftcardCode	`string`	Yes
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

binance

reduceMargin

remove margin from a position

Kind: instance
Returns: object - a margin structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
amount	`float`	Yes	amount of margin to remove
params	`object`	No	extra parameters specific to the exchange API endpoint
params.account	`Account`	No	account id to use, required

Supported exchanges

repayCrossMargin

repay borrowed margin and interest

Kind: instance
Returns: object - a margin loan structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code of the currency to repay
amount	`float`	Yes	the amount to repay
params	`object`	No	extra parameters specific to the exchange API endpoint
params.portfolioMargin	`boolean`	No	set to true if you would like to repay margin in a portfolio margin account
params.repayCrossMarginMethod	`string`	No	portfolio margin only 'papiPostRepayLoan' (default), 'papiPostMarginRepayDebt' (alternative)
params.specifyRepayAssets	`string`	No	portfolio margin papiPostMarginRepayDebt only specific asset list to repay debt

Supported exchanges

repayIsolatedMargin

repay borrowed margin and interest

Kind: instance
Returns: object - a margin loan structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol, required for isolated margin
code	`string`	Yes	unified currency code of the currency to repay
amount	`float`	Yes	the amount to repay
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

repayMargin

repay borrowed margin and interest

Kind: instance
Returns: object - a margin loan structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code of the currency to repay
amount	`float`	Yes	the amount to repay
symbol	`string`	Yes	not used by woo.repayMargin ()
params	`object`	No	extra 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

Param	Type	Required	Description
weight	`number`	Yes	the weight to reserve, 1 weight = 1 action, 0.0005 USDC per action
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

hyperliquid

setAgentAbstraction

set agent abstraction mode

Kind: instance
Returns: dictionary response from the exchange

Param	Type	Required	Description
abstraction	`string`	Yes	one of the strings ["i", "u", "p"] where "i" is "disabled", "u" is "unifiedAccount", and "p" is "portfolioMargin"
params	`object`	No

Supported exchanges

hyperliquid

setContractLeverage

set the level of leverage for a market

Kind: instance
Returns: object - response from the exchange

Param	Type	Required	Description
leverage	`float`	Yes	the rate of leverage
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint
params.uta	`boolean`	No	set 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

Param	Type	Required	Description
leverage	`float`	Yes	the rate of leverage
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint
params.account	`Account`	No	account id to use, required

Supported exchanges

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market to set margin in
amount	`float`	Yes	the amount to set the margin to
params	`object`	No	parameters specific to the bingx api endpoint

Supported exchanges

setMarginMode

set margin mode to 'cross' or 'isolated'

Kind: instance
Returns: object - response from the exchange

Param	Type	Required	Description
marginMode	`string`	Yes	'cross' or 'isolated'
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

setPositionMode

set hedged to true or false for a market

Kind: instance
Returns: object - response from the exchange

Param	Type	Required	Description
hedged	`bool`	Yes	set to true to use dualSidePosition
symbol	`string`	Yes	not used by bingx setPositionMode ()
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
abstraction	`string`	Yes	one of the strings ["disabled", "unifiedAccount", "portfolioMargin"],
params	`object`	No
params.type	`string`	No	'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

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

signTxEd25519

Helper to sign some transaction bytes and return a generic transaction execution request.

Kind: instance
Returns: object - the input transaction bytes and the signed digest

Param	Type	Required	Description
tx	`object`	No	transaction bytes and the signing digest for them

Supported exchanges

aftermath

transfer

transfer currency internally between wallets on the same account

Kind: instance
Returns: object - a transfer structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
amount	`float`	Yes	amount to transfer
fromAccount	`string`	Yes	account to transfer from
toAccount	`string`	Yes	account to transfer to
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

transferClassic

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

Kind: instance
Returns: object - a transfer structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
amount	`float`	Yes	amount to transfer
fromAccount	`string`	Yes	account to transfer from
toAccount	`string`	Yes	account to transfer to
params	`object`	No	extra parameters specific to the exchange API endpoint
params.transferType	`string`	No	INTERNAL, PARENT_TO_SUB, SUB_TO_PARENT (default is INTERNAL)
params.fromUserId	`string`	No	required if transferType is SUB_TO_PARENT
params.toUserId	`string`	No	required if transferType is PARENT_TO_SUB

Supported exchanges

kucoin

transferOut

transfer from spot wallet to futures wallet

Kind: instance
Returns: a transfer structure

Param	Type	Required	Description
code	`str`	Yes	Unified currency code
amount	`float`	Yes	Size of the transfer
params	`dict`	No	Exchange specific parameters

Supported exchanges

transferUta

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

Kind: instance
Returns: object - a transfer structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
amount	`float`	Yes	amount to transfer
fromAccount	`string`	Yes	account to transfer from
toAccount	`string`	Yes	account to transfer to
params	`object`	No	extra parameters specific to the exchange API endpoint
params.transferType	`string`	No	INTERNAL, PARENT_TO_SUB, SUB_TO_PARENT, SUB_TO_SUB (default is INTERNAL)
params.fromUserId	`string`	No	required if transferType is SUB_TO_PARENT or SUB_TO_SUB
params.toUserId	`string`	No	required if transferType is PARENT_TO_SUB or SUB_TO_SUB

Supported exchanges

kucoin

unWatchBalance

unWatches balance

Kind: instance
Returns: object - status of the unwatch request

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

hyperliquid

unWatchBidsAsks

unWatches best bid & ask for symbols

Kind: instance
Returns: object - a ticker structure

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

unWatchFundingRate

unWatches the current funding rate for a symbol

Kind: instance
Returns: object - a funding rate structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

mexc

unWatchMarkPrice

unWatches a mark price for a specific market

Kind: instance
Returns: object - a ticker structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.use1sFreq	`boolean`	No	default is true if set to true, the mark price will be updated every second, otherwise every 3 seconds

Supported exchanges

unWatchMarkPrices

watches the mark price for all markets

Kind: instance
Returns: object - a ticker structure

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.use1sFreq	`boolean`	No	default is true if set to true, the mark price will be updated every second, otherwise every 3 seconds

Supported exchanges

unWatchMyTrades

unWatches information on multiple trades made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
params	`object`	No	extra parameters specific to the exchange API endpoint
params.unifiedMargin	`boolean`	No	use unified margin account
params.executionFast	`boolean`	No	use fast execution

Supported exchanges

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch OHLCV data for
timeframe	`string`	Yes	the length of time each candle represents
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbolsAndTimeframes	`Array<Array<string>>`	Yes	array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example 'BTC/USDT', '1m'], ['LTC/USDT', '5m'
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

unWatchOrderBook

unsubscribe from the orderbook channel

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

Param	Type	Required	Description
symbol	`string`	Yes	symbol of the market to unwatch the trades for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.limit	`int`	No	orderbook limit, default is undefined

Supported exchanges

unWatchOrderBookForSymbols

unsubscribe from the orderbook channel

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to unwatch the trades for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.limit	`int`	No	orderbook limit, default is undefined

Supported exchanges

unWatchOrders

unWatches information on multiple orders made by the user

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

Param	Type	Required	Description
symbol	`string`	No	unified market symbol of the market orders were made in
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

unWatchPositions

unWatches from the stream channel

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

Param	Type	Required	Description
symbols	`Array<string>`	No	list of unified market symbols to watch positions for
params	`object`	Yes	extra parameters specific to the exchange API endpoint

Supported exchanges

unWatchTicker

unWatches a price ticker

Kind: instance
Returns: object - a ticker structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

unWatchTrades

unsubscribe from the trades channel

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market trades were made in
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

unWatchTradesForSymbols

unsubscribe from the trades channel

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch trades for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

upgradeUnifiedTradeAccount

upgrades the account to unified trade account warning this is irreversible

Kind: instance
Returns: any - nothing

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

bybit

verifyGiftCode

verify gift code

Kind: instance
Returns: object - response from the exchange

Param	Type	Required	Description
id	`string`	Yes	reference number id
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

binance

watchBalance

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

Kind: instance
Returns: object - a balance structure

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.type	`str`	No	spot or contract if not provided this.options['defaultType'] is used

Supported exchanges

watchBidsAsks

watches best bid & ask for symbols

Kind: instance
Returns: object - a ticker structure

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

watchFundingRate

watch the current funding rate

Kind: instance
Returns: object - a funding rate structure

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

watchFundingRates

watch the funding rate for multiple markets

Kind: instance
Returns: object - a dictionary of funding rate structures, indexed by market symbols

Param	Type	Required	Description
symbols	`Array<string>`	Yes	a list of unified market symbols
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

bitmart
okx

watchLiquidations

watch the public liquidations of a trading pair

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

Param	Type	Required	Description
symbol	`string`	Yes	unified CCXT market symbol
since	`int`	No	the earliest time in ms to fetch liquidations for
limit	`int`	No	the maximum number of liquidation structures to retrieve
params	`object`	No	exchange specific parameters for the bitmex api endpoint

Supported exchanges

watchLiquidationsForSymbols

watch the public liquidations of a trading pair

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	list of unified market symbols
since	`int`	No	the earliest time in ms to fetch liquidations for
limit	`int`	No	the maximum number of liquidation structures to retrieve
params	`object`	No	exchange specific parameters for the bitmex api endpoint

Supported exchanges

watchMarkPrice

watches a mark price for a specific market

Kind: instance
Returns: object - a ticker structure

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.use1sFreq	`boolean`	No	default is true if set to true, the mark price will be updated every second, otherwise every 3 seconds

Supported exchanges

watchMarkPrices

watches the mark price for all markets

Kind: instance
Returns: object - a ticker structure

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint
params.use1sFreq	`boolean`	No	default is true if set to true, the mark price will be updated every second, otherwise every 3 seconds

Supported exchanges

watchMyLiquidations

watch the private liquidations of a trading pair

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

Param	Type	Required	Description
symbol	`string`	Yes	unified CCXT market symbol
since	`int`	No	the earliest time in ms to fetch liquidations for
limit	`int`	No	the maximum number of liquidation structures to retrieve
params	`object`	No	exchange specific parameters for the bitmex api endpoint

Supported exchanges

binance
gate

watchMyLiquidationsForSymbols

watch the private liquidations of a trading pair

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	list of unified market symbols
since	`int`	No	the earliest time in ms to fetch liquidations for
limit	`int`	No	the maximum number of liquidation structures to retrieve
params	`object`	No	exchange specific parameters for the bitmex api endpoint

Supported exchanges

watchMyTrades

watches information on multiple trades made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market trades were made in
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trade structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.unifiedMargin	`boolean`	No	use unified margin account

Supported exchanges

watchMyTradesForSymbols

watches information on multiple trades made by the user

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch trades for
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trade structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

coinbaseexchange

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch OHLCV data for
timeframe	`string`	Yes	the length of time each candle represents
since	`int`	No	timestamp in ms of the earliest candle to fetch
limit	`int`	No	the maximum amount of candles to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbolsAndTimeframes	`Array<Array<string>>`	Yes	array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example 'BTC/USDT', '1m'], ['LTC/USDT', '5m'
since	`int`	No	timestamp in ms of the earliest candle to fetch
limit	`int`	No	the maximum amount of candles to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

watchOrderBook

watches 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 indexed by market symbols

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the order book for
limit	`int`	No	the maximum amount of order book entries to return.
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

watchOrderBookForSymbols

watches 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 indexed by market symbols

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified array of symbols
limit	`int`	No	the maximum amount of order book entries to return.
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

watchOrders

watches information on multiple orders made by the user

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

watchOrdersForSymbols

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

Kind: instance
Returns: Array<object> - a list of [order structures]{@link https://docs.ccxt.com/?id=order-structure

Param	Type	Required	Description
symbols	`Array<string>`	Yes
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.trigger	`boolean`	No	set to true for trigger orders

Supported exchanges

watchPosition

watch open positions for a specific symbol

Kind: instance
Returns: object - a position structure

Param	Type	Description
symbol	`string`, `undefined`	unified market symbol
params	`object`	extra 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

Param	Type	Required	Description
symbols	`Array<string>`	No	list of unified market symbols
since	`int`	No	the earliest time in ms to fetch positions for
limit	`int`	No	the maximum number of positions to retrieve
params	`object`	Yes	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

watchTrades

watches information on multiple trades made in a market

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

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market trades were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of trade structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

watchTradesForSymbols

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

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

Param	Type	Required	Description
symbols	`Array<string>`	Yes	unified symbol of the market to fetch trades for
since	`int`	No	timestamp in ms of the earliest trade to fetch
limit	`int`	No	the maximum amount of trades to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint

Supported exchanges

withdraw

make a withdrawal

Kind: instance
Returns: object - a transaction structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
amount	`float`	Yes	the amount to withdraw
address	`string`	Yes	the address to withdraw to
tag	`string`	Yes
params	`object`	No	extra parameters specific to the exchange API endpoint
params.account	`Account`	No	account id to use, required

Supported exchanges

withdrawWs

make a withdrawal

Kind: instance
Returns: object - a transaction structure

Param	Type	Required	Description
code	`string`	Yes	unified currency code
amount	`float`	Yes	the amount to withdraw
address	`string`	Yes	the address to withdraw to
tag	`string`	Yes
params	`object`	No	extra parameters specific to the bitvavo api endpoint

Supported exchanges

bitvavo

(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)

Install
Examples
Manual
CCXT Pro
Contributing
Supported Exchanges
Exchanges By Country
API Spec By Method
FAQ
Changelog
Awesome
API Spec by Exchange
- fetchCurrencies
- alpaca
- apex
- arkham
- ascendex
- aster
- backpack
- bigone
- binance
- bingx
- bit2c
- bitbank
- bitbns
- bitfinex
- bitflyer
- bitget
- bithumb
- bitmart
- bitmex
- bitopro
- bitrue
- bitso
- bitstamp
- bitteam
- bittrade
- bitvavo
- blockchaincom
- blofin
- btcbox
- btcmarkets
- btcturk
- bullish
- bybit
- bydfi
- cex
- coinbase
- coinbaseexchange
- coinbaseinternational
- coincheck
- coinex
- coinmate
- coinmetro
- coinone
- coinsph
- coinspot
- cryptocom
- cryptomus
- deepcoin
- delta
- deribit
- derive
- digifinex
- dydx
- exmo
- foxbit
- gate
- gemini
- grvt
- hashkey
- hibachi
- hitbtc
- hollaex
- htx
- hyperliquid
- independentreserve
- indodax
- kraken
- krakenfutures
- kucoin
- fetchBidsAsks
- latoken
- lbank
- lighter
- luno
- mercado
- mexc
- modetrade
- ndax
- novadax
- okx
- onetrading
- oxfun
- p2b
- pacifica
- paradex
- paymium
- phemex
- poloniex
- tokocrypto
- toobit
- upbit
- wavesexchange
- weex
- whitebit
- woo
- woofipro
- xt
- yobit
- zaif
- fetchStatus

Uh oh!

baseSpec

addMargin

Supported exchanges

borrowCrossMargin

Supported exchanges

borrowIsolatedMargin

Supported exchanges

calculatePricePrecision

Supported exchanges

cancelAllContractOrders

Supported exchanges

cancelAllOrders

Supported exchanges

cancelAllOrdersAfter

Supported exchanges

cancelAllOrdersWs

Supported exchanges

cancelAllSpotOrders

Supported exchanges

cancelAllUtaOrders

Supported exchanges

cancelContractOrder

Supported exchanges

cancelOrder

Supported exchanges

cancelOrderWs

Supported exchanges

cancelOrders

Supported exchanges

cancelOrdersForSymbols

Supported exchanges

cancelOrdersRequest

Supported exchanges

cancelOrdersWs

Supported exchanges

cancelSpotOrder

Supported exchanges

cancelTwapOrder

Supported exchanges

cancelUtaOrder

Supported exchanges

closeAllPositions

Supported exchanges

closePosition

Supported exchanges

closePositions

Supported exchanges

createAccount

Supported exchanges

createContractOrder

Supported exchanges

createContractOrders

Supported exchanges

createConvertTrade

Supported exchanges

createDepositAddress

Supported exchanges

createGiftCode

Supported exchanges

createMarkeSellOrderWithCost

Supported exchanges

createMarketBuyOrderWithCost

Supported exchanges

createMarketOrderWithCost

Supported exchanges

createMarketSellOrderWithCost

Supported exchanges

createOrder

Supported exchanges

createOrderWs

Supported exchanges

createOrders

Supported exchanges

createOrdersRequest

Supported exchanges

createOrdersWs

Supported exchanges

createSpotOrder

Supported exchanges