Launch Week Day 1: Socket for Jira Is Now Available.Learn More
Socket
Book a DemoSign in
Socket

gate-api

Package Overview
Dependencies
Maintainers
1
Versions
68
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gate-api

NodeJS client for gate-api

latest
Source
npmnpm
Version
7.2.67
Version published
Weekly downloads
3.7K
47.38%
Maintainers
1
Weekly downloads
 
Created
Source

gate-api@7.2.67

TypeScript NodeJS client for gate-api.

Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.67
  • Package version:
  • Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen For more information, please visit https://www.gate.com/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

ClassMethodHTTP requestDescription
AccountApigetAccountDetailGET /account/detailRetrieve user account information
AccountApigetAccountMainKeysGET /account/main_keysQuery All Main Account Key Information
AccountApigetAccountRateLimitGET /account/rate_limitGet user transaction rate limit information
AccountApilistSTPGroupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreateSTPGroupPOST /account/stp_groupsCreate STP user group
AccountApilistSTPGroupsUsersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiaddSTPGroupUsersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApideleteSTPGroupUsersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApigetDebitFeeGET /account/debit_feeQuery GT fee deduction configuration
AccountApisetDebitFeePOST /account/debit_feeConfigure GT fee deduction
ActivityApigetMyActivityEntryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilistActivitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilistActivityTypesGET /rewards/activity/activity-typeActivity type list
AlphaApilistAlphaAccountsGET /alpha/accountsAlpha Account API
AlphaApilistAlphaAccountBookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquoteAlphaOrderPOST /alpha/quoteAlpha Quote API
AlphaApilistAlphaOrderGET /alpha/ordersAlpha Order List API
AlphaApiplaceAlphaOrderPOST /alpha/ordersAlpha Order API
AlphaApigetAlphaOrderGET /alpha/orderAlpha Single Order Query API
AlphaApilistAlphaCurrenciesGET /alpha/currenciesQuery currency information
AlphaApilistAlphaTickersGET /alpha/tickersQuery currency ticker
AlphaApilistAlphaTokensGET /alpha/tokensQuery Token Information
AssetswapApilistAssetSwapAssetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApigetAssetSwapConfigGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluateAssetSwapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreateAssetSwapOrderV1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilistAssetSwapOrdersV1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreviewAssetSwapOrderV1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApigetAssetSwapOrderV1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApigetAIHubStrategyRecommendGET /bot/strategy/recommend获取 AIHub 策略推荐
BotApipostAIHubSpotGridCreatePOST /bot/spot-grid/create创建现货网格
BotApipostAIHubMarginGridCreatePOST /bot/margin-grid/create创建杠杆网格
BotApipostAIHubInfiniteGridCreatePOST /bot/infinite-grid/create创建无限网格
BotApipostAIHubFuturesGridCreatePOST /bot/futures-grid/create创建合约网格
BotApipostAIHubSpotMartingaleCreatePOST /bot/spot-martingale/create创建现货马丁
BotApipostAIHubContractMartingaleCreatePOST /bot/contract-martingale/create创建合约马丁
BotApigetAIHubPortfolioRunningGET /bot/portfolio/running查询运行中策略列表
BotApigetAIHubPortfolioDetailGET /bot/portfolio/detail查询单策略详情
BotApipostAIHubPortfolioStopPOST /bot/portfolio/stop终止单个运行中策略
CouponApilistUserCouponsGET /coupon/user-coupon-listCoupon Center list
CouponApigetUserCouponDetailGET /coupon/user-coupon-detailCoupon Center details
CrossExApilistCrossexRuleSymbolsGET /crossex/rule/symbols[Public Interface] Query Trading Pair Information
CrossExApilistCrossexRuleRiskLimitsGET /crossex/rule/risk_limits[Public Interface] Query Risk Limit Information
CrossExApilistCrossexTransferCoinsGET /crossex/transfers/coin[Public Interface] Query Supported Transfer Currencies
CrossExApilistCrossexTransfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreateCrossexTransferPOST /crossex/transfersFund Transfer
CrossExApicreateCrossexOrderPOST /crossex/ordersCreate an order
CrossExApigetCrossexOrderGET /crossex/orders/{order_id}Query order details
CrossExApiupdateCrossexOrderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancelCrossexOrderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreateCrossexConvertQuotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreateCrossexConvertOrderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApigetCrossexAccountGET /crossex/accountsQuery Account Assets
CrossExApiupdateCrossexAccountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApigetCrossexPositionsLeverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdateCrossexPositionsLeveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApigetCrossexMarginPositionsLeverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdateCrossexMarginPositionsLeveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApicloseCrossexPositionPOST /crossex/positionFull Close Position
CrossExApigetCrossexInterestRateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApigetCrossexFeeGET /crossex/feeQuery User Fee Rates
CrossExApilistCrossexPositionsGET /crossex/positionsQuery Contract Positions
CrossExApilistCrossexMarginPositionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilistCrossexAdlRankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilistCrossexOpenOrdersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilistCrossexHistoryOrdersGET /crossex/history_ordersqueryorderhistory
CrossExApilistCrossexHistoryPositionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilistCrossexHistoryMarginPositionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilistCrossexHistoryMarginInterestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilistCrossexHistoryTradesGET /crossex/history_tradesqueryfilledhistory
CrossExApilistCrossexAccountBookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilistCrossexCoinDiscountRateGET /crossex/coin_discount_rateQuery currency discount rate (discount rate of margin currency in isolated exchange mode)
DeliveryApilistDeliveryContractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApigetDeliveryContractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilistDeliveryOrderBookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilistDeliveryTradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilistDeliveryCandlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilistDeliveryTickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilistDeliveryInsuranceLedgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilistDeliveryAccountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilistDeliveryAccountBookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilistDeliveryPositionsGET /delivery/{settle}/positionsGet user position list
DeliveryApigetDeliveryPositionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdateDeliveryPositionMarginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdateDeliveryPositionLeveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdateDeliveryPositionRiskLimitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilistDeliveryOrdersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreateDeliveryOrderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancelDeliveryOrdersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApigetDeliveryOrderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancelDeliveryOrderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApigetMyDeliveryTradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilistDeliveryPositionCloseGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilistDeliveryLiquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilistDeliverySettlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilistDeliveryRiskLimitTiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilistPriceTriggeredDeliveryOrdersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreatePriceTriggeredDeliveryOrderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancelPriceTriggeredDeliveryOrderListDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApigetPriceTriggeredDeliveryOrderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancelPriceTriggeredDeliveryOrderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilistDualInvestmentPlansGET /earn/dual/investment_planDual Investment product list
EarnApilistDualOrdersGET /earn/dual/ordersDual Investment order list
EarnApiplaceDualOrderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilistDualBalanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApigetDualOrderRefundPreviewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplaceDualOrderRefundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodifyDualOrderReinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApigetDualProjectRecommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifindCoinGET /earn/staking/coinsStaking coins
EarnApiswapStakingCoinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorderListGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiawardListGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiassetListGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreateAutoInvestPlanPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdateAutoInvestPlanPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistopAutoInvestPlanPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiaddPositionAutoInvestPlanPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilistAutoInvestCoinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApigetAutoInvestMinAmountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilistAutoInvestPlanRecordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilistAutoInvestOrdersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilistAutoInvestConfigGET /earn/autoinvest/configList investment currency configuration
EarnApigetAutoInvestPlanDetailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilistAutoInvestPlansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilistEarnFixedTermProductsGET /earn/fixed-term/productGet product list
EarnApilistEarnFixedTermProductsByAssetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilistEarnFixedTermLendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreateEarnFixedTermLendPOST /earn/fixed-term/user/lendSubscription
EarnApicreateEarnFixedTermPreRedeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilistEarnFixedTermHistoryGET /earn/fixed-term/user/historySubscription history
EarnUniApilistUniCurrenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApigetUniCurrencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilistUserUniLendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreateUniLendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichangeUniLendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilistUniLendRecordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApigetUniInterestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilistUniInterestRecordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApigetUniInterestStatusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilistUniChartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilistUniRateGET /earn/uni/rateCurrency estimated annualized interest rate
FlashSwapApilistFlashSwapCurrencyPairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilistFlashSwapOrdersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreateFlashSwapOrderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApigetFlashSwapOrderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreviewFlashSwapOrderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreateFlashSwapMultiCurrencyManyToOneOrderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreviewFlashSwapMultiCurrencyManyToOneOrderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreateFlashSwapOrderV1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreateFlashSwapMultiCurrencyOneToManyOrderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreviewFlashSwapMultiCurrencyOneToManyOrderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreviewFlashSwapOrderV1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilistFuturesContractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApigetFuturesContractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilistFuturesOrderBookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilistFuturesTradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilistFuturesCandlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilistFuturesPremiumIndexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilistFuturesTickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilistFuturesFundingRateHistoryGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilistBatchFuturesFundingRatesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilistFuturesInsuranceLedgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilistContractStatsGET /futures/{settle}/contract_statsFutures statistics
FuturesApigetIndexConstituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilistLiquidatedOrdersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilistFuturesRiskLimitTiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilistFuturesAccountsGET /futures/{settle}/accountsGet futures account
FuturesApilistFuturesAccountBookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilistPositionsGET /futures/{settle}/positionsGet user position list
FuturesApilistPositionsTimerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApigetPositionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApigetLeverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdatePositionMarginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdatePositionLeveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdateContractPositionLeveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdatePositionCrossModePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdateDualCompPositionCrossModePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdatePositionRiskLimitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApisetDualModePOST /futures/{settle}/dual_modeSet position mode
FuturesApisetPositionModePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApigetDualModePositionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdateDualModePositionMarginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdateDualModePositionLeveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdateDualModePositionRiskLimitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilistFuturesOrdersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreateFuturesOrderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancelFuturesOrdersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApigetOrdersWithTimeRangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreateBatchFuturesOrderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApigetFuturesOrderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamendFuturesOrderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancelFuturesOrderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApigetMyTradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApigetMyTradesWithTimeRangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilistPositionCloseGET /futures/{settle}/position_closeQuery position close history
FuturesApilistLiquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilistAutoDeleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdownCancelAllFuturesPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApigetFuturesFeeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancelBatchFutureOrdersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamendBatchFutureOrdersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApigetFuturesRiskLimitTableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreateFuturesBBOOrderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreateTrailOrderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistopTrailOrderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistopAllTrailOrdersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApigetTrailOrdersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApigetTrailOrderDetailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdateTrailOrderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApigetTrailOrderChangeLogGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApilistPriceTriggeredOrdersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreatePriceTriggeredOrderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancelPriceTriggeredOrderListDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApigetPriceTriggeredOrderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancelPriceTriggeredOrderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdatePriceTriggeredOrderPUT /futures/{settle}/price_orders/amend/{order_id}Modify a Single Auto Order
LaunchApilistLaunchPoolProjectsGET /launch/project-listQuery LaunchPool project list
LaunchApicreateLaunchPoolOrderPOST /launch/create-orderCreate LaunchPool staking order
LaunchApiredeemLaunchPoolPOST /launch/redeemRedeem LaunchPool staked assets
LaunchApilistLaunchPoolPledgeRecordsGET /launch/user-pledge-recordsQuery user pledge records
LaunchApilistLaunchPoolRewardRecordsGET /launch/get-user-reward-recordsQuery user reward records
LaunchApigetHodlerAirdropProjectListGET /launch/hodler-airdrop/project-list查询HODLer Airdrop活动列表
LaunchApihodlerAirdropOrderPOST /launch/hodler-airdrop/order参与HODLer Airdrop活动
LaunchApigetHodlerAirdropUserOrderRecordsGET /launch/hodler-airdrop/user-order-records查询HODLer Airdrop参与记录
LaunchApigetHodlerAirdropUserAirdropRecordsGET /launch/hodler-airdrop/user-airdrop-records查询HODLer Airdrop空投记录
LaunchApigetCandyDropActivityListV4GET /launch/candydrop/activity-list查询活动列表
LaunchApiregisterCandyDropV4POST /launch/candydrop/register报名参与活动
LaunchApigetCandyDropActivityRulesV4GET /launch/candydrop/activity-rules查询活动规则
LaunchApigetCandyDropTaskProgressV4GET /launch/candydrop/task-progress查询任务完成进度
LaunchApigetCandyDropParticipationRecordsV4GET /launch/candydrop/participation-records查询参与记录
LaunchApigetCandyDropAirdropRecordsV4GET /launch/candydrop/airdrop-records查询空投记录
MarginApilistMarginAccountsGET /margin/accountsMargin account list
MarginApilistMarginAccountBookGET /margin/account_bookQuery margin account balance change history
MarginApilistFundingAccountsGET /margin/funding_accountsFunding account list
MarginApigetAutoRepayStatusGET /margin/auto_repayQuery user auto repayment settings
MarginApisetAutoRepayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApigetMarginTransferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApigetUserMarginTierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApigetMarketMarginTierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApisetUserMarketLeveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilistMarginUserAccountGET /margin/user/accountQuery user's isolated margin account list
MarginApilistCrossMarginLoansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilistCrossMarginRepaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MarginUniApilistUniCurrencyPairsGET /margin/uni/currency_pairsList lending markets
MarginUniApigetUniCurrencyPairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApigetMarginUniEstimateRateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilistUniLoansGET /margin/uni/loansQuery loans
MarginUniApicreateUniLoanPOST /margin/uni/loansBorrow or repay
MarginUniApilistUniLoanRecordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilistUniLoanInterestRecordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApigetUniBorrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
MultiCollateralLoanApilistMultiCollateralOrdersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreateMultiCollateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApigetMultiCollateralOrderDetailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilistMultiRepayRecordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepayMultiCollateralLoanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilistMultiCollateralRecordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperateMultiCollateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilistUserCurrencyQuotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilistMultiCollateralCurrenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApigetMultiCollateralLtvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApigetMultiCollateralFixRateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApigetMultiCollateralCurrentRateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OTCApicreateOtcQuotePOST /otc/quoteFiat and stablecoin quote
OTCApicreateOtcOrderPOST /otc/order/createCreate fiat order
OTCApicreateStableCoinOrderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApigetUserDefaultBankGET /otc/get_user_def_bankGet user's default bank account information
OTCApigetBankListGET /otc/bank_listGet user bank card list
OTCApimarkOtcOrderPaidPOST /otc/order/paidMark fiat order as paid
OTCApicancelOtcOrderPOST /otc/order/cancelFiat order cancellation
OTCApilistOtcOrdersGET /otc/order/listFiat order list
OTCApilistStableCoinOrdersGET /otc/stable_coin/order/listStablecoin order list
OTCApigetOtcOrderDetailGET /otc/order/detailFiat order details
OptionsApilistOptionsUnderlyingsGET /options/underlyingsList all underlying assets
OptionsApilistOptionsExpirationsGET /options/expirationsList all expiration dates
OptionsApilistOptionsContractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApigetOptionsContractGET /options/contracts/{contract}Query specified contract details
OptionsApilistOptionsSettlementsGET /options/settlementsList settlement history
OptionsApigetOptionsSettlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilistMyOptionsSettlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilistOptionsOrderBookGET /options/order_bookQuery options contract order book
OptionsApilistOptionsTickersGET /options/tickersQuery options market ticker information
OptionsApilistOptionsUnderlyingTickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilistOptionsCandlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilistOptionsUnderlyingCandlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilistOptionsTradesGET /options/tradesMarket trade records
OptionsApilistOptionsAccountGET /options/accountsQuery account information
OptionsApilistOptionsAccountBookGET /options/account_bookQuery account change history
OptionsApilistOptionsPositionsGET /options/positionsList user's positions of specified underlying
OptionsApigetOptionsPositionGET /options/positions/{contract}Get specified contract position
OptionsApilistOptionsPositionCloseGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilistOptionsOrdersGET /options/ordersList options orders
OptionsApicreateOptionsOrderPOST /options/ordersCreate an options order
OptionsApicancelOptionsOrdersDELETE /options/ordersCancel all orders with 'open' status
OptionsApigetOptionsOrderGET /options/orders/{order_id}Query single order details
OptionsApiamendOptionsOrderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancelOptionsOrderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdownCancelAllOptionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilistMyOptionsTradesGET /options/my_tradesQuery personal trading records
OptionsApigetOptionsMMPGET /options/mmpMMP Query.
OptionsApisetOptionsMMPPOST /options/mmpMMP Settings
OptionsApiresetOptionsMMPPOST /options/mmp/resetMMP Reset
P2pApip2pMerchantAccountGetUserInfoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2pMerchantAccountGetCounterpartyUserInfoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2pMerchantAccountGetMyselfPaymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2pMerchantTransactionGetPendingTransactionListPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2pMerchantTransactionGetCompletedTransactionListPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2pMerchantTransactionGetTransactionDetailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2pMerchantTransactionConfirmPaymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2pMerchantTransactionConfirmReceiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2pMerchantTransactionCancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2pMerchantBooksPlaceBizPushOrderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2pMerchantBooksAdsUpdateStatusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2pMerchantBooksAdsDetailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2pMerchantBooksMyAdsListPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2pMerchantBooksAdsListPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2pMerchantChatGetChatsListPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2pMerchantChatSendChatMessagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2pMerchantChatUploadChatFilePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagencyTransactionHistoryGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagencyCommissionsHistoryGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartnerTransactionHistoryGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartnerCommissionsHistoryGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartnerSubListGET /rebate/partner/sub_listPartner subordinate list
RebateApirebateBrokerCommissionHistoryGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebateBrokerTransactionHistoryGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebateUserInfoGET /rebate/user/infoUser obtains rebate information
RebateApiuserSubRelationGET /rebate/user/sub_relationUser subordinate relationship
RebateApigetPartnerApplicationRecentGET /rebate/partner/applications/recentGet recent partner application records
RebateApigetPartnerEligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApigetPartnerAgentDataAggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilistCurrenciesGET /spot/currenciesQuery all currency information
SpotApigetCurrencyGET /spot/currencies/{currency}Query single currency information
SpotApilistCurrencyPairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApigetCurrencyPairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilistTickersGET /spot/tickersGet currency pair ticker information
SpotApilistOrderBookGET /spot/order_bookGet market depth information
SpotApilistTradesGET /spot/tradesQuery market transaction records
SpotApilistCandlesticksGET /spot/candlesticksMarket K-line chart
SpotApigetFeeGET /spot/feeQuery account fee rates
SpotApigetBatchSpotFeeGET /spot/batch_feeBatch query account fee rates
SpotApilistSpotAccountsGET /spot/accountsList spot trading accounts
SpotApilistSpotAccountBookGET /spot/account_bookQuery spot account transaction history
SpotApicreateBatchOrdersPOST /spot/batch_ordersBatch place orders
SpotApilistAllOpenOrdersGET /spot/open_ordersList all open orders
SpotApicreateCrossLiquidateOrderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilistOrdersGET /spot/ordersList orders
SpotApicreateOrderPOST /spot/ordersCreate an order
SpotApicancelOrdersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancelBatchOrdersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApigetOrderGET /spot/orders/{order_id}Query single order details
SpotApicancelOrderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamendOrderPATCH /spot/orders/{order_id}Amend single order
SpotApilistMyTradesGET /spot/my_tradesQuery personal trading records
SpotApigetSystemTimeGET /spot/timeGet server current time
SpotApicountdownCancelAllSpotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamendBatchOrdersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApigetSpotInsuranceHistoryGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilistSpotPriceTriggeredOrdersGET /spot/price_ordersQuery running auto order list
SpotApicreateSpotPriceTriggeredOrderPOST /spot/price_ordersCreate price-triggered order
SpotApicancelSpotPriceTriggeredOrderListDELETE /spot/price_ordersCancel all auto orders
SpotApigetSpotPriceTriggeredOrderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancelSpotPriceTriggeredOrderDELETE /spot/price_orders/{order_id}Cancel single auto order
SquareApilistSquareAiSearchGET /social/message/searchAI MCP Dynamic Search
SquareApilistLiveReplayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
SubAccountApilistSubAccountsGET /sub_accountsList sub-accounts
SubAccountApicreateSubAccountsPOST /sub_accountsCreate a new sub-account
SubAccountApigetSubAccountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilistSubAccountKeysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreateSubAccountKeysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApigetSubAccountKeyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdateSubAccountKeysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApideleteSubAccountKeysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilockSubAccountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlockSubAccountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilistUnifiedModeGET /sub_accounts/unified_modeGet sub-account mode
TradFiApiqueryMt5AccountInfoGET /tradfi/users/mt5-accountQuery MT5 account information
TradFiApiqueryCategoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
TradFiApiquerySymbolsGET /tradfi/symbolsQuery trading symbol list
TradFiApiquerySymbolDetailGET /tradfi/symbols/detailQuery trading symbol details
TradFiApiquerySymbolKlineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
TradFiApiquerySymbolTickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
TradFiApicreateTradFiUserPOST /tradfi/usersCreate TradFi user
TradFiApiqueryUserAssetsGET /tradfi/users/assetsQuery account assets
TradFiApiqueryTransactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
TradFiApicreateTransactionPOST /tradfi/transactionsFund Deposit and Withdrawal
TradFiApiqueryOrderListGET /tradfi/ordersQuery active order list
TradFiApicreateTradFiOrderPOST /tradfi/ordersCreate an order
TradFiApiupdateOrderPUT /tradfi/orders/{order_id}Modify order
TradFiApideleteOrderDELETE /tradfi/orders/{order_id}Cancel order
TradFiApiqueryOrderHistoryListGET /tradfi/orders/historyQuery historical order list
TradFiApiqueryPositionListGET /tradfi/positionsQuery active position list
TradFiApiupdatePositionPUT /tradfi/positions/{position_id}Modify position
TradFiApiclosePositionPOST /tradfi/positions/{position_id}/closeClose position
TradFiApiqueryPositionHistoryListGET /tradfi/positions/historyQuery historical position list
UnifiedApilistUnifiedAccountsGET /unified/accountsGet unified account information
UnifiedApigetUnifiedBorrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApigetUnifiedTransferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApigetUnifiedTransferablesGET /unified/transferablesBatch query maximum transferable amount for unified accounts. Each currency shows the maximum value. After user withdrawal, the transferable amount for all currencies will change
UnifiedApigetUnifiedBorrowableListGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilistUnifiedLoansGET /unified/loansQuery loans
UnifiedApicreateUnifiedLoanPOST /unified/loansBorrow or repay
UnifiedApilistUnifiedLoanRecordsGET /unified/loan_recordsQuery loan records
UnifiedApilistUnifiedLoanInterestRecordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApigetUnifiedRiskUnitsGET /unified/risk_unitsGet user risk unit details
UnifiedApigetUnifiedModeGET /unified/unified_modeQuery mode of the unified account
UnifiedApisetUnifiedModePUT /unified/unified_modeSet unified account mode
UnifiedApigetUnifiedEstimateRateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilistCurrencyDiscountTiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilistLoanMarginTiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculatePortfolioMarginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApigetUserLeverageCurrencyConfigGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApigetUserLeverageCurrencySettingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApisetUserLeverageCurrencySettingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilistUnifiedCurrenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApigetHistoryLoanRateGET /unified/history_loan_rateGet historical lending rates
UnifiedApisetUnifiedCollateralPOST /unified/collateral_currenciesSet collateral currency
WalletApilistCurrencyChainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApigetDepositAddressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilistWithdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilistDepositsGET /wallet/depositsGet deposit records
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilistSubAccountTransfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransferWithSubAccountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisubAccountToSubAccountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApigetTransferOrderStatusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilistWithdrawStatusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilistSubAccountBalancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilistSubAccountMarginBalancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilistSubAccountFuturesBalancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilistSubAccountCrossMarginBalancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilistSavedAddressGET /wallet/saved_addressQuery withdrawal address whitelist
WalletApigetTradeFeeGET /wallet/feeQuery personal trading fees
WalletApigetTotalBalanceGET /wallet/total_balanceQuery personal account totals
WalletApilistSmallBalanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvertSmallBalancePOST /wallet/small_balanceConvert small balance currency
WalletApilistSmallBalanceHistoryGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilistPushOrdersGET /wallet/pushGet UID transfer history
WalletApigetLowCapExchangeListGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApigetUserIdentityGET /rewards/getUserIdentityGet user identity
WelfareApigetBeginnerTaskListGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaimTaskPOST /rewards/claimTask领取任务
WelfareApiclaimRewardPOST /rewards/claimReward领取任务奖励
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdrawPushOrderPOST /withdrawals/pushUID transfer
WithdrawalApicancelWithdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiv4

  • Type: Gate APIv4

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

FAQs

Package last updated on 16 Apr 2026

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts