ContextQMD
Back to Ccxt

Gate

wiki/exchanges/gate.md

4.5.5296.5 KB
Original Source

<a name="gate" id="gate"></a>

gate{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="loadUnifiedStatus" id="loadunifiedstatus"></a>

loadUnifiedStatus{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>boolean</code> - true or false if the enabled unified account is enabled or not and sets the unifiedAccount option if it is undefined

See: https://www.gate.com/docs/developers/apiv4/#retrieve-user-account-information

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.loadUnifiedStatus ([params])

<a name="fetchTime" id="fetchtime"></a>

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of <code>gate</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server

See: https://www.gate.com/docs/developers/apiv4/#get-server-current-time

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchTime ([params])

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for gate

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

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchMarkets ([params])

<a name="fetchCurrencies" id="fetchcurrencies"></a>

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an associative dictionary of currencies

See: https://www.gate.com/docs/developers/apiv4/en/#query-all-currency-information

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchCurrencies ([params])

<a name="fetchFundingRate" id="fetchfundingrate"></a>

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a funding rate structure

See: https://www.gate.com/docs/developers/apiv4/en/#query-single-contract-information

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchFundingRate (symbol[, params])

<a name="fetchFundingRates" id="fetchfundingrates"></a>

fetchFundingRates{docsify-ignore}

fetch the funding rate for multiple markets

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of funding rate structures, indexed by market symbols

See: https://www.gate.com/docs/developers/apiv4/en/#query-all-futures-contracts

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yeslist of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchFundingRates (symbols[, params])

<a name="fetchDepositAddressesByNetwork" id="fetchdepositaddressesbynetwork"></a>

fetchDepositAddressesByNetwork{docsify-ignore}

fetch a dictionary of addresses for a currency, indexed by network

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a dictionary of address structures indexed by the network

See: https://www.gate.com/docs/developers/apiv4/en/#generate-currency-deposit-address

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency for the deposit address
params<code>object</code>Noextra parameters specific to the api endpoint
javascript
gate.fetchDepositAddressesByNetwork (code[, params])

<a name="fetchDepositAddress" id="fetchdepositaddress"></a>

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an address structure

See: https://www.gate.com/docs/developers/apiv4/en/#generate-currency-deposit-address

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.network<code>string</code>Nounified network code (not used directly by gate.com but used by ccxt to filter the response)
javascript
gate.fetchDepositAddress (code[, params])

<a name="fetchTradingFee" id="fetchtradingfee"></a>

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a fee structure

See: https://www.gate.com/docs/developers/apiv4/en/#query-personal-trading-fees

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchTradingFee (symbol[, params])

<a name="fetchTradingFees" id="fetchtradingfees"></a>

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a dictionary of fee structures indexed by market symbols

See: https://www.gate.com/docs/developers/apiv4/en/#query-personal-trading-fees

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchTradingFees ([params])

<a name="fetchTransactionFees" id="fetchtransactionfees"></a>

fetchTransactionFees{docsify-ignore}

DEPRECATED

please use fetchDepositWithdrawFees instead

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a list of fee structures

See: https://www.gate.com/docs/developers/apiv4/en/#query-withdrawal-status

ParamTypeRequiredDescription
codes<code>Array<string></code>, <code>undefined</code>Yeslist of unified currency codes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchTransactionFees (codes[, params])

<a name="fetchDepositWithdrawFees" id="fetchdepositwithdrawfees"></a>

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a list of fee structures

See: https://www.gate.com/docs/developers/apiv4/en/#query-withdrawal-status

ParamTypeRequiredDescription
codes<code>Array<string></code>, <code>undefined</code>Yeslist of unified currency codes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchDepositWithdrawFees (codes[, params])

<a name="fetchFundingHistory" id="fetchfundinghistory"></a>

fetchFundingHistory{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a funding history structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch funding history for
limit<code>int</code>Nothe maximum number of funding history structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchFundingHistory (symbol[, since, limit, params])

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchOrderBook (symbol[, limit, params])

<a name="fetchTicker" id="fetchticker"></a>

fetchTicker{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchTicker (symbol[, params])

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a dictionary of ticker structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesunified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchTickers (symbols[, params])

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a balance structure

See

ParamTypeRequiredDescription
params<code>object</code>Noexchange specific parameters
params.type<code>string</code>Nospot, margin, swap or future, if not provided this.options['defaultType'] is used
params.settle<code>string</code>No'btc' or 'usdt' - settle currency for perpetual swap and future - default="usdt" for swap and "btc" for future
params.marginMode<code>string</code>No'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.symbol<code>string</code>Nomargin only - unified ccxt symbol
params.unifiedAccount<code>boolean</code>Nodefault false, set to true for fetching the unified account balance
javascript
gate.fetchBalance ([params])

<a name="fetchFundingRateHistory" id="fetchfundingratehistory"></a>

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

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

See: https://www.gate.com/docs/developers/apiv4/en/#get-all-futures-trading-statistics

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the funding rate history for
since<code>int</code>Notimestamp in ms of the earliest funding rate to fetch
limit<code>int</code>Nothe maximum amount of funding rate structures to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest funding rate to fetch
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
javascript
gate.fetchFundingRateHistory (symbol[, since, limit, params])

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>gate</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest trade to fetch
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
gate.fetchTrades (symbol[, since, limit, params])

<a name="fetchOrderTrades" id="fetchordertrades"></a>

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchOrderTrades (id, symbol[, since, limit, params])

<a name="fetchMyTrades" id="fetchmytrades"></a>

fetchMyTrades{docsify-ignore}

Fetch personal trading history

Kind: instance method of <code>gate</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>string</code>No'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.type<code>string</code>No'spot', 'swap', or 'future', if not provided this.options['defaultMarginMode'] is used
params.until<code>int</code>NoThe latest timestamp, in ms, that fetched trades were made
params.page<code>int</code>Nospot only Page number
params.order_id<code>string</code>Nospot only Filter trades with specified order ID. symbol is also required if this field is present
params.order<code>string</code>Nocontract only Futures order ID, return related data only if specified
params.offset<code>int</code>Nocontract only list offset, starting from 0
params.last_id<code>string</code>Nocontract only specify list staring point using the id of last record in previous list-query results
params.count_total<code>int</code>Nocontract only whether to return total number matched, default to 0(no return)
params.unifiedAccount<code>bool</code>Noset to true for fetching trades in a unified account
params.paginate<code>bool</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
javascript
gate.fetchMyTrades (symbol[, since, limit, params])

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://www.gate.com/docs/developers/apiv4/en/#get-deposit-records

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Noend time in ms
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
gate.fetchDeposits (code[, since, limit, params])

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://www.gate.com/docs/developers/apiv4/en/#get-withdrawal-records

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Noend time in ms
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
gate.fetchWithdrawals (code[, since, limit, params])

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a transaction structure

See: https://www.gate.com/docs/developers/apiv4/en/#withdraw

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.withdraw (code, amount, address, tag[, params])

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

Create an order on the exchange

Kind: instance method of <code>gate</code>
Returns: <code>object</code> | <code>undefined</code> - An order structure

See

ParamTypeRequiredDescription
symbol<code>string</code>YesUnified CCXT market symbol
type<code>string</code>Yes'limit' or 'market' "market" is contract only
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yesthe amount of currency to trade
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.triggerPrice<code>float</code>NoThe price at which a trigger order is triggered at
params.timeInForce<code>string</code>No"GTC", "IOC", or "PO"
params.stopLossPrice<code>float</code>NoThe price at which a stop loss order is triggered at
params.takeProfitPrice<code>float</code>NoThe price at which a take profit order is triggered at
params.marginMode<code>string</code>No'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.iceberg<code>int</code>NoAmount to display for the iceberg order, Null or 0 for normal orders, Set to -1 to hide the order completely
params.text<code>string</code>NoUser defined information
params.account<code>string</code>Nospot and margin only "spot", "margin" or "cross_margin"
params.auto_borrow<code>bool</code>Nomargin only Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough
params.settle<code>string</code>Nocontract only Unified Currency Code for settle currency
params.reduceOnly<code>bool</code>Nocontract only Indicates if this order is to reduce the size of a position
params.close<code>bool</code>Nocontract only Set as true to close the position, with size set to 0
params.auto_size<code>bool</code>Nocontract only Set side to close dual-mode position, close_long closes the long side, while close_short the short one, size also needs to be set to 0
params.price_type<code>int</code>Nocontract only 0 latest deal price, 1 mark price, 2 index price
params.cost<code>float</code>Nospot market buy only the quote quantity that can be used as an alternative for the amount
params.unifiedAccount<code>bool</code>Noset to true for creating an order in the unified account
params.clientOrderId<code>string</code>Nothe clientOrderId of the order
javascript
gate.createOrder (symbol, type, side, amount[, price, params])

<a name="createOrders" id="createorders"></a>

createOrders{docsify-ignore}

create a list of trade orders

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
orders<code>Array</code>Yeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.createOrders (orders[, params])

<a name="createMarketBuyOrderWithCost" id="createmarketbuyorderwithcost"></a>

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an order structure

See: https://www.gate.com/docs/developers/apiv4/en/#create-an-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
cost<code>float</code>Yeshow much you want to trade in units of the quote currency
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.unifiedAccount<code>bool</code>Noset to true for creating a unified account order
javascript
gate.createMarketBuyOrderWithCost (symbol, cost[, params])

<a name="editOrder" id="editorder"></a>

editOrder{docsify-ignore}

edit a trade order, gate currently only supports the modification of the price or amount fields

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of the currency you want to trade in units of the base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.unifiedAccount<code>bool</code>Noset to true for editing an order in a unified account
javascript
gate.editOrder (id, symbol, type, side, amount[, price, params])

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

Retrieves information on an order

Kind: instance method of <code>gate</code>
Returns: An order structure

See

ParamTypeRequiredDescription
id<code>string</code>YesOrder id
symbol<code>string</code>YesUnified market symbol, required for spot and margin
params<code>object</code>NoParameters specified by the exchange api
params.trigger<code>bool</code>NoTrue if the order being fetched is a trigger order
params.marginMode<code>string</code>No'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.type<code>string</code>No'spot', 'swap', or 'future', if not provided this.options['defaultMarginMode'] is used
params.settle<code>string</code>No'btc' or 'usdt' - settle currency for perpetual swap and future - market settle currency is used if symbol !== undefined, default="usdt" for swap and "btc" for future
params.unifiedAccount<code>bool</code>Noset to true for fetching a unified account order
javascript
gate.fetchOrder (id, symbol[, params])

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>gate</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://www.gate.com/docs/developers/apiv4/en/#list-all-open-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open orders structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>bool</code>Notrue for fetching trigger orders
params.type<code>string</code>Nospot, margin, swap or future, if not provided this.options['defaultType'] is used
params.marginMode<code>string</code>No'cross' or 'isolated' - marginMode for type='margin', if not provided this.options['defaultMarginMode'] is used
params.unifiedAccount<code>bool</code>Noset to true for fetching unified account orders
javascript
gate.fetchOpenOrders (symbol[, since, limit, params])

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of <code>gate</code>
Returns: <code>Array<Order></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.trigger<code>bool</code>Notrue for fetching trigger orders
params.type<code>string</code>Nospot, swap or future, if not provided this.options['defaultType'] is used
params.marginMode<code>string</code>No'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.historical<code>boolean</code>Noswap only true for using historical endpoint
params.unifiedAccount<code>bool</code>Noset to true for fetching unified account orders
javascript
gate.fetchClosedOrders (symbol[, since, limit, params])

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

Cancels an open order

Kind: instance method of <code>gate</code>
Returns: An order structure

See

ParamTypeRequiredDescription
id<code>string</code>YesOrder id
symbol<code>string</code>YesUnified market symbol
params<code>object</code>NoParameters specified by the exchange api
params.trigger<code>bool</code>NoTrue if the order to be cancelled is a trigger order
params.unifiedAccount<code>bool</code>Noset to true for canceling unified account orders
javascript
gate.cancelOrder (id, symbol[, params])

<a name="cancelOrders" id="cancelorders"></a>

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an list of order structures

See

ParamTypeRequiredDescription
ids<code>Array<string></code>Yesorder ids
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.unifiedAccount<code>bool</code>Noset to true for canceling unified account orders
javascript
gate.cancelOrders (ids, symbol[, params])

<a name="cancelOrdersForSymbols" id="cancelordersforsymbols"></a>

cancelOrdersForSymbols{docsify-ignore}

cancel multiple orders for multiple symbols

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an list of order structures

See: https://www.gate.com/en-eu/docs/developers/apiv4/#cancel-a-batch-of-orders-with-an-id-list

ParamTypeRequiredDescription
orders<code>Array<CancellationRequest></code>Yeslist of order ids with symbol, example [{"id": "a", "symbol": "BTC/USDT"}, {"id": "b", "symbol": "ETH/USDT"}]
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.clientOrderIds<code>Array<string></code>Noclient order ids
params.unifiedAccount<code>bool</code>Noset to true for canceling unified account orders
javascript
gate.cancelOrdersForSymbols (orders[, params])

<a name="cancelAllOrders" id="cancelallorders"></a>

cancelAllOrders{docsify-ignore}

cancel all open orders

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.unifiedAccount<code>bool</code>Noset to true for canceling unified account orders
javascript
gate.cancelAllOrders (symbol[, params])

<a name="transfer" id="transfer"></a>

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of <code>gate</code>
Returns: A transfer structure

See: https://www.gate.com/docs/developers/apiv4/en/#transfer-between-trading-accounts

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code for currency being transferred
amount<code>float</code>Yesthe amount of currency to transfer
fromAccount<code>string</code>Yesthe account to transfer currency from
toAccount<code>string</code>Yesthe account to transfer currency to
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.symbol<code>string</code>NoUnified market symbol required for type == margin
javascript
gate.transfer (code, amount, fromAccount, toAccount[, params])

<a name="setLeverage" id="setleverage"></a>

setLeverage{docsify-ignore}

set the level of leverage for a market

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - response from the exchange

See

ParamTypeRequiredDescription
leverage<code>float</code>Yesthe rate of leverage
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.setLeverage (leverage, symbol[, params])

<a name="fetchPosition" id="fetchposition"></a>

fetchPosition{docsify-ignore}

fetch data on an open contract position

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a position structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market the position is held in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchPosition (symbol[, params])

<a name="fetchPositions" id="fetchpositions"></a>

fetchPositions{docsify-ignore}

fetch all open positions

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of position structure

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>YesNot used by gate, but parsed internally by CCXT
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.settle<code>string</code>No'btc' or 'usdt' - settle currency for perpetual swap and future - default="usdt" for swap and "btc" for future
params.type<code>string</code>Noswap, future or option, if not provided this.options['defaultType'] is used
javascript
gate.fetchPositions (symbols[, params])

<a name="fetchLeverageTiers" id="fetchleveragetiers"></a>

fetchLeverageTiers{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a dictionary of leverage tiers structures, indexed by market symbols

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nolist of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchLeverageTiers ([symbols, params])

<a name="fetchMarketLeverageTiers" id="fetchmarketleveragetiers"></a>

fetchMarketLeverageTiers{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a leverage tiers structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchMarketLeverageTiers (symbol[, params])

<a name="repayIsolatedMargin" id="repayisolatedmargin"></a>

repayIsolatedMargin{docsify-ignore}

repay borrowed margin and interest

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a margin loan structure

See: https://www.gate.com/docs/developers/apiv4/en/#borrow-or-repay-2

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
code<code>string</code>Yesunified currency code of the currency to repay
amount<code>float</code>Yesthe amount to repay
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.mode<code>string</code>No'all' or 'partial' payment mode, extra parameter required for isolated margin
params.id<code>string</code>No'34267567' loan id, extra parameter required for isolated margin
javascript
gate.repayIsolatedMargin (symbol, code, amount[, params])

<a name="repayCrossMargin" id="repaycrossmargin"></a>

repayCrossMargin{docsify-ignore}

repay cross margin borrowed margin and interest

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a margin loan structure

See: https://www.gate.com/docs/developers/apiv4/en/#borrow-or-repay

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency to repay
amount<code>float</code>Yesthe amount to repay
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.mode<code>string</code>No'all' or 'partial' payment mode, extra parameter required for isolated margin
params.id<code>string</code>No'34267567' loan id, extra parameter required for isolated margin
params.unifiedAccount<code>boolean</code>Noset to true for repaying in the unified account
javascript
gate.repayCrossMargin (code, amount[, params])

<a name="borrowIsolatedMargin" id="borrowisolatedmargin"></a>

borrowIsolatedMargin{docsify-ignore}

create a loan to borrow margin

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a margin loan structure

See: https://www.gate.com/docs/developers/apiv4/en/#borrow-or-repay-2

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol, required for isolated margin
code<code>string</code>Yesunified currency code of the currency to borrow
amount<code>float</code>Yesthe amount to borrow
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.rate<code>string</code>No'0.0002' or '0.002' extra parameter required for isolated margin
javascript
gate.borrowIsolatedMargin (symbol, code, amount[, params])

<a name="borrowCrossMargin" id="borrowcrossmargin"></a>

borrowCrossMargin{docsify-ignore}

create a loan to borrow margin

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a margin loan structure

See: https://www.gate.com/docs/developers/apiv4/en/#borrow-or-repay

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency to borrow
amount<code>float</code>Yesthe amount to borrow
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.rate<code>string</code>No'0.0002' or '0.002' extra parameter required for isolated margin
params.unifiedAccount<code>boolean</code>Nodefault true (set to false to use deprecated privateMarginPostCrossLoans method)
javascript
gate.borrowCrossMargin (code, amount[, params])

<a name="fetchBorrowInterest" id="fetchborrowinterest"></a>

fetchBorrowInterest{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of borrow interest structures

See

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code
symbol<code>string</code>Nounified market symbol when fetching interest in isolated markets
since<code>int</code>Nothe earliest time in ms to fetch borrow interest for
limit<code>int</code>Nothe maximum number of structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.unifiedAccount<code>boolean</code>Noset to true for fetching borrow interest in the unified account
javascript
gate.fetchBorrowInterest ([code, symbol, since, limit, params])

<a name="reduceMargin" id="reducemargin"></a>

reduceMargin{docsify-ignore}

remove margin from a position

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a margin structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
amount<code>float</code>Yesthe amount of margin to remove
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.reduceMargin (symbol, amount[, params])

<a name="addMargin" id="addmargin"></a>

addMargin{docsify-ignore}

add margin

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a margin structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
amount<code>float</code>Yesamount of margin to add
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.addMargin (symbol, amount[, params])

<a name="fetchOpenInterest" id="fetchopeninterest"></a>

fetchOpenInterest{docsify-ignore}

Retrieves the open interest of a currency

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an open interest structurehttps://docs.ccxt.com/?id=open-interest-structure

See: https://www.gate.com/docs/developers/apiv4/en/#futures-statistics

ParamTypeRequiredDescription
symbol<code>string</code>YesUnified CCXT market symbol
timeframe<code>string</code>Yes"5m", "15m", "30m", "1h", "4h", "1d"
since<code>int</code>Nothe time(ms) of the earliest record to retrieve as a unix timestamp
limit<code>int</code>Nodefault 30
params<code>object</code>Noexchange specific parameters
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
gate.fetchOpenInterest (symbol, timeframe[, since, limit, params])

<a name="fetchSettlementHistory" id="fetchsettlementhistory"></a>

fetchSettlementHistory{docsify-ignore}

fetches historical settlement records

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of settlement history objects

See: https://www.gate.com/docs/developers/apiv4/en/#list-settlement-history

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the settlement history, required on gate
since<code>int</code>Notimestamp in ms
limit<code>int</code>Nonumber of records
params<code>object</code>Noexchange specific params
javascript
gate.fetchSettlementHistory (symbol[, since, limit, params])

<a name="fetchMySettlementHistory" id="fetchmysettlementhistory"></a>

fetchMySettlementHistory{docsify-ignore}

fetches historical settlement records of the user

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

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the settlement history
since<code>int</code>Notimestamp in ms
limit<code>int</code>Nonumber of records
params<code>object</code>Noexchange specific params
javascript
gate.fetchMySettlementHistory (symbol[, since, limit, params])

<a name="fetchLedger" id="fetchledger"></a>

fetchLedger{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a ledger structure

See

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code
since<code>int</code>Notimestamp in ms of the earliest ledger entry
limit<code>int</code>Nomax number of ledger entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Noend time in ms
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters
javascript
gate.fetchLedger ([code, since, limit, params])

<a name="setPositionMode" id="setpositionmode"></a>

setPositionMode{docsify-ignore}

set dual/hedged mode to true or false for a swap market, make sure all positions are closed and no orders are open before setting dual mode

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - response from the exchange

See: https://www.gate.com/docs/developers/apiv4/en/#set-position-mode

ParamTypeDescription
hedged<code>bool</code>set to true to enable dual mode
symbol<code>string</code>, <code>undefined</code>if passed, dual mode is set for all markets with the same settle currency
params<code>object</code>extra parameters specific to the exchange API endpoint
params.settle<code>string</code>settle currency
javascript
gate.setPositionMode (hedged, symbol, params[])

<a name="fetchUnderlyingAssets" id="fetchunderlyingassets"></a>

fetchUnderlyingAssets{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of underlying assets

See: https://www.gate.com/docs/developers/apiv4/en/#list-all-underlying-assets

ParamTypeRequiredDescription
params<code>object</code>Noexchange specific params
params.type<code>string</code>Nothe contract market type, 'option', 'swap' or 'future', the default is 'option'
javascript
gate.fetchUnderlyingAssets ([params])

<a name="fetchLiquidations" id="fetchliquidations"></a>

fetchLiquidations{docsify-ignore}

retrieves the public liquidations of a trading pair

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an array of liquidation structures

See: https://www.gate.com/docs/developers/apiv4/en/#query-liquidation-order-history

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified CCXT market symbol
since<code>int</code>Nothe earliest time in ms to fetch liquidations for
limit<code>int</code>Nothe maximum number of liquidation structures to retrieve
params<code>object</code>Noexchange specific parameters for the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest liquidation
javascript
gate.fetchLiquidations (symbol[, since, limit, params])

<a name="fetchMyLiquidations" id="fetchmyliquidations"></a>

fetchMyLiquidations{docsify-ignore}

retrieves the users liquidated positions

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an array of liquidation structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified CCXT market symbol
since<code>int</code>Nothe earliest time in ms to fetch liquidations for
limit<code>int</code>Nothe maximum number of liquidation structures to retrieve
params<code>object</code>Noexchange specific parameters for the exchange API endpoint
javascript
gate.fetchMyLiquidations (symbol[, since, limit, params])

<a name="fetchGreeks" id="fetchgreeks"></a>

fetchGreeks{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a greeks structure

See: https://www.gate.com/docs/developers/apiv4/en/#query-options-market-ticker-information

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch greeks for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchGreeks (symbol[, params])

<a name="closePosition" id="closeposition"></a>

closePosition{docsify-ignore}

closes open positions for a market

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - A list of position structures

See

ParamTypeRequiredDescription
symbol<code>string</code>YesUnified CCXT market symbol
side<code>string</code>Yes'buy' or 'sell'
params<code>object</code>Noextra parameters specific to the okx api endpoint
javascript
gate.closePosition (symbol, side[, params])

<a name="fetchLeverage" id="fetchleverage"></a>

fetchLeverage{docsify-ignore}

fetch the set leverage for a market

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a leverage structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.unified<code>boolean</code>Nodefault false, set to true for fetching the unified accounts leverage
javascript
gate.fetchLeverage (symbol[, params])

<a name="fetchLeverages" id="fetchleverages"></a>

fetchLeverages{docsify-ignore}

fetch the set leverage for all leverage markets, only spot margin is supported on gate

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a list of leverage structures

See: https://www.gate.com/docs/developers/apiv4/en/#list-lending-markets

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesa list of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.unified<code>boolean</code>Nodefault false, set to true for fetching unified account leverages
javascript
gate.fetchLeverages (symbols[, params])

<a name="fetchOption" id="fetchoption"></a>

fetchOption{docsify-ignore}

fetches option data that is commonly found in an option chain

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an option chain structure

See: https://www.gate.com/docs/developers/apiv4/en/#query-specified-contract-details

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchOption (symbol[, params])

<a name="fetchOptionChain" id="fetchoptionchain"></a>

fetchOptionChain{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a list of option chain structures

See: https://www.gate.com/docs/developers/apiv4/en/#list-all-contracts-for-specified-underlying-and-expiration-date

ParamTypeRequiredDescription
code<code>string</code>Yesbase currency to fetch an option chain for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.underlying<code>string</code>Nothe underlying asset, can be obtained from fetchUnderlyingAssets ()
params.expiration<code>int</code>Nounix timestamp of the expiration time
javascript
gate.fetchOptionChain (code[, params])

<a name="fetchPositionsHistory" id="fetchpositionshistory"></a>

fetchPositionsHistory{docsify-ignore}

fetches historical positions

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of position structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified conract symbols, must all have the same settle currency and the same market type
since<code>int</code>Nothe earliest time in ms to fetch positions for
limit<code>int</code>Nothe maximum amount of records to fetch, default=1000
params<code>object</code>Yesextra parameters specific to the exchange api endpoint
params.until<code>int</code>Nothe latest time in ms to fetch positions for EXCHANGE SPECIFIC PARAMETERS
params.offset<code>int</code>Nolist offset, starting from 0
params.side<code>string</code>Nolong or short
params.pnl<code>string</code>Noquery profit or loss
javascript
gate.fetchPositionsHistory (symbols[, since, limit, params])

<a name="createOrderWs" id="createorderws"></a>

createOrderWs{docsify-ignore}

Create an order on the exchange

Kind: instance method of <code>gate</code>
Returns: <code>object</code> | <code>undefined</code> - An order structure

See

ParamTypeRequiredDescription
symbol<code>string</code>YesUnified CCXT market symbol
type<code>string</code>Yes'limit' or 'market' "market" is contract only
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yesthe amount of currency to trade
price<code>float</code>Noignored in "market" orders the price at which the order is to be fulfilled at in units of the quote currency
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.stopPrice<code>float</code>NoThe price at which a trigger order is triggered at
params.timeInForce<code>string</code>No"GTC", "IOC", or "PO"
params.stopLossPrice<code>float</code>NoThe price at which a stop loss order is triggered at
params.takeProfitPrice<code>float</code>NoThe price at which a take profit order is triggered at
params.marginMode<code>string</code>No'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.iceberg<code>int</code>NoAmount to display for the iceberg order, Null or 0 for normal orders, Set to -1 to hide the order completely
params.text<code>string</code>NoUser defined information
params.account<code>string</code>Nospot and margin only "spot", "margin" or "cross_margin"
params.auto_borrow<code>bool</code>Nomargin only Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough
params.settle<code>string</code>Nocontract only Unified Currency Code for settle currency
params.reduceOnly<code>bool</code>Nocontract only Indicates if this order is to reduce the size of a position
params.close<code>bool</code>Nocontract only Set as true to close the position, with size set to 0
params.auto_size<code>bool</code>Nocontract only Set side to close dual-mode position, close_long closes the long side, while close_short the short one, size also needs to be set to 0
params.price_type<code>int</code>Nocontract only 0 latest deal price, 1 mark price, 2 index price
params.cost<code>float</code>Nospot market buy only the quote quantity that can be used as an alternative for the amount
javascript
gate.createOrderWs (symbol, type, side, amount[, price, params])

<a name="createOrdersWs" id="createordersws"></a>

createOrdersWs{docsify-ignore}

create a list of trade orders

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an order structure

See: https://www.gate.io/docs/developers/futures/ws/en/#order-batch-place

ParamTypeRequiredDescription
orders<code>Array</code>Yeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.createOrdersWs (orders[, params])

<a name="cancelAllOrdersWs" id="cancelallordersws"></a>

cancelAllOrdersWs{docsify-ignore}

cancel all open orders

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.channel<code>string</code>Nothe channel to use, defaults to spot.order_cancel_cp or futures.order_cancel_cp
javascript
gate.cancelAllOrdersWs (symbol[, params])

<a name="cancelOrderWs" id="cancelorderws"></a>

cancelOrderWs{docsify-ignore}

Cancels an open order

Kind: instance method of <code>gate</code>
Returns: An order structure

See

ParamTypeRequiredDescription
id<code>string</code>YesOrder id
symbol<code>string</code>YesUnified market symbol
params<code>object</code>NoParameters specified by the exchange api
params.trigger<code>bool</code>NoTrue if the order to be cancelled is a trigger order
javascript
gate.cancelOrderWs (id, symbol[, params])

<a name="editOrderWs" id="editorderws"></a>

editOrderWs{docsify-ignore}

edit a trade order, gate currently only supports the modification of the price or amount fields

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of the currency you want to trade in units of the base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.editOrderWs (id, symbol, type, side, amount[, price, params])

<a name="fetchOrderWs" id="fetchorderws"></a>

fetchOrderWs{docsify-ignore}

Retrieves information on an order

Kind: instance method of <code>gate</code>
Returns: An order structure

See

ParamTypeRequiredDescription
id<code>string</code>YesOrder id
symbol<code>string</code>YesUnified market symbol, required for spot and margin
params<code>object</code>NoParameters specified by the exchange api
params.trigger<code>bool</code>NoTrue if the order being fetched is a trigger order
params.marginMode<code>string</code>No'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.type<code>string</code>No'spot', 'swap', or 'future', if not provided this.options['defaultMarginMode'] is used
params.settle<code>string</code>No'btc' or 'usdt' - settle currency for perpetual swap and future - market settle currency is used if symbol !== undefined, default="usdt" for swap and "btc" for future
javascript
gate.fetchOrderWs (id, symbol[, params])

<a name="fetchOpenOrdersWs" id="fetchopenordersws"></a>

fetchOpenOrdersWs{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>gate</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://www.gate.io/docs/developers/futures/ws/en/#order-list

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open orders structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchOpenOrdersWs (symbol[, since, limit, params])

<a name="fetchClosedOrdersWs" id="fetchclosedordersws"></a>

fetchClosedOrdersWs{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of <code>gate</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://www.gate.io/docs/developers/futures/ws/en/#order-list

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.fetchClosedOrdersWs (symbol[, since, limit, params])

<a name="fetchOrdersWs" id="fetchordersws"></a>

fetchOrdersWs{docsify-ignore}

fetches information on multiple orders made by the user by status

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of order structures

See: https://www.gate.io/docs/developers/futures/ws/en/#order-list

ParamTypeRequiredDescription
status<code>string</code>Yesrequested order status
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>, <code>undefined</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>, <code>undefined</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.orderId<code>int</code>Noorder id to begin at
params.limit<code>int</code>Nothe maximum number of order structures to retrieve
javascript
gate.fetchOrdersWs (status, symbol[, since, limit, params])

<a name="watchOrderBook" id="watchorderbook"></a>

watchOrderBook{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchOrderBook (symbol[, limit, params])

<a name="unWatchOrderBook" id="unwatchorderbook"></a>

unWatchOrderBook{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.unWatchOrderBook (symbol[, params])

<a name="watchTicker" id="watchticker"></a>

watchTicker{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchTicker (symbol[, params])

<a name="watchTickers" id="watchtickers"></a>

watchTickers{docsify-ignore}

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 method of <code>gate</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchTickers (symbols[, params])

<a name="watchBidsAsks" id="watchbidsasks"></a>

watchBidsAsks{docsify-ignore}

watches best bid & ask for symbols

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchBidsAsks (symbols[, params])

<a name="watchTrades" id="watchtrades"></a>

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchTrades (symbol[, since, limit, params])

<a name="watchTradesForSymbols" id="watchtradesforsymbols"></a>

watchTradesForSymbols{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchTradesForSymbols (symbols[, since, limit, params])

<a name="unWatchTradesForSymbols" id="unwatchtradesforsymbols"></a>

unWatchTradesForSymbols{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of trade structures

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch trades for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.unWatchTradesForSymbols (symbols[, params])

<a name="unWatchTrades" id="unwatchtrades"></a>

unWatchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of trade structures

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.unWatchTrades (symbol[, params])

<a name="watchOHLCV" id="watchohlcv"></a>

watchOHLCV{docsify-ignore}

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

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

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchOHLCV (symbol, timeframe[, since, limit, params])

<a name="watchMyTrades" id="watchmytrades"></a>

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market trades were made in
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trade structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchMyTrades (symbol[, since, limit, params])

<a name="watchBalance" id="watchbalance"></a>

watchBalance{docsify-ignore}

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

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - a balance structure

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
gate.watchBalance ([params])

<a name="watchPositions" id="watchpositions"></a>

watchPositions{docsify-ignore}

watch all open positions

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of position structure

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nolist of unified market symbols to watch positions for
since<code>int</code>Nothe earliest time in ms to fetch positions for
limit<code>int</code>Nothe maximum number of positions to retrieve
params<code>object</code>Yesextra parameters specific to the exchange API endpoint
javascript
gate.watchPositions ([symbols, since, limit, params])

<a name="watchOrders" id="watchorders"></a>

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of <code>gate</code>
Returns: <code>Array<object></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.type<code>string</code>Nospot, margin, swap, future, or option. Required if listening to all symbols.
params.isInverse<code>boolean</code>Noif future, listen to inverse or linear contracts
javascript
gate.watchOrders (symbol[, since, limit, params])

<a name="watchMyLiquidations" id="watchmyliquidations"></a>

watchMyLiquidations{docsify-ignore}

watch the public liquidations of a trading pair

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an array of liquidation structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified CCXT market symbol
since<code>int</code>Nothe earliest time in ms to fetch liquidations for
limit<code>int</code>Nothe maximum number of liquidation structures to retrieve
params<code>object</code>Noexchange specific parameters for the bitmex api endpoint
javascript
gate.watchMyLiquidations (symbol[, since, limit, params])

<a name="watchMyLiquidationsForSymbols" id="watchmyliquidationsforsymbols"></a>

watchMyLiquidationsForSymbols{docsify-ignore}

watch the private liquidations of a trading pair

Kind: instance method of <code>gate</code>
Returns: <code>object</code> - an array of liquidation structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified CCXT market symbols
since<code>int</code>Nothe earliest time in ms to fetch liquidations for
limit<code>int</code>Nothe maximum number of liquidation structures to retrieve
params<code>object</code>Noexchange specific parameters for the gate api endpoint
javascript
gate.watchMyLiquidationsForSymbols (symbols[, since, limit, params])