mzoe/ritmex-bot
1
0
Fork 0
mirror of https://github.com/discountry/ritmex-bot.git synced 2026-09-09 16:28:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
624fecfa708ed3469f9a0cc52a6508b109094251
ritmex-bot/docs/ccxt/wiki/exchanges/gate.md
T
discountry fcb83bd16b commit
2025-10-03 15:28:16 +08:00

94 KiB
Raw Blame History

gate{docsify-ignore}

Kind: global class
Extends: Exchange

loadUnifiedStatus{docsify-ignore}

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

Kind: instance method of gate
Returns: boolean - 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.io/docs/developers/apiv4/#get-account-detail

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
gate.loadUnifiedStatus ([params])

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

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

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
gate.fetchTime ([params])

fetchMarkets{docsify-ignore}

retrieves data on all markets for gate

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

See

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
gate.fetchMarkets ([params])

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

See: https://www.gate.io/docs/developers/apiv4/en/#list-all-currencies-details

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
gate.fetchCurrencies ([params])

fetchFundingRate{docsify-ignore}

fetch the current funding rate

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

See: https://www.gate.io/docs/developers/apiv4/en/#get-a-single-contract

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
gate.fetchFundingRate (symbol[, params])

fetchFundingRates{docsify-ignore}

fetch the funding rate for multiple markets

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

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

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 
gate.fetchFundingRates (symbols[, params])

fetchDepositAddressesByNetwork{docsify-ignore}

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

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

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 api endpoint 
gate.fetchDepositAddressesByNetwork (code[, params])

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of gate
Returns: object - an address structure

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

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 unified network code (not used directly by gate.io but used by ccxt to filter the response) 
gate.fetchDepositAddress (code[, params])

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

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

See: https://www.gate.io/docs/developers/apiv4/en/#retrieve-personal-trading-fee

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
gate.fetchTradingFee (symbol[, params])

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

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

See: https://www.gate.io/docs/developers/apiv4/en/#retrieve-personal-trading-fee

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
gate.fetchTradingFees ([params])

fetchTransactionFees{docsify-ignore}

DEPRECATED

please use fetchDepositWithdrawFees instead

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

See: https://www.gate.io/docs/developers/apiv4/en/#retrieve-withdrawal-status

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 
gate.fetchTransactionFees (codes[, params])

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

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

See: https://www.gate.io/docs/developers/apiv4/en/#retrieve-withdrawal-status

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 
gate.fetchDepositWithdrawFees (codes[, params])

fetchFundingHistory{docsify-ignore}

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

Kind: instance method of gate
Returns: object - a funding history structure

See

Param Type Required Description
symbol string Yes unified market symbol
since int No the earliest time in ms to fetch funding history for
limit int No the maximum number of funding history structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
gate.fetchFundingHistory (symbol[, since, limit, params])

fetchOrderBook{docsify-ignore}

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

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

See

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 
gate.fetchOrderBook (symbol[, limit, params])

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

See

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 
gate.fetchTicker (symbol[, params])

fetchTickers{docsify-ignore}

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

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

See

Param Type Required Description
symbols Array<string>, undefined Yes 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 
gate.fetchTickers (symbols[, params])

fetchBalance{docsify-ignore}

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

See

Param Type Required Description
params object No exchange specific parameters
params.type string No spot, margin, swap or future, if not provided this.options['defaultType'] is used
params.settle string No 'btc' or 'usdt' - settle currency for perpetual swap and future - default="usdt" for swap and "btc" for future
params.marginMode string No 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.symbol string No margin only - unified ccxt symbol
params.unifiedAccount boolean No default false, set to true for fetching the unified account balance 
gate.fetchBalance ([params])

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

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

See: https://www.gate.io/docs/developers/apiv4/en/#funding-rate-history

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 to fetch
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 
gate.fetchFundingRateHistory (symbol[, since, limit, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See

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 timestamp in ms of the latest trade to fetch
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 
gate.fetchTrades (symbol[, since, limit, params])

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

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

See

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 
gate.fetchOrderTrades (id, symbol[, since, limit, params])

fetchMyTrades{docsify-ignore}

Fetch personal trading history

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

See

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.marginMode string No 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.type string No 'spot', 'swap', or 'future', if not provided this.options['defaultMarginMode'] is used
params.until int No The latest timestamp, in ms, that fetched trades were made
params.page int No spot only Page number
params.order_id string No spot only Filter trades with specified order ID. symbol is also required if this field is present
params.order string No contract only Futures order ID, return related data only if specified
params.offset int No contract only list offset, starting from 0
params.last_id string No contract only specify list staring point using the id of last record in previous list-query results
params.count_total int No contract only whether to return total number matched, default to 0(no return)
params.unifiedAccount bool No set to true for fetching trades in a unified account
params.paginate bool No default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters 
gate.fetchMyTrades (symbol[, since, limit, params])

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://www.gate.io/docs/developers/apiv4/en/#retrieve-deposit-records

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
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 
gate.fetchDeposits (code[, since, limit, params])

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See: https://www.gate.io/docs/developers/apiv4/en/#retrieve-withdrawal-records

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
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 
gate.fetchWithdrawals (code[, since, limit, params])

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of gate
Returns: object - a transaction structure

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

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 
gate.withdraw (code, amount, address, tag[, params])

createOrder{docsify-ignore}

Create an order on the exchange

Kind: instance method of gate
Returns: object | undefined - An order structure

See

Param Type Required Description
symbol string Yes Unified CCXT market symbol
type string Yes 'limit' or 'market' "market" is contract only
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.triggerPrice float No The price at which a trigger order is triggered at
params.timeInForce string No "GTC", "IOC", or "PO"
params.stopLossPrice float No The price at which a stop loss order is triggered at
params.takeProfitPrice float No The price at which a take profit order is triggered at
params.marginMode string No 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.iceberg int No Amount to display for the iceberg order, Null or 0 for normal orders, Set to -1 to hide the order completely
params.text string No User defined information
params.account string No spot and margin only "spot", "margin" or "cross_margin"
params.auto_borrow bool No margin only Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough
params.settle string No contract only Unified Currency Code for settle currency
params.reduceOnly bool No contract only Indicates if this order is to reduce the size of a position
params.close bool No contract only Set as true to close the position, with size set to 0
params.auto_size bool No contract 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 int No contract only 0 latest deal price, 1 mark price, 2 index price
params.cost float No spot market buy only the quote quantity that can be used as an alternative for the amount
params.unifiedAccount bool No set to true for creating an order in the unified account 
gate.createOrder (symbol, type, side, amount[, price, params])

createOrders{docsify-ignore}

create a list of trade orders

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

See

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 
gate.createOrders (orders[, params])

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

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

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

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
params.unifiedAccount bool No set to true for creating a unified account order 
gate.createMarketBuyOrderWithCost (symbol, cost[, params])

editOrder{docsify-ignore}

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

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

See

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 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.unifiedAccount bool No set to true for editing an order in a unified account 
gate.editOrder (id, symbol, type, side, amount[, price, params])

fetchOrder{docsify-ignore}

Retrieves information on an order

Kind: instance method of gate
Returns: An order structure

See

Param Type Required Description
id string Yes Order id
symbol string Yes Unified market symbol, required for spot and margin
params object No Parameters specified by the exchange api
params.trigger bool No True if the order being fetched is a trigger order
params.marginMode string No 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.type string No 'spot', 'swap', or 'future', if not provided this.options['defaultMarginMode'] is used
params.settle string 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 bool No set to true for fetching a unified account order 
gate.fetchOrder (id, symbol[, params])

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See

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.trigger bool No true for fetching trigger orders
params.type string No spot, margin, swap or future, if not provided this.options['defaultType'] is used
params.marginMode string No 'cross' or 'isolated' - marginMode for type='margin', if not provided this.options['defaultMarginMode'] is used
params.unifiedAccount bool No set to true for fetching unified account orders 
gate.fetchOpenOrders (symbol[, since, limit, params])

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See

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 bool No true for fetching trigger orders
params.type string No spot, swap or future, if not provided this.options['defaultType'] is used
params.marginMode string No 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.historical boolean No swap only true for using historical endpoint
params.unifiedAccount bool No set to true for fetching unified account orders 
gate.fetchClosedOrders (symbol[, since, limit, params])

cancelOrder{docsify-ignore}

Cancels an open order

Kind: instance method of gate
Returns: An order structure

See

Param Type Required Description
id string Yes Order id
symbol string Yes Unified market symbol
params object No Parameters specified by the exchange api
params.trigger bool No True if the order to be cancelled is a trigger order
params.unifiedAccount bool No set to true for canceling unified account orders 
gate.cancelOrder (id, symbol[, params])

cancelOrders{docsify-ignore}

cancel multiple orders

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

See

Param Type Required Description
ids Array<string> Yes order ids
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.unifiedAccount bool No set to true for canceling unified account orders 
gate.cancelOrders (ids, symbol[, params])

cancelOrdersForSymbols{docsify-ignore}

cancel multiple orders for multiple symbols

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

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

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
params.clientOrderIds Array<string> No client order ids
params.unifiedAccount bool No set to true for canceling unified account orders 
gate.cancelOrdersForSymbols (orders[, params])

cancelAllOrders{docsify-ignore}

cancel all open orders

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

See

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.unifiedAccount bool No set to true for canceling unified account orders 
gate.cancelAllOrders (symbol[, params])

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of gate
Returns: A transfer structure

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

Param Type Required Description
code string Yes unified currency code for currency being transferred
amount float Yes the amount of currency to transfer
fromAccount string Yes the account to transfer currency from
toAccount string Yes the account to transfer currency to
params object No extra parameters specific to the exchange API endpoint
params.symbol string No Unified market symbol required for type == margin 
gate.transfer (code, amount, fromAccount, toAccount[, params])

setLeverage{docsify-ignore}

set the level of leverage for a market

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

See

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 
gate.setLeverage (leverage, symbol[, params])

fetchPosition{docsify-ignore}

fetch data on an open contract position

Kind: instance method of gate
Returns: object - a position structure

See

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 
gate.fetchPosition (symbol[, params])

fetchPositions{docsify-ignore}

fetch all open positions

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

See

Param Type Required Description
symbols Array<string>, undefined Yes Not used by gate, but parsed internally by CCXT
params object No extra parameters specific to the exchange API endpoint
params.settle string No 'btc' or 'usdt' - settle currency for perpetual swap and future - default="usdt" for swap and "btc" for future
params.type string No swap, future or option, if not provided this.options['defaultType'] is used 
gate.fetchPositions (symbols[, params])

fetchLeverageTiers{docsify-ignore}

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

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

See

Param Type Required Description
symbols Array<string> No list of unified market symbols
params object No extra parameters specific to the exchange API endpoint 
gate.fetchLeverageTiers ([symbols, params])

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 gate
Returns: object - a leverage tiers structure

See: https://www.gate.io/docs/developers/apiv4/en/#list-risk-limit-tiers

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
gate.fetchMarketLeverageTiers (symbol[, params])

repayMargin{docsify-ignore}

repay borrowed margin and interest

Kind: instance method of gate
Returns: object - a margin loan structure

See: https://www.gate.io/docs/apiv4/en/#repay-a-loan

Param Type Required Description
symbol string Yes unified market symbol
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.mode string No 'all' or 'partial' payment mode, extra parameter required for isolated margin
params.id string No '34267567' loan id, extra parameter required for isolated margin 
gate.repayMargin (symbol, code, amount[, params])

repayCrossMargin{docsify-ignore}

repay cross margin borrowed margin and interest

Kind: instance method of gate
Returns: object - a margin loan structure

See

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.mode string No 'all' or 'partial' payment mode, extra parameter required for isolated margin
params.id string No '34267567' loan id, extra parameter required for isolated margin
params.unifiedAccount boolean No set to true for repaying in the unified account 
gate.repayCrossMargin (code, amount[, params])

borrowIsolatedMargin{docsify-ignore}

create a loan to borrow margin

Kind: instance method of gate
Returns: object - a margin loan structure

See: https://www.gate.io/docs/developers/apiv4/en/#marginuni

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
params.rate string No '0.0002' or '0.002' extra parameter required for isolated margin 
gate.borrowIsolatedMargin (symbol, code, amount[, params])

borrowMargin{docsify-ignore}

create a loan to borrow margin

Kind: instance method of gate
Returns: object - a margin loan structure

See

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.rate string No '0.0002' or '0.002' extra parameter required for isolated margin
params.unifiedAccount boolean No set to true for borrowing in the unified account 
gate.borrowMargin (code, amount[, params])

fetchBorrowInterest{docsify-ignore}

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

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

See

Param Type Required Description
code string No unified currency code
symbol string No unified market symbol when fetching interest in isolated markets
since int No the earliest time in ms to fetch borrow interest for
limit int No the maximum number of structures to retrieve
params object No extra parameters specific to the exchange API endpoint
params.unifiedAccount boolean No set to true for fetching borrow interest in the unified account 
gate.fetchBorrowInterest ([code, symbol, since, limit, params])

reduceMargin{docsify-ignore}

remove margin from a position

Kind: instance method of gate
Returns: object - a margin structure

See

Param Type Required Description
symbol string Yes unified market symbol
amount float Yes the amount of margin to remove
params object No extra parameters specific to the exchange API endpoint 
gate.reduceMargin (symbol, amount[, params])

addMargin{docsify-ignore}

add margin

Kind: instance method of gate
Returns: object - a margin structure

See

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 
gate.addMargin (symbol, amount[, params])

fetchOpenInterest{docsify-ignore}

Retrieves the open interest of a currency

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

See: https://www.gate.io/docs/developers/apiv4/en/#futures-stats

Param Type Required Description
symbol string Yes Unified CCXT market symbol
timeframe string Yes "5m", "15m", "30m", "1h", "4h", "1d"
since int No the time(ms) of the earliest record to retrieve as a unix timestamp
limit int No default 30
params object No exchange specific parameters
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 
gate.fetchOpenInterest (symbol, timeframe[, since, limit, params])

fetchSettlementHistory{docsify-ignore}

fetches historical settlement records

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

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

Param Type Required Description
symbol string Yes unified market symbol of the settlement history, required on gate
since int No timestamp in ms
limit int No number of records
params object No exchange specific params 
gate.fetchSettlementHistory (symbol[, since, limit, params])

fetchMySettlementHistory{docsify-ignore}

fetches historical settlement records of the user

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

See: https://www.gate.io/docs/developers/apiv4/en/#list-my-options-settlements

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 
gate.fetchMySettlementHistory (symbol[, since, limit, params])

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 gate
Returns: object - a ledger structure

See

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 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 available parameters 
gate.fetchLedger ([code, since, limit, params])

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 gate
Returns: object - response from the exchange

See: https://www.gate.io/docs/developers/apiv4/en/#enable-or-disable-dual-mode

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

fetchUnderlyingAssets{docsify-ignore}

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

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

See: https://www.gate.io/docs/developers/apiv4/en/#list-all-underlyings

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' 
gate.fetchUnderlyingAssets ([params])

fetchLiquidations{docsify-ignore}

retrieves the public liquidations of a trading pair

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

See: https://www.gate.io/docs/developers/apiv4/en/#retrieve-liquidation-history

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 exchange API endpoint
params.until int No timestamp in ms of the latest liquidation 
gate.fetchLiquidations (symbol[, since, limit, params])

fetchMyLiquidations{docsify-ignore}

retrieves the users liquidated positions

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

See

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 exchange API endpoint 
gate.fetchMyLiquidations (symbol[, since, limit, params])

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 gate
Returns: object - a greeks structure

See: https://www.gate.io/docs/developers/apiv4/en/#list-tickers-of-options-contracts

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 
gate.fetchGreeks (symbol[, params])

closePosition{docsify-ignore}

closes open positions for a market

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

See

Param Type Required Description
symbol string Yes Unified CCXT market symbol
side string Yes 'buy' or 'sell'
params object No extra parameters specific to the okx api endpoint 
gate.closePosition (symbol, side[, params])

fetchLeverage{docsify-ignore}

fetch the set leverage for a market

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

See

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint
params.unified boolean No default false, set to true for fetching the unified accounts leverage 
gate.fetchLeverage (symbol[, params])

fetchLeverages{docsify-ignore}

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

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

See

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
params.unified boolean No default false, set to true for fetching unified account leverages 
gate.fetchLeverages (symbols[, params])

fetchOption{docsify-ignore}

fetches option data that is commonly found in an option chain

Kind: instance method of gate
Returns: object - an option chain structure

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

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
gate.fetchOption (symbol[, params])

fetchOptionChain{docsify-ignore}

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

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

See: https://www.gate.io/docs/developers/apiv4/en/#list-all-the-contracts-with-specified-underlying-and-expiration-time

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
params.underlying string No the underlying asset, can be obtained from fetchUnderlyingAssets ()
params.expiration int No unix timestamp of the expiration time 
gate.fetchOptionChain (code[, params])

fetchPositionsHistory{docsify-ignore}

fetches historical positions

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

See

Param Type Required Description
symbols Array<string> Yes unified conract symbols, must all have the same settle currency and the same market type
since int No the earliest time in ms to fetch positions for
limit int No the maximum amount of records to fetch, default=1000
params object Yes extra parameters specific to the exchange api endpoint
params.until int No the latest time in ms to fetch positions for EXCHANGE SPECIFIC PARAMETERS
params.offset int No list offset, starting from 0
params.side string No long or short
params.pnl string No query profit or loss 
gate.fetchPositionsHistory (symbols[, since, limit, params])

createOrderWs{docsify-ignore}

Create an order on the exchange

Kind: instance method of gate
Returns: object | undefined - An order structure

See

Param Type Required Description
symbol string Yes Unified CCXT market symbol
type string Yes 'limit' or 'market' "market" is contract only
side string Yes 'buy' or 'sell'
amount float Yes the amount of currency to trade
price float No ignored in "market" orders the price at which the order is to be fulfilled at in units of the quote currency
params object No extra parameters specific to the exchange API endpoint
params.stopPrice float No The price at which a trigger order is triggered at
params.timeInForce string No "GTC", "IOC", or "PO"
params.stopLossPrice float No The price at which a stop loss order is triggered at
params.takeProfitPrice float No The price at which a take profit order is triggered at
params.marginMode string No 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.iceberg int No Amount to display for the iceberg order, Null or 0 for normal orders, Set to -1 to hide the order completely
params.text string No User defined information
params.account string No spot and margin only "spot", "margin" or "cross_margin"
params.auto_borrow bool No margin only Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough
params.settle string No contract only Unified Currency Code for settle currency
params.reduceOnly bool No contract only Indicates if this order is to reduce the size of a position
params.close bool No contract only Set as true to close the position, with size set to 0
params.auto_size bool No contract 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 int No contract only 0 latest deal price, 1 mark price, 2 index price
params.cost float No spot market buy only the quote quantity that can be used as an alternative for the amount 
gate.createOrderWs (symbol, type, side, amount[, price, params])

createOrdersWs{docsify-ignore}

create a list of trade orders

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

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

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 
gate.createOrdersWs (orders[, params])

cancelAllOrdersWs{docsify-ignore}

cancel all open orders

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

See

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.channel string No the channel to use, defaults to spot.order_cancel_cp or futures.order_cancel_cp 
gate.cancelAllOrdersWs (symbol[, params])

cancelOrderWs{docsify-ignore}

Cancels an open order

Kind: instance method of gate
Returns: An order structure

See

Param Type Required Description
id string Yes Order id
symbol string Yes Unified market symbol
params object No Parameters specified by the exchange api
params.trigger bool No True if the order to be cancelled is a trigger order 
gate.cancelOrderWs (id, symbol[, params])

editOrderWs{docsify-ignore}

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

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

See

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 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 
gate.editOrderWs (id, symbol, type, side, amount[, price, params])

fetchOrderWs{docsify-ignore}

Retrieves information on an order

Kind: instance method of gate
Returns: An order structure

See

Param Type Required Description
id string Yes Order id
symbol string Yes Unified market symbol, required for spot and margin
params object No Parameters specified by the exchange api
params.trigger bool No True if the order being fetched is a trigger order
params.marginMode string No 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used
params.type string No 'spot', 'swap', or 'future', if not provided this.options['defaultMarginMode'] is used
params.settle string 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 
gate.fetchOrderWs (id, symbol[, params])

fetchOpenOrdersWs{docsify-ignore}

fetch all unfilled currently open orders

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

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

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 
gate.fetchOpenOrdersWs (symbol[, since, limit, params])

fetchClosedOrdersWs{docsify-ignore}

fetches information on multiple closed orders made by the user

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

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

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 
gate.fetchClosedOrdersWs (symbol[, since, limit, params])

fetchOrdersWs{docsify-ignore}

fetches information on multiple orders made by the user by status

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

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

Param Type Required Description
status string Yes requested order status
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.limit int No the maximum number of order structures to retrieve 
gate.fetchOrdersWs (status, symbol[, since, limit, params])

watchOrderBook{docsify-ignore}

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

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

See

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 
gate.watchOrderBook (symbol[, limit, params])

unWatchOrderBook{docsify-ignore}

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

Kind: instance method of gate
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
params object No extra parameters specific to the exchange API endpoint 
gate.unWatchOrderBook (symbol[, params])

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

See: https://www.gate.io/docs/developers/apiv4/ws/en/#tickers-channel

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 
gate.watchTicker (symbol[, params])

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

See: https://www.gate.io/docs/developers/apiv4/ws/en/#tickers-channel

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 
gate.watchTickers (symbols[, params])

watchBidsAsks{docsify-ignore}

watches best bid & ask for symbols

Kind: instance method of gate
Returns: object - a ticker structure

See

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 
gate.watchBidsAsks (symbols[, params])

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of gate
Returns: Array<object> - 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 
gate.watchTrades (symbol[, since, limit, params])

watchTradesForSymbols{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of gate
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 
gate.watchTradesForSymbols (symbols[, since, limit, params])

unWatchTradesForSymbols{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of gate
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 
gate.unWatchTradesForSymbols (symbols[, params])

unWatchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

Param Type Required Description
symbol string Yes unified symbol of the market to fetch trades for
params object No extra parameters specific to the exchange API endpoint 
gate.unWatchTrades (symbol[, params])

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 gate
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 
gate.watchOHLCV (symbol, timeframe[, since, limit, params])

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

Kind: instance method of gate
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 
gate.watchMyTrades (symbol[, since, limit, params])

watchBalance{docsify-ignore}

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

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
gate.watchBalance ([params])

watchPositions{docsify-ignore}

watch all open positions

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

See

Param Type Required Description
symbols Array<string> No list of unified market symbols to watch positions for
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 
gate.watchPositions ([symbols, since, limit, params])

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of gate
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
params.type string No spot, margin, swap, future, or option. Required if listening to all symbols.
params.isInverse boolean No if future, listen to inverse or linear contracts 
gate.watchOrders (symbol[, since, limit, params])

watchMyLiquidations{docsify-ignore}

watch the public liquidations of a trading pair

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

See

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 
gate.watchMyLiquidations (symbol[, since, limit, params])

watchMyLiquidationsForSymbols{docsify-ignore}

watch the private liquidations of a trading pair

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

See

Param Type Required Description
symbols Array<string> Yes unified CCXT 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 gate api endpoint 
gate.watchMyLiquidationsForSymbols (symbols[, since, limit, params])
Reference in New Issue View Git Blame Copy Permalink