gate-api

gate-api@6.98.0

TypeScript NodeJS client for gate-api.

Welcome to Gate API

APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 4.98.0
• Package version:
• Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen For more information, please visit https://www.gate.io/page/contacts

Environment

• Node.js

Language level

• ES2017

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference) This package is targeting Node.js applications only, because it's not safe to store API secret in browser. gateapi-js can be used in browser but with public endpoints only.

Versioning

Trying our best to follow the semantic versioning, while enjoying recent features provided by programming language and libraries, from 4.15.2, one major versioning difference will be introduced:

If extra code rewrite is required when you upgrade the SDK, such as:

• some outdated programming language version support is dropped
• API method signature has breaking changes.

the MAJOR version will be incremented, but the MINOR and PATCH version are still following REST API's instead of resetting to 0, so that you can recognize it has some breaking changes, but still getting the idea of from which REST API version the change is introduced.

For example, the previous REST API and SDK version are both 4.14.0. But if we decide to introduce some breaking changes in SDK along with REST API 4.15.2 upgrade, then the version of next SDK release will be 5.15.2(the MAJOR version is incremented to denote breaking changes, but the MINOR and PATCH version are identical to REST API's instead of resetting them to 0)

If MAJOR version is incremented, make sure you read the release note on Releases page

Installation

npm install gate-api

Getting Started

Please follow the installation instruction and execute the following TypeScript code:

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.AccountApi(client);
api.getAccountDetail()
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Documentation for API Endpoints

All URIs are relative to https://api.gateio.ws/api/v4

Class	Method	HTTP request	Description
AccountApi	getAccountDetail	GET /account/detail	Get account detail
AccountApi	getAccountRateLimit	GET /account/rate_limit	Get user transaction rate limit information
AccountApi	listSTPGroups	GET /account/stp_groups	List STP Groups
AccountApi	createSTPGroup	POST /account/stp_groups	Create STP Group
AccountApi	listSTPGroupsUsers	GET /account/stp_groups/{stp_id}/users	List users of the STP group
AccountApi	addSTPGroupUsers	POST /account/stp_groups/{stp_id}/users	Add users to the STP group
AccountApi	deleteSTPGroupUsers	DELETE /account/stp_groups/{stp_id}/users	Delete the user in the STP group
AccountApi	getDebitFee	GET /account/debit_fee	Query GT deduction configuration.
AccountApi	setDebitFee	POST /account/debit_fee	Set GT deduction.
CollateralLoanApi	listCollateralLoanOrders	GET /loan/collateral/orders	List Orders
CollateralLoanApi	createCollateralLoan	POST /loan/collateral/orders	Place order
CollateralLoanApi	getCollateralLoanOrderDetail	GET /loan/collateral/orders/{order_id}	Get a single order
CollateralLoanApi	repayCollateralLoan	POST /loan/collateral/repay	Repayment
CollateralLoanApi	listRepayRecords	GET /loan/collateral/repay_records	Repayment history
CollateralLoanApi	listCollateralRecords	GET /loan/collateral/collaterals	Query collateral adjustment records
CollateralLoanApi	operateCollateral	POST /loan/collateral/collaterals	Increase or redeem collateral
CollateralLoanApi	getUserTotalAmount	GET /loan/collateral/total_amount	Query the total borrowing and collateral amount for the user
CollateralLoanApi	getUserLtvInfo	GET /loan/collateral/ltv	Query user's collateralization ratio
CollateralLoanApi	listCollateralCurrencies	GET /loan/collateral/currencies	Query supported borrowing and collateral currencies
DeliveryApi	listDeliveryContracts	GET /delivery/{settle}/contracts	List all futures contracts
DeliveryApi	getDeliveryContract	GET /delivery/{settle}/contracts/{contract}	Get a single contract
DeliveryApi	listDeliveryOrderBook	GET /delivery/{settle}/order_book	Futures order book
DeliveryApi	listDeliveryTrades	GET /delivery/{settle}/trades	Futures trading history
DeliveryApi	listDeliveryCandlesticks	GET /delivery/{settle}/candlesticks	Get futures candlesticks
DeliveryApi	listDeliveryTickers	GET /delivery/{settle}/tickers	List futures tickers
DeliveryApi	listDeliveryInsuranceLedger	GET /delivery/{settle}/insurance	Futures insurance balance history
DeliveryApi	listDeliveryAccounts	GET /delivery/{settle}/accounts	Query futures account
DeliveryApi	listDeliveryAccountBook	GET /delivery/{settle}/account_book	Query account book
DeliveryApi	listDeliveryPositions	GET /delivery/{settle}/positions	List all positions of a user
DeliveryApi	getDeliveryPosition	GET /delivery/{settle}/positions/{contract}	Get single position
DeliveryApi	updateDeliveryPositionMargin	POST /delivery/{settle}/positions/{contract}/margin	Update position margin
DeliveryApi	updateDeliveryPositionLeverage	POST /delivery/{settle}/positions/{contract}/leverage	Update position leverage
DeliveryApi	updateDeliveryPositionRiskLimit	POST /delivery/{settle}/positions/{contract}/risk_limit	Update position risk limit
DeliveryApi	listDeliveryOrders	GET /delivery/{settle}/orders	List futures orders
DeliveryApi	createDeliveryOrder	POST /delivery/{settle}/orders	Create a futures order
DeliveryApi	cancelDeliveryOrders	DELETE /delivery/{settle}/orders	Cancel all `open` orders matched
DeliveryApi	getDeliveryOrder	GET /delivery/{settle}/orders/{order_id}	Get a single order
DeliveryApi	cancelDeliveryOrder	DELETE /delivery/{settle}/orders/{order_id}	Cancel a single order
DeliveryApi	getMyDeliveryTrades	GET /delivery/{settle}/my_trades	List personal trading history
DeliveryApi	listDeliveryPositionClose	GET /delivery/{settle}/position_close	List position close history
DeliveryApi	listDeliveryLiquidates	GET /delivery/{settle}/liquidates	List liquidation history
DeliveryApi	listDeliverySettlements	GET /delivery/{settle}/settlements	List settlement history
DeliveryApi	listDeliveryRiskLimitTiers	GET /delivery/{settle}/risk_limit_tiers	List risk limit tiers
DeliveryApi	listPriceTriggeredDeliveryOrders	GET /delivery/{settle}/price_orders	List All Price-triggered Orders
DeliveryApi	createPriceTriggeredDeliveryOrder	POST /delivery/{settle}/price_orders	Create a price-triggered order
DeliveryApi	cancelPriceTriggeredDeliveryOrderList	DELETE /delivery/{settle}/price_orders	Cancel All Price-triggered Orders
DeliveryApi	getPriceTriggeredDeliveryOrder	GET /delivery/{settle}/price_orders/{order_id}	Get a price-triggered order
DeliveryApi	cancelPriceTriggeredDeliveryOrder	DELETE /delivery/{settle}/price_orders/{order_id}	cancel a price-triggered order
EarnApi	swapETH2	POST /earn/staking/eth2/swap	ETH2 swap
EarnApi	rateListETH2	GET /earn/staking/eth2/rate_records	ETH2 historical rate of return query
EarnApi	listDualInvestmentPlans	GET /earn/dual/investment_plan	Dual Investment product list
EarnApi	listDualOrders	GET /earn/dual/orders	Dual Investment order list
EarnApi	placeDualOrder	POST /earn/dual/orders	Place Dual Investment order
EarnApi	listStructuredProducts	GET /earn/structured/products	Structured Product List
EarnApi	listStructuredOrders	GET /earn/structured/orders	Structured Product Order List
EarnApi	placeStructuredOrder	POST /earn/structured/orders	Place Structured Product Order
EarnUniApi	listUniCurrencies	GET /earn/uni/currencies	List currencies for lending
EarnUniApi	getUniCurrency	GET /earn/uni/currencies/{currency}	Get currency detail for lending
EarnUniApi	listUserUniLends	GET /earn/uni/lends	List user's lending orders
EarnUniApi	createUniLend	POST /earn/uni/lends	Lend or redeem
EarnUniApi	changeUniLend	PATCH /earn/uni/lends	Amend lending order
EarnUniApi	listUniLendRecords	GET /earn/uni/lend_records	List records of lending
EarnUniApi	getUniInterest	GET /earn/uni/interests/{currency}	Get the user's total interest income of specified currency
EarnUniApi	listUniInterestRecords	GET /earn/uni/interest_records	List interest records
EarnUniApi	switchInterestReinvest	PUT /earn/uni/interest_reinvest	Set interest reinvestment toggle
EarnUniApi	getUniInterestStatus	GET /earn/uni/interest_status/{currency}	query currency interest compounding status
EarnUniApi	listUniChart	GET /earn/uni/chart	UniLoan currency annualized trend chart
EarnUniApi	listUniRate	GET /earn/uni/rate	Currency estimate annualized interest rate
FlashSwapApi	listFlashSwapCurrencyPair	GET /flash_swap/currency_pairs	List All Supported Currency Pairs In Flash Swap
FlashSwapApi	listFlashSwapOrders	GET /flash_swap/orders	List all flash swap orders
FlashSwapApi	createFlashSwapOrder	POST /flash_swap/orders	Create a flash swap order
FlashSwapApi	getFlashSwapOrder	GET /flash_swap/orders/{order_id}	Get a single flash swap order's detail
FlashSwapApi	previewFlashSwapOrder	POST /flash_swap/orders/preview	Initiate a flash swap order preview
FuturesApi	listFuturesContracts	GET /futures/{settle}/contracts	List all futures contracts
FuturesApi	getFuturesContract	GET /futures/{settle}/contracts/{contract}	Get a single contract
FuturesApi	listFuturesOrderBook	GET /futures/{settle}/order_book	Futures order book
FuturesApi	listFuturesTrades	GET /futures/{settle}/trades	Futures trading history
FuturesApi	listFuturesCandlesticks	GET /futures/{settle}/candlesticks	Get futures candlesticks
FuturesApi	listFuturesPremiumIndex	GET /futures/{settle}/premium_index	Premium Index K-Line
FuturesApi	listFuturesTickers	GET /futures/{settle}/tickers	List futures tickers
FuturesApi	listFuturesFundingRateHistory	GET /futures/{settle}/funding_rate	Funding rate history
FuturesApi	listFuturesInsuranceLedger	GET /futures/{settle}/insurance	Futures insurance balance history
FuturesApi	listContractStats	GET /futures/{settle}/contract_stats	Futures stats
FuturesApi	getIndexConstituents	GET /futures/{settle}/index_constituents/{index}	Get index constituents
FuturesApi	listLiquidatedOrders	GET /futures/{settle}/liq_orders	Retrieve liquidation history
FuturesApi	listFuturesRiskLimitTiers	GET /futures/{settle}/risk_limit_tiers	List risk limit tiers
FuturesApi	listFuturesAccounts	GET /futures/{settle}/accounts	Query futures account
FuturesApi	listFuturesAccountBook	GET /futures/{settle}/account_book	Query account book
FuturesApi	listPositions	GET /futures/{settle}/positions	List all positions of a user
FuturesApi	getPosition	GET /futures/{settle}/positions/{contract}	Get single position
FuturesApi	updatePositionMargin	POST /futures/{settle}/positions/{contract}/margin	Update position margin
FuturesApi	updatePositionLeverage	POST /futures/{settle}/positions/{contract}/leverage	Update position leverage
FuturesApi	updatePositionCrossMode	POST /futures/{settle}/positions/cross_mode	Switch to the full position-by-store mode
FuturesApi	updatePositionRiskLimit	POST /futures/{settle}/positions/{contract}/risk_limit	Update position risk limit
FuturesApi	setDualMode	POST /futures/{settle}/dual_mode	Enable or disable dual mode
FuturesApi	getDualModePosition	GET /futures/{settle}/dual_comp/positions/{contract}	Retrieve position detail in dual mode
FuturesApi	updateDualModePositionMargin	POST /futures/{settle}/dual_comp/positions/{contract}/margin	Update position margin in dual mode
FuturesApi	updateDualModePositionLeverage	POST /futures/{settle}/dual_comp/positions/{contract}/leverage	Update position leverage in dual mode
FuturesApi	updateDualModePositionRiskLimit	POST /futures/{settle}/dual_comp/positions/{contract}/risk_limit	Update position risk limit in dual mode
FuturesApi	listFuturesOrders	GET /futures/{settle}/orders	List futures orders
FuturesApi	createFuturesOrder	POST /futures/{settle}/orders	Create a futures order
FuturesApi	cancelFuturesOrders	DELETE /futures/{settle}/orders	Cancel all `open` orders matched
FuturesApi	getOrdersWithTimeRange	GET /futures/{settle}/orders_timerange	List Futures Orders By Time Range
FuturesApi	createBatchFuturesOrder	POST /futures/{settle}/batch_orders	Create a batch of futures orders
FuturesApi	getFuturesOrder	GET /futures/{settle}/orders/{order_id}	Get a single order
FuturesApi	amendFuturesOrder	PUT /futures/{settle}/orders/{order_id}	Amend an order
FuturesApi	cancelFuturesOrder	DELETE /futures/{settle}/orders/{order_id}	Cancel a single order
FuturesApi	getMyTrades	GET /futures/{settle}/my_trades	List personal trading history
FuturesApi	getMyTradesWithTimeRange	GET /futures/{settle}/my_trades_timerange	List personal trading history by time range
FuturesApi	listPositionClose	GET /futures/{settle}/position_close	List position close history
FuturesApi	listLiquidates	GET /futures/{settle}/liquidates	List liquidation history
FuturesApi	listAutoDeleverages	GET /futures/{settle}/auto_deleverages	List Auto-Deleveraging History
FuturesApi	countdownCancelAllFutures	POST /futures/{settle}/countdown_cancel_all	Countdown cancel orders
FuturesApi	getFuturesFee	GET /futures/{settle}/fee	Query user trading fee rates
FuturesApi	cancelBatchFutureOrders	POST /futures/{settle}/batch_cancel_orders	Cancel a batch of orders with an ID list
FuturesApi	amendBatchFutureOrders	POST /futures/{settle}/batch_amend_orders	Batch modify orders with specified IDs
FuturesApi	listPriceTriggeredOrders	GET /futures/{settle}/price_orders	List All Price-triggered Orders
FuturesApi	createPriceTriggeredOrder	POST /futures/{settle}/price_orders	Create a price-triggered order
FuturesApi	cancelPriceTriggeredOrderList	DELETE /futures/{settle}/price_orders	Cancel All Price-triggered Orders
FuturesApi	getPriceTriggeredOrder	GET /futures/{settle}/price_orders/{order_id}	Get a price-triggered order
FuturesApi	cancelPriceTriggeredOrder	DELETE /futures/{settle}/price_orders/{order_id}	cancel a price-triggered order
MarginApi	listMarginAccounts	GET /margin/accounts	Margin account list
MarginApi	listMarginAccountBook	GET /margin/account_book	List margin account balance change history
MarginApi	listFundingAccounts	GET /margin/funding_accounts	Funding account list
MarginApi	getAutoRepayStatus	GET /margin/auto_repay	Retrieve user auto repayment setting
MarginApi	setAutoRepay	POST /margin/auto_repay	Update user's auto repayment setting
MarginApi	getMarginTransferable	GET /margin/transferable	Get the max transferable amount for a specific margin currency
MarginApi	listCrossMarginCurrencies	GET /margin/cross/currencies	Currencies supported by cross margin.(deprecated)
MarginApi	getCrossMarginCurrency	GET /margin/cross/currencies/{currency}	Retrieve detail of one single currency supported by cross margin. (deprecated)
MarginApi	getCrossMarginAccount	GET /margin/cross/accounts	Retrieve cross margin account. (deprecated)
MarginApi	listCrossMarginAccountBook	GET /margin/cross/account_book	Retrieve cross margin account change history. (deprecated)
MarginApi	listCrossMarginLoans	GET /margin/cross/loans	List cross margin borrow history. (deprecated)
MarginApi	createCrossMarginLoan	POST /margin/cross/loans	Create a cross margin borrow loan. (deprecated)
MarginApi	getCrossMarginLoan	GET /margin/cross/loans/{loan_id}	Retrieve single borrow loan detail. (deprecated)
MarginApi	listCrossMarginRepayments	GET /margin/cross/repayments	Retrieve cross margin repayments. (deprecated)
MarginApi	repayCrossMarginLoan	POST /margin/cross/repayments	Cross margin repayments. (deprecated)
MarginApi	getCrossMarginInterestRecords	GET /margin/cross/interest_records	Interest records for the cross margin account. (deprecated)
MarginApi	getCrossMarginTransferable	GET /margin/cross/transferable	Get the max transferable amount for a specific cross margin currency. (deprecated)
MarginApi	getCrossMarginEstimateRate	GET /margin/cross/estimate_rate	Estimated interest rates. (deprecated)
MarginApi	getCrossMarginBorrowable	GET /margin/cross/borrowable	Get the max borrowable amount for a specific cross margin currency. (deprecated)
MarginApi	getUserMarginTier	GET /margin/user/loan_margin_tiers	Check the user's own leverage lending gradient in the current market
MarginApi	getMarketMarginTier	GET /margin/loan_margin_tiers	Query the current market leverage lending gradient
MarginApi	setUserMarketLeverage	POST /margin/leverage/user_market_setting	Set the user market leverage multiple
MarginApi	listMarginUserAccount	GET /margin/user/account	Query the user's leverage account list
MarginUniApi	listUniCurrencyPairs	GET /margin/uni/currency_pairs	List lending markets
MarginUniApi	getUniCurrencyPair	GET /margin/uni/currency_pairs/{currency_pair}	Get detail of lending market
MarginUniApi	getMarginUniEstimateRate	GET /margin/uni/estimate_rate	Estimate interest Rate
MarginUniApi	listUniLoans	GET /margin/uni/loans	List loans
MarginUniApi	createUniLoan	POST /margin/uni/loans	Borrow or repay
MarginUniApi	listUniLoanRecords	GET /margin/uni/loan_records	Get load records
MarginUniApi	listUniLoanInterestRecords	GET /margin/uni/interest_records	List interest records
MarginUniApi	getUniBorrowable	GET /margin/uni/borrowable	Get maximum borrowable
MultiCollateralLoanApi	listMultiCollateralOrders	GET /loan/multi_collateral/orders	List Multi-Collateral Orders
MultiCollateralLoanApi	createMultiCollateral	POST /loan/multi_collateral/orders	Create Multi-Collateral Order
MultiCollateralLoanApi	getMultiCollateralOrderDetail	GET /loan/multi_collateral/orders/{order_id}	Get Multi-Collateral Order Detail
MultiCollateralLoanApi	listMultiRepayRecords	GET /loan/multi_collateral/repay	List Multi-Collateral Repay Records
MultiCollateralLoanApi	repayMultiCollateralLoan	POST /loan/multi_collateral/repay	Repay Multi-Collateral Loan
MultiCollateralLoanApi	listMultiCollateralRecords	GET /loan/multi_collateral/mortgage	Query collateral adjustment records
MultiCollateralLoanApi	operateMultiCollateral	POST /loan/multi_collateral/mortgage	Operate Multi-Collateral
MultiCollateralLoanApi	listUserCurrencyQuota	GET /loan/multi_collateral/currency_quota	List User Currency Quota
MultiCollateralLoanApi	listMultiCollateralCurrencies	GET /loan/multi_collateral/currencies	Query supported borrowing and collateral currencies in Multi-Collateral
MultiCollateralLoanApi	getMultiCollateralLtv	GET /loan/multi_collateral/ltv	Get Multi-Collateral ratio
MultiCollateralLoanApi	getMultiCollateralFixRate	GET /loan/multi_collateral/fixed_rate	Query fixed interest rates for the currency for 7 days and 30 days
MultiCollateralLoanApi	getMultiCollateralCurrentRate	GET /loan/multi_collateral/current_rate	Query the current interest rate of the currency
OptionsApi	listOptionsUnderlyings	GET /options/underlyings	List all underlyings
OptionsApi	listOptionsExpirations	GET /options/expirations	List all expiration times
OptionsApi	listOptionsContracts	GET /options/contracts	List all the contracts with specified underlying and expiration time
OptionsApi	getOptionsContract	GET /options/contracts/{contract}	Query specified contract detail
OptionsApi	listOptionsSettlements	GET /options/settlements	List settlement history
OptionsApi	getOptionsSettlement	GET /options/settlements/{contract}	Get specified contract's settlement
OptionsApi	listMyOptionsSettlements	GET /options/my_settlements	List my options settlements
OptionsApi	listOptionsOrderBook	GET /options/order_book	Options order book
OptionsApi	listOptionsTickers	GET /options/tickers	List tickers of options contracts
OptionsApi	listOptionsUnderlyingTickers	GET /options/underlying/tickers/{underlying}	Get underlying ticker
OptionsApi	listOptionsCandlesticks	GET /options/candlesticks	Get options candlesticks
OptionsApi	listOptionsUnderlyingCandlesticks	GET /options/underlying/candlesticks	Mark price candlesticks of an underlying
OptionsApi	listOptionsTrades	GET /options/trades	Options trade history
OptionsApi	listOptionsAccount	GET /options/accounts	List options account
OptionsApi	listOptionsAccountBook	GET /options/account_book	List account changing history
OptionsApi	listOptionsPositions	GET /options/positions	List user's positions of specified underlying
OptionsApi	getOptionsPosition	GET /options/positions/{contract}	Get specified contract position
OptionsApi	listOptionsPositionClose	GET /options/position_close	List user's liquidation history of specified underlying
OptionsApi	listOptionsOrders	GET /options/orders	List options orders
OptionsApi	createOptionsOrder	POST /options/orders	Create an options order
OptionsApi	cancelOptionsOrders	DELETE /options/orders	Cancel all `open` orders matched
OptionsApi	getOptionsOrder	GET /options/orders/{order_id}	Get a single order
OptionsApi	cancelOptionsOrder	DELETE /options/orders/{order_id}	Cancel a single order
OptionsApi	countdownCancelAllOptions	POST /options/countdown_cancel_all	Countdown cancel orders
OptionsApi	listMyOptionsTrades	GET /options/my_trades	List personal trading history
OptionsApi	getOptionsMMP	GET /options/mmp	MMP Query
OptionsApi	setOptionsMMP	POST /options/mmp	MMP Settings
OptionsApi	resetOptionsMMP	POST /options/mmp/reset	MMP Reset
RebateApi	agencyTransactionHistory	GET /rebate/agency/transaction_history	The agency obtains the transaction history of the recommended user
RebateApi	agencyCommissionsHistory	GET /rebate/agency/commission_history	The agency obtains the commission history of the recommended user
RebateApi	partnerTransactionHistory	GET /rebate/partner/transaction_history	Partner obtains transaction records of recommended users
RebateApi	partnerCommissionsHistory	GET /rebate/partner/commission_history	Partner obtains commission records of recommended users
RebateApi	partnerSubList	GET /rebate/partner/sub_list	Partner subordinate list
RebateApi	rebateBrokerCommissionHistory	GET /rebate/broker/commission_history	The broker obtains the user's commission rebate records
RebateApi	rebateBrokerTransactionHistory	GET /rebate/broker/transaction_history	The broker obtains the user's trading history
RebateApi	rebateUserInfo	GET /rebate/user/info	User retrieves rebate information
RebateApi	userSubRelation	GET /rebate/user/sub_relation	User-subordinate relationship
SpotApi	listCurrencies	GET /spot/currencies	List all currencies' details
SpotApi	getCurrency	GET /spot/currencies/{currency}	Get details of a specific currency
SpotApi	listCurrencyPairs	GET /spot/currency_pairs	List all currency pairs supported
SpotApi	getCurrencyPair	GET /spot/currency_pairs/{currency_pair}	Get details of a specifc currency pair
SpotApi	listTickers	GET /spot/tickers	Retrieve ticker information
SpotApi	listOrderBook	GET /spot/order_book	Retrieve order book
SpotApi	listTrades	GET /spot/trades	Retrieve market trades
SpotApi	listCandlesticks	GET /spot/candlesticks	Market candlesticks
SpotApi	getFee	GET /spot/fee	Query user trading fee rates
SpotApi	getBatchSpotFee	GET /spot/batch_fee	Query a batch of user trading fee rates
SpotApi	listSpotAccounts	GET /spot/accounts	List spot accounts
SpotApi	listSpotAccountBook	GET /spot/account_book	Query account book
SpotApi	createBatchOrders	POST /spot/batch_orders	Create a batch of orders
SpotApi	listAllOpenOrders	GET /spot/open_orders	List all open orders
SpotApi	createCrossLiquidateOrder	POST /spot/cross_liquidate_orders	close position when cross-currency is disabled
SpotApi	listOrders	GET /spot/orders	List orders
SpotApi	createOrder	POST /spot/orders	Create an order
SpotApi	cancelOrders	DELETE /spot/orders	Cancel all `open` orders in specified currency pair
SpotApi	cancelBatchOrders	POST /spot/cancel_batch_orders	Cancel a batch of orders with an ID list
SpotApi	getOrder	GET /spot/orders/{order_id}	Get a single order
SpotApi	cancelOrder	DELETE /spot/orders/{order_id}	Cancel a single order
SpotApi	amendOrder	PATCH /spot/orders/{order_id}	Amend an order
SpotApi	listMyTrades	GET /spot/my_trades	List personal trading history
SpotApi	getSystemTime	GET /spot/time	Get server current time
SpotApi	countdownCancelAllSpot	POST /spot/countdown_cancel_all	Countdown cancel orders
SpotApi	amendBatchOrders	POST /spot/amend_batch_orders	Batch modification of orders
SpotApi	getSpotInsuranceHistory	GET /spot/insurance_history	Query spot insurance fund historical data
SpotApi	listSpotPriceTriggeredOrders	GET /spot/price_orders	Retrieve running auto order list
SpotApi	createSpotPriceTriggeredOrder	POST /spot/price_orders	Create a price-triggered order
SpotApi	cancelSpotPriceTriggeredOrderList	DELETE /spot/price_orders	Cancel All Price-triggered Orders
SpotApi	getSpotPriceTriggeredOrder	GET /spot/price_orders/{order_id}	Get a price-triggered order
SpotApi	cancelSpotPriceTriggeredOrder	DELETE /spot/price_orders/{order_id}	cancel a price-triggered order
SubAccountApi	listSubAccounts	GET /sub_accounts	List sub-accounts
SubAccountApi	createSubAccounts	POST /sub_accounts	Create a new sub-account
SubAccountApi	getSubAccount	GET /sub_accounts/{user_id}	Get the sub-account
SubAccountApi	listSubAccountKeys	GET /sub_accounts/{user_id}/keys	List all API Key of the sub-account
SubAccountApi	createSubAccountKeys	POST /sub_accounts/{user_id}/keys	Create API Key of the sub-account
SubAccountApi	getSubAccountKey	GET /sub_accounts/{user_id}/keys/{key}	Get the API Key of the sub-account
SubAccountApi	updateSubAccountKeys	PUT /sub_accounts/{user_id}/keys/{key}	Update API key of the sub-account
SubAccountApi	deleteSubAccountKeys	DELETE /sub_accounts/{user_id}/keys/{key}	Delete API key of the sub-account
SubAccountApi	lockSubAccount	POST /sub_accounts/{user_id}/lock	Lock the sub-account
SubAccountApi	unlockSubAccount	POST /sub_accounts/{user_id}/unlock	Unlock the sub-account
SubAccountApi	listUnifiedMode	GET /sub_accounts/unified_mode	Get sub-account mode
UnifiedApi	listUnifiedAccounts	GET /unified/accounts	Get unified account information
UnifiedApi	getUnifiedBorrowable	GET /unified/borrowable	Query about the maximum borrowing for the unified account
UnifiedApi	getUnifiedTransferable	GET /unified/transferable	Query about the maximum transferable for the unified account
UnifiedApi	getUnifiedTransferables	GET /unified/transferables	Batch query can be transferred out at most for unified accounts; each currency is the maximum value. After the user withdraws the currency, the amount of transferable currency will be changed.
UnifiedApi	getUnifiedBorrowableList	GET /unified/batch_borrowable	Batch query unified account can be borrowed up to a maximum
UnifiedApi	listUnifiedLoans	GET /unified/loans	List loans
UnifiedApi	createUnifiedLoan	POST /unified/loans	Borrow or repay
UnifiedApi	listUnifiedLoanRecords	GET /unified/loan_records	Get load records
UnifiedApi	listUnifiedLoanInterestRecords	GET /unified/interest_records	List interest records
UnifiedApi	getUnifiedRiskUnits	GET /unified/risk_units	Get user risk unit details
UnifiedApi	getUnifiedMode	GET /unified/unified_mode	Query mode of the unified account
UnifiedApi	setUnifiedMode	PUT /unified/unified_mode	Set mode of the unified account
UnifiedApi	getUnifiedEstimateRate	GET /unified/estimate_rate	Get unified estimate rate
UnifiedApi	listCurrencyDiscountTiers	GET /unified/currency_discount_tiers	List currency discount tiers
UnifiedApi	listLoanMarginTiers	GET /unified/loan_margin_tiers	List loan margin tiers
UnifiedApi	calculatePortfolioMargin	POST /unified/portfolio_calculator	Portfolio margin calculator
UnifiedApi	getUserLeverageCurrencyConfig	GET /unified/leverage/user_currency_config	Minimum currency leverage that can be set
UnifiedApi	getUserLeverageCurrencySetting	GET /unified/leverage/user_currency_setting	Get the leverage multiple of the user currency
UnifiedApi	setUserLeverageCurrencySetting	POST /unified/leverage/user_currency_setting	Set the loan currency leverage
UnifiedApi	listUnifiedCurrencies	GET /unified/currencies	List of loan currencies supported by unified account
UnifiedApi	getHistoryLoanRate	GET /unified/history_loan_rate	get historical lending rates
WalletApi	listCurrencyChains	GET /wallet/currency_chains	List chains supported for specified currency
WalletApi	getDepositAddress	GET /wallet/deposit_address	Generate currency deposit address
WalletApi	listWithdrawals	GET /wallet/withdrawals	Retrieve withdrawal records
WalletApi	listDeposits	GET /wallet/deposits	Retrieve deposit records
WalletApi	transfer	POST /wallet/transfers	Transfer between trading accounts
WalletApi	listSubAccountTransfers	GET /wallet/sub_account_transfers	Retrieve transfer records between main and sub accounts
WalletApi	transferWithSubAccount	POST /wallet/sub_account_transfers	Transfer between main and sub accounts
WalletApi	subAccountToSubAccount	POST /wallet/sub_account_to_sub_account	Sub-account transfers to sub-account
WalletApi	getTransferOrderStatus	GET /wallet/order_status	Transfer status query
WalletApi	listWithdrawStatus	GET /wallet/withdraw_status	Retrieve withdrawal status
WalletApi	listSubAccountBalances	GET /wallet/sub_account_balances	Retrieve sub account balances
WalletApi	listSubAccountMarginBalances	GET /wallet/sub_account_margin_balances	Query sub accounts' margin balances
WalletApi	listSubAccountFuturesBalances	GET /wallet/sub_account_futures_balances	Query sub accounts' futures account balances
WalletApi	listSubAccountCrossMarginBalances	GET /wallet/sub_account_cross_margin_balances	Query subaccount's cross_margin account info
WalletApi	listSavedAddress	GET /wallet/saved_address	Query saved address
WalletApi	getTradeFee	GET /wallet/fee	Retrieve personal trading fee
WalletApi	getTotalBalance	GET /wallet/total_balance	Retrieve user's total balances
WalletApi	listSmallBalance	GET /wallet/small_balance	List small balance
WalletApi	convertSmallBalance	POST /wallet/small_balance	Convert small balance
WalletApi	listSmallBalanceHistory	GET /wallet/small_balance_history	List small balance history
WalletApi	listPushOrders	GET /wallet/push	Retrieve the UID transfer history
WithdrawalApi	withdraw	POST /withdrawals	Withdraw
WithdrawalApi	withdrawPushOrder	POST /withdrawals/push	UID transfer
WithdrawalApi	cancelWithdrawal	DELETE /withdrawals/{withdrawal_id}	Cancel withdrawal with specified ID

Documentation for Models

• AccountBalance
• AccountDetail
• AccountDetailKey
• AccountRateLimit
• AgencyCommission
• AgencyCommissionHistory
• AgencyTransaction
• AgencyTransactionHistory
• AutoRepaySetting
• BatchAmendItem
• BatchAmendOrderReq
• BatchFuturesOrder
• BatchOrder
• BorrowCurrencyInfo
• BrokerCommission
• BrokerCommission1
• BrokerTransaction
• BrokerTransaction1
• CancelBatchOrder
• CancelOrderResult
• CollateralAdjust
• CollateralAdjustRes
• CollateralAlign
• CollateralCurrency
• CollateralCurrencyInfo
• CollateralCurrencyRes
• CollateralCurrentRate
• CollateralFixRate
• CollateralLoanCurrency
• CollateralLtv
• CollateralOrder
• CollateralRecord
• Contract
• ContractStat
• ConvertSmallBalance
• CountdownCancelAllFuturesTask
• CountdownCancelAllOptionsTask
• CountdownCancelAllSpotTask
• CreateCollateralOrder
• CreateMultiCollateralOrder
• CreateUniLend
• CreateUniLoan
• CrossMarginAccount
• CrossMarginAccountBook
• CrossMarginBalance
• CrossMarginBalance1
• CrossMarginCurrency
• CrossMarginLoan
• CrossMarginRepayRequest
• CrossMarginRepayment
• CrossMarginTransferable
• Currency
• CurrencyChain
• CurrencyPair
• CurrencyQuota
• DebitFee
• DeliveryCandlestick
• DeliveryContract
• DeliverySettlement
• DeliveryTicker
• DepositAddress
• DepositRecord
• DualGetOrders
• DualGetPlans
• Eth2RateList
• Eth2Swap
• FlashSwapCurrencyPair
• FlashSwapOrder
• FlashSwapOrderPreview
• FlashSwapOrderRequest
• FlashSwapPreviewRequest
• FundingAccount
• FundingRateRecord
• FutureCancelOrderResult
• FuturesAccount
• FuturesAccountBook
• FuturesAccountHistory
• FuturesAutoDeleverage
• FuturesBatchAmendOrderRequest
• FuturesCandlestick
• FuturesFee
• FuturesIndexConstituents
• FuturesInitialOrder
• FuturesLimitRiskTiers
• FuturesLiqOrder
• FuturesLiquidate
• FuturesOrder
• FuturesOrderAmendment
• FuturesOrderBook
• FuturesOrderBookItem
• FuturesPremiumIndex
• FuturesPriceTrigger
• FuturesPriceTriggeredOrder
• FuturesTicker
• FuturesTrade
• IndexConstituent
• InlineObject
• InlineResponse200
• InlineResponse2001
• InsuranceRecord
• LedgerRecord
• LiquidateOrder
• MarginAccount
• MarginAccountBook
• MarginAccountCurrency
• MarginLeverageTier
• MarginMarketLeverage
• MarginTiers
• MarginTransferable
• MaxUniBorrowable
• MockFuturesOrder
• MockFuturesPosition
• MockMarginResult
• MockOptionsOrder
• MockOptionsPosition
• MockRiskUnit
• MockSpotBalance
• MockSpotOrder
• MultiChainAddressItem
• MultiCollateralCurrency
• MultiCollateralItem
• MultiCollateralOrder
• MultiCollateralRecord
• MultiCollateralRecordCurrency
• MultiLoanItem
• MultiLoanRepayItem
• MultiRepayRecord
• MultiRepayResp
• MyFuturesTrade
• MyFuturesTradeTimeRange
• OpenOrders
• OptionsAccount
• OptionsAccountBook
• OptionsCandlestick
• OptionsContract
• OptionsMMP
• OptionsMMPReset
• OptionsMySettlements
• OptionsMyTrade
• OptionsOrder
• OptionsPosition
• OptionsPositionClose
• OptionsPositionCloseOrder
• OptionsSettlement
• OptionsTicker
• OptionsUnderlying
• OptionsUnderlyingTicker
• Order
• OrderBook
• OrderCancel
• OrderPatch
• OrderResp
• PartnerCommissionHistory
• PartnerSub
• PartnerSubList
• PartnerTransactionHistory
• PatchUniLend
• PlaceDualInvestmentOrder
• Position
• PositionClose
• PositionCloseOrder
• ProfitLossRange
• RebateUserInfo
• RepayCurrencyRes
• RepayLoan
• RepayMultiLoan
• RepayRecord
• RepayRecordCurrency
• RepayRecordLeftInterest
• RepayRecordRepaidCurrency
• RepayRecordTotalInterest
• RepayResp
• RiskUnits
• SavedAddress
• SmallBalance
• SmallBalanceHistory
• SpotAccount
• SpotAccountBook
• SpotCurrencyChain
• SpotFee
• SpotInsuranceHistory
• SpotPricePutOrder
• SpotPriceTrigger
• SpotPriceTriggeredOrder
• StpGroup
• StpGroupUser
• StructuredBuy
• StructuredGetProjectList
• StructuredOrderList
• SubAccount
• SubAccountBalance
• SubAccountCrossMarginBalance
• SubAccountFuturesBalance
• SubAccountKey
• SubAccountKeyPerms
• SubAccountMarginBalance
• SubAccountToSubAccount
• SubAccountTransfer
• SubCrossMarginAccount
• SubUserMode
• SystemTime
• Ticker
• TotalBalance
• Trade
• TradeFee
• TransactionID
• Transfer
• TransferOrderStatus
• TransferablesResult
• TriggerOrderResponse
• TriggerTime
• UidPushOrder
• UidPushWithdrawal
• UidPushWithdrawalResp
• UniCurrency
• UniCurrencyInterest
• UniCurrencyPair
• UniInterestMode
• UniInterestRecord
• UniLend
• UniLendInterest
• UniLendRecord
• UniLoan
• UniLoanInterestRecord
• UniLoanRecord
• UnifiedAccount
• UnifiedBalance
• UnifiedBorrowable
• UnifiedBorrowable1
• UnifiedCurrency
• UnifiedDiscount
• UnifiedDiscountTiers
• UnifiedHistoryLoanRate
• UnifiedHistoryLoanRateRates
• UnifiedLeverageConfig
• UnifiedLeverageSetting
• UnifiedLoan
• UnifiedLoanRecord
• UnifiedLoanResult
• UnifiedMarginTiers
• UnifiedModeSet
• UnifiedPortfolioInput
• UnifiedPortfolioOutput
• UnifiedRiskUnits
• UnifiedSettings
• UnifiedTransferable
• UserLtvInfo
• UserSub
• UserSubRelation
• UserTotalAmount
• WithdrawStatus
• WithdrawalRecord

Documentation for Authorization

Authentication schemes defined for the API:

apiv4

• Type: Gate APIv4

https://www.gate.io/docs/apiv4/en/index.html#apiv4-signed-request-requirements