Skip to content

Repository files navigation

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 Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.129
  • Package version: 7.2.129
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gate.com/page/contacts

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly using:

pip install --user gate-api

Then import the package:

importgate_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgate_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.ActivityApi(api_client)
try:
# My activity entryapi_response=api_instance.get_my_activity_entry()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling ActivityApi->get_my_activity_entry: %s\n"%e)

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ActivityApiget_my_activity_entryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilist_activitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilist_activity_typesGET /rewards/activity/activity-typeActivity type list
CFDApiquery_mt5_account_infoGET /tradfi/users/mt5-accountQuery MT5 account information
CFDApiquery_categoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
CFDApiquery_symbol_commissionsGET /tradfi/symbols/commissionsQuery symbol commission rates
CFDApiquery_symbolsGET /tradfi/symbolsQuery trading symbol list
CFDApiquery_symbol_detailGET /tradfi/symbols/detailQuery trading symbol details
CFDApiquery_symbol_klineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
CFDApiquery_symbol_tickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
CFDApicreate_trad_fi_userPOST /tradfi/usersCreate CFD user
CFDApiquery_user_assetsGET /tradfi/users/assetsQuery account assets
CFDApiquery_transactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
CFDApicreate_transactionPOST /tradfi/transactionsFund transfer
CFDApiquery_order_listGET /tradfi/ordersQuery active order list
CFDApicreate_trad_fi_orderPOST /tradfi/ordersCreate order
CFDApiupdate_orderPUT /tradfi/orders/{order_id}Modify order
CFDApidelete_orderDELETE /tradfi/orders/{order_id}Cancel order
CFDApiquery_order_history_listGET /tradfi/orders/historyQuery historical order list
CFDApiquery_order_logGET /tradfi/orders/log/{log_id}Get order details by log ID
CFDApiquery_position_listGET /tradfi/positionsQuery active position list
CFDApiupdate_positionPUT /tradfi/positions/{position_id}Modify position
CFDApiclose_positionPOST /tradfi/positions/{position_id}/closeClose position
CFDApiquery_position_history_listGET /tradfi/positions/historyQuery historical position list
CrossExApilist_crossex_rule_symbolsGET /crossex/rule/symbolsQuery symbol information
CrossExApilist_crossex_rule_risk_limitsGET /crossex/rule/risk_limitsQuery risk limit information
CrossExApilist_crossex_transfer_coinsGET /crossex/transfers/coinQuery supported transfer currencies
CrossExApilist_crossex_transfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreate_crossex_transferPOST /crossex/transfersFund Transfer
CrossExApicreate_crossex_orderPOST /crossex/ordersCreate order
CrossExApicancel_batch_crossex_ordersPOST /crossex/batch_cancel_ordersBatch cancel orders
CrossExApiget_crossex_orderGET /crossex/orders/{order_id}Query order details
CrossExApiupdate_crossex_orderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancel_crossex_orderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreate_crossex_convert_quotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreate_crossex_convert_orderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApiget_crossex_accountGET /crossex/accountsQuery Account Assets
CrossExApiupdate_crossex_accountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApiget_crossex_positions_leverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_positions_leveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApiget_crossex_margin_positions_leverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_margin_positions_leveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApiclose_crossex_positionPOST /crossex/positionFull Close Position
CrossExApiget_crossex_positions_margin_modeGET /crossex/positions/margin_modeGet futures position margin mode
CrossExApiupdate_crossex_positions_margin_modePOST /crossex/positions/margin_modeUpdate futures position margin mode
CrossExApiupdate_crossex_positions_marginPOST /crossex/positions/marginIncrease or decrease isolated margin
CrossExApiget_crossex_interest_rateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApiget_crossex_feeGET /crossex/feeQuery User Fee Rates
CrossExApilist_crossex_positionsGET /crossex/positionsQuery Contract Positions
CrossExApilist_crossex_margin_positionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilist_crossex_adl_rankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilist_crossex_open_ordersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilist_crossex_history_ordersGET /crossex/history_ordersQuery order history
CrossExApilist_crossex_history_positionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilist_crossex_history_margin_positionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilist_crossex_history_margin_interestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilist_crossex_history_tradesGET /crossex/history_tradesQuery filled history
CrossExApilist_crossex_account_bookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilist_crossex_coin_discount_rateGET /crossex/coin_discount_rateQuery Currency Discount Rate
CrossExApilist_crossex_market_tickersGET /crossex/market/tickersGet exchange tickers
CrossExApilist_crossex_market_funding_infoGET /crossex/market/funding_infoGet exchange futures funding rate information
EarnUniApilist_uni_currenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApiget_uni_currencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilist_user_uni_lendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreate_uni_lendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichange_uni_lendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilist_uni_lend_recordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApiget_uni_interestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilist_uni_interest_recordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApiget_uni_interest_statusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilist_uni_chartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilist_uni_rateGET /earn/uni/rateCurrency estimated annualized interest rate
MarginUniApilist_uni_currency_pairsGET /margin/uni/currency_pairsList lending markets
MarginUniApiget_uni_currency_pairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApiget_margin_uni_estimate_rateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilist_uni_loansGET /margin/uni/loansQuery loans
MarginUniApicreate_uni_loanPOST /margin/uni/loansBorrow or repay
MarginUniApilist_uni_loan_recordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilist_uni_loan_interest_recordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApiget_uni_borrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
OTCApicreate_otc_quotePOST /otc/quoteFiat and stablecoin quote
OTCApicreate_otc_orderPOST /otc/order/createCreate fiat order
OTCApicreate_stable_coin_orderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApiget_bank_list_inner_pathGET /otc/bank/listGet user bank card list
OTCApicreate_otc_bankPOST /otc/bank/createCreate bank card
OTCApidelete_otc_bankPOST /otc/bank/deleteDelete bank card
OTCApiset_default_otc_bankPOST /otc/bank/set_defaultSet default bank card
OTCApiget_otc_bank_supplement_checklistGET /otc/bank/bank_supplement_checklistQuery the checklist of materials to supplement for a bank card
OTCApisubmit_otc_bank_personal_supplementPOST /otc/bank/personal/bank_supplementSubmit Bank Card Supplement Materials (Personal)
OTCApisubmit_otc_bank_enterprise_supplementPOST /otc/bank/enterprise/bank_supplementSubmit Bank Card Supplement Materials (Enterprise)
OTCApimark_otc_order_paidPOST /otc/order/paidMark fiat order as paid (deposit confirmation)
OTCApicancel_otc_orderPOST /otc/order/cancelFiat order cancellation
OTCApilist_otc_ordersGET /otc/order/listFiat order list
OTCApilist_stable_coin_ordersGET /otc/stable_coin/order/listStablecoin order list
OTCApiget_otc_order_detailGET /otc/order/detailFiat order details
StockApiquery_stock_user_assetsGET /stock/users/assetsQuery user assets
StockApiquery_stock_symbolsGET /stock/symbolsQuery symbol list
StockApiquery_stock_symbol_detailGET /stock/symbols/detailQuery symbol details
StockApiquery_stock_order_bookGET /stock/market/{symbol}/orderbookQuery market order book
StockApiquery_stock_order_listGET /stock/ordersQuery open order list
StockApicreate_stock_orderPOST /stock/ordersCreate order
StockApidelete_all_stock_ordersDELETE /stock/ordersCancel all open orders
StockApiquery_stock_order_historyGET /stock/orders/historyQuery historical order list
StockApiupdate_stock_orderPUT /stock/orders/{order_id}Modify order
StockApidelete_stock_orderDELETE /stock/orders/{order_id}Cancel order
StockApiquery_stock_positionsGET /stock/positionsQuery current position list
StockApiclose_stock_positionPOST /stock/positions/closeClose position
StockApiquery_stock_transactionsGET /stock/transactionsQuery transaction records
StockApicreate_stock_transactionPOST /stock/transactionsFund transfer
StockApiquery_stock_exchangesGET /stock/exchangesQuery supported exchanges
StockApiquery_stock_fee_rateGET /stock/fee-rateQuery fee rates for Japanese and Korean stocks
SubAccountApilist_sub_accountsGET /sub_accountsList sub-accounts
SubAccountApicreate_sub_accountsPOST /sub_accountsCreate a new sub-account
SubAccountApiget_sub_accountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilist_sub_account_keysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreate_sub_account_keysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApiget_sub_account_keyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdate_sub_account_keysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApidelete_sub_account_keysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilock_sub_accountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlock_sub_accountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilist_unified_modeGET /sub_accounts/unified_modeGet sub-account mode
UnifiedApilist_unified_accountsGET /unified/accountsGet unified account information
UnifiedApiget_unified_borrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApiget_unified_transferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApiget_unified_transferablesGET /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
UnifiedApiget_unified_borrowable_listGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilist_unified_loansGET /unified/loansQuery loans
UnifiedApicreate_unified_loanPOST /unified/loansBorrow or repay
UnifiedApilist_unified_loan_recordsGET /unified/loan_recordsQuery loan records
UnifiedApilist_unified_loan_interest_recordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApiget_unified_risk_unitsGET /unified/risk_unitsGet user risk unit details
UnifiedApiget_unified_modeGET /unified/unified_modeQuery mode of the unified account
UnifiedApiset_unified_modePUT /unified/unified_modeSet unified account mode
UnifiedApiget_unified_estimate_rateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilist_currency_discount_tiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilist_loan_margin_tiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculate_portfolio_marginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApiset_user_leveragePOST /unified/leverage/user_settingSet leverage for all of the user's borrowed currencies
UnifiedApiget_user_leverage_currency_configGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApiget_user_leverage_currency_settingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApiset_user_leverage_currency_settingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilist_unified_currenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApiget_history_loan_rateGET /unified/history_loan_rateGet historical lending rates
UnifiedApiset_unified_collateralPOST /unified/collateral_currenciesSet collateral currency
UnifiedApiget_estimated_quick_repaymentGET /unified/estimated_quick_repaymentEstimated quick repayment details
UnifiedApicreate_quick_repaymentPOST /unified/quick_repaymentQuick repayment
UnifiedApiget_unified_delta_neutralGET /unified/delta_neutralQuery the account Delta-neutral strategy mode setting
UnifiedApiset_unified_delta_neutralPOST /unified/delta_neutralSet the account Delta-neutral strategy mode
AccountApiget_account_detailGET /account/detailRetrieve user account information
AccountApiget_account_main_keysGET /account/main_keysQuery All Main Account Key Information
AccountApiget_account_rate_limitGET /account/rate_limitGet user transaction rate limit information
AccountApilist_stp_groupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreate_stp_groupPOST /account/stp_groupsCreate STP user group
AccountApilist_stp_groups_usersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiadd_stp_group_usersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApidelete_stp_group_usersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApiget_debit_feeGET /account/debit_feeQuery GT fee deduction configuration
AccountApiset_debit_feePOST /account/debit_feeConfigure GT fee deduction
AlphaApilist_alpha_accountsGET /alpha/accountsAlpha Account API
AlphaApilist_alpha_account_bookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquote_alpha_orderPOST /alpha/quoteAlpha Quote API
AlphaApilist_alpha_orderGET /alpha/ordersAlpha Order List API
AlphaApiplace_alpha_orderPOST /alpha/ordersAlpha Order API
AlphaApiget_alpha_orderGET /alpha/orderAlpha Single Order Query API
AlphaApilist_alpha_currenciesGET /alpha/currenciesQuery currency information
AlphaApilist_alpha_tickersGET /alpha/tickersQuery currency ticker
AlphaApilist_alpha_tokensGET /alpha/tokensQuery Token Information
AssetswapApilist_asset_swap_assetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApiget_asset_swap_configGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluate_asset_swapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreate_asset_swap_order_v1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilist_asset_swap_orders_v1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreview_asset_swap_order_v1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApiget_asset_swap_order_v1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApiget_ai_hub_strategy_recommendGET /bot/strategy/recommendGet AIHub strategy recommendations
BotApipost_ai_hub_spot_grid_createPOST /bot/spot-grid/createCreate spot grid
BotApipost_ai_hub_margin_grid_createPOST /bot/margin-grid/createCreate a lever grid
BotApipost_ai_hub_infinite_grid_createPOST /bot/infinite-grid/createCreate infinite grid
BotApipost_ai_hub_futures_grid_createPOST /bot/futures-grid/createCreate a contract grid
BotApipost_ai_hub_spot_martingale_createPOST /bot/spot-martingale/createCreate Spot Martin
BotApipost_ai_hub_contract_martingale_createPOST /bot/contract-martingale/createCreate contract martin
BotApiget_ai_hub_portfolio_runningGET /bot/portfolio/runningQuery the list of running policies
BotApiget_ai_hub_portfolio_detailGET /bot/portfolio/detailQuery order policy details
BotApipost_ai_hub_portfolio_stopPOST /bot/portfolio/stopTerminate a single running policy
CouponApilist_user_couponsGET /coupon/user-coupon-listCoupon Center list
CouponApiget_user_coupon_detailGET /coupon/user-coupon-detailCoupon Center details
DeliveryApilist_delivery_contractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApiget_delivery_contractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilist_delivery_order_bookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilist_delivery_tradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilist_delivery_candlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilist_delivery_tickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilist_delivery_insurance_ledgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilist_delivery_accountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilist_delivery_account_bookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilist_delivery_positionsGET /delivery/{settle}/positionsGet user position list
DeliveryApiget_delivery_positionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdate_delivery_position_marginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdate_delivery_position_leveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdate_delivery_position_risk_limitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilist_delivery_ordersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreate_delivery_orderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancel_delivery_ordersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApiget_delivery_orderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancel_delivery_orderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApiget_my_delivery_tradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilist_delivery_position_closeGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilist_delivery_liquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilist_delivery_settlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilist_delivery_risk_limit_tiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilist_price_triggered_delivery_ordersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreate_price_triggered_delivery_orderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancel_price_triggered_delivery_order_listDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApiget_price_triggered_delivery_orderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancel_price_triggered_delivery_orderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilist_dual_investment_plansGET /earn/dual/investment_planDual Investment product list
EarnApilist_dual_ordersGET /earn/dual/ordersDual Investment order list
EarnApiplace_dual_orderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilist_dual_balanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApiget_dual_order_refund_previewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplace_dual_order_refundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodify_dual_order_reinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApiget_dual_project_recommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifind_coinGET /earn/staking/coinsStaking coins
EarnApiswap_staking_coinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorder_listGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiaward_listGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiasset_listGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreate_auto_invest_planPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdate_auto_invest_planPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistop_auto_invest_planPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiadd_position_auto_invest_planPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilist_auto_invest_coinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApiget_auto_invest_min_amountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilist_auto_invest_plan_recordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilist_auto_invest_ordersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilist_auto_invest_configGET /earn/autoinvest/configList investment currency configuration
EarnApiget_auto_invest_plan_detailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilist_auto_invest_plansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilist_earn_fixed_term_productsGET /earn/fixed-term/productGet product list
EarnApilist_earn_fixed_term_products_by_assetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilist_earn_fixed_term_lendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreate_earn_fixed_term_lendPOST /earn/fixed-term/user/lendSubscription
EarnApicreate_earn_fixed_term_pre_redeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilist_earn_fixed_term_historyGET /earn/fixed-term/user/historySubscription history
FlashSwapApilist_flash_swap_currency_pairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilist_flash_swap_ordersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreate_flash_swap_orderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApiget_flash_swap_orderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreview_flash_swap_orderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreate_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreview_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreate_flash_swap_order_v1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreate_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreview_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreview_flash_swap_order_v1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilist_futures_contractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApilist_futures_contracts_allGET /futures/{settle}/contracts_allQuery all contract information (including delisted)
FuturesApiget_futures_contractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilist_futures_adl_risk_statesGET /futures/{settle}/adl_risk_statesList market-level ADL risk states
FuturesApilist_futures_order_bookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilist_futures_tradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilist_futures_candlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilist_futures_premium_indexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilist_futures_tickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilist_futures_funding_rate_historyGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilist_batch_futures_funding_ratesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilist_futures_insurance_ledgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilist_contract_statsGET /futures/{settle}/contract_statsFutures statistics
FuturesApiget_index_constituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilist_liquidated_ordersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilist_futures_risk_limit_tiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilist_futures_accountsGET /futures/{settle}/accountsGet futures account
FuturesApilist_futures_account_bookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilist_positionsGET /futures/{settle}/positionsGet user position list
FuturesApilist_positions_timerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApiget_positionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApiget_leverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdate_position_marginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdate_position_leveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdate_contract_position_leveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdate_position_cross_modePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdate_dual_comp_position_cross_modePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdate_position_risk_limitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApiset_dual_modePOST /futures/{settle}/dual_modeSet position mode
FuturesApiset_position_modePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApiget_dual_mode_positionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdate_dual_mode_position_marginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdate_dual_mode_position_leveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdate_dual_mode_position_risk_limitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilist_futures_ordersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreate_futures_orderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancel_futures_ordersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApiget_orders_with_time_rangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreate_batch_futures_orderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApiget_futures_orderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamend_futures_orderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancel_futures_orderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApiget_my_tradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApiget_my_trades_with_time_rangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilist_position_closeGET /futures/{settle}/position_closeQuery position close history
FuturesApilist_liquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilist_auto_deleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdown_cancel_all_futuresPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApiget_futures_feeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancel_batch_future_ordersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamend_batch_future_ordersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApiget_futures_risk_limit_tableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreate_futures_bbo_orderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistop_trail_orderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistop_all_trail_ordersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApiget_trail_ordersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApiget_trail_order_detailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApiget_trail_order_change_logGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApicreate_chase_orderPOST /futures/{settle}/autoorder/v1/chase/createCreate a chase order
FuturesApistop_chase_orderPOST /futures/{settle}/autoorder/v1/chase/stopStop a chase order
FuturesApistop_all_chase_ordersPOST /futures/{settle}/autoorder/v1/chase/stop_allStop chase orders in batch
FuturesApiget_chase_ordersGET /futures/{settle}/autoorder/v1/chase/listList chase orders
FuturesApiget_chase_order_detailGET /futures/{settle}/autoorder/v1/chase/detailGet chase order detail
FuturesApilist_price_triggered_ordersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreate_price_triggered_orderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancel_price_triggered_order_listDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApiget_price_triggered_orderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancel_price_triggered_orderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdate_price_triggered_orderPUT /futures/{settle}/price_orders/amendModify a Single Auto Order
MarginApilist_margin_accountsGET /margin/accountsMargin account list
MarginApilist_margin_account_bookGET /margin/account_bookQuery margin account balance change history
MarginApilist_funding_accountsGET /margin/funding_accountsFunding account list
MarginApiget_auto_repay_statusGET /margin/auto_repayQuery user auto repayment settings
MarginApiset_auto_repayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApiget_margin_transferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApiget_user_margin_tierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApiget_market_margin_tierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApiset_user_market_leveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilist_margin_user_accountGET /margin/user/accountQuery user's isolated margin account list
MarginApilist_cross_margin_loansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilist_cross_margin_repaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MultiCollateralLoanApilist_multi_collateral_ordersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreate_multi_collateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApiget_multi_collateral_order_detailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilist_multi_repay_recordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepay_multi_collateral_loanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilist_multi_collateral_recordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperate_multi_collateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilist_user_currency_quotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilist_multi_collateral_currenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApiget_multi_collateral_ltvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApiget_multi_collateral_fix_rateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApiget_multi_collateral_current_rateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OptionsApilist_options_underlyingsGET /options/underlyingsList all underlying assets
OptionsApilist_options_expirationsGET /options/expirationsList all expiration dates
OptionsApilist_options_contractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApiget_options_contractGET /options/contracts/{contract}Query specified contract details
OptionsApilist_options_settlementsGET /options/settlementsList settlement history
OptionsApiget_options_settlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilist_my_options_settlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilist_options_order_bookGET /options/order_bookQuery options contract order book
OptionsApilist_options_tickersGET /options/tickersQuery options market ticker information
OptionsApilist_options_underlying_tickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilist_options_candlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilist_options_underlying_candlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilist_options_tradesGET /options/tradesMarket trade records
OptionsApilist_options_accountGET /options/accountsQuery account information
OptionsApilist_options_account_bookGET /options/account_bookQuery account change history
OptionsApilist_options_positionsGET /options/positionsList user's positions of specified underlying
OptionsApiget_options_positionGET /options/positions/{contract}Get specified contract position
OptionsApilist_options_position_closeGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilist_options_ordersGET /options/ordersList options orders
OptionsApicreate_options_orderPOST /options/ordersCreate an options order
OptionsApicancel_options_ordersDELETE /options/ordersCancel all orders with 'open' status
OptionsApiget_options_orderGET /options/orders/{order_id}Query single order details
OptionsApiamend_options_orderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancel_options_orderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdown_cancel_all_optionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilist_my_options_tradesGET /options/my_tradesQuery personal trading records
OptionsApiget_options_mmpGET /options/mmpMMP Query.
OptionsApiset_options_mmpPOST /options/mmpMMP Settings
OptionsApireset_options_mmpPOST /options/mmp/resetMMP Reset
P2pApip2p_merchant_account_get_user_infoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2p_merchant_account_get_counterparty_user_infoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2p_merchant_account_get_myself_paymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2p_merchant_account_set_merchant_work_hoursPOST /p2p/merchant/account/set_merchant_work_hoursSet merchant working status and custom working hours
P2pApip2p_merchant_transaction_get_pending_transaction_listPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2p_merchant_transaction_get_completed_transaction_listPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2p_merchant_transaction_get_transaction_detailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2p_merchant_transaction_confirm_paymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2p_merchant_transaction_confirm_receiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2p_merchant_transaction_cancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2p_merchant_books_place_biz_push_orderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2p_merchant_books_ads_update_statusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2p_merchant_books_ads_detailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2p_merchant_books_my_ads_listPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2p_merchant_books_ads_listPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2p_merchant_chat_get_chats_listPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2p_merchant_chat_send_chat_messagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2p_merchant_chat_upload_chat_filePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagency_transaction_historyGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagency_commissions_historyGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartner_transaction_historyGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartner_commissions_historyGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartner_sub_listGET /rebate/partner/sub_listPartner subordinate list
RebateApirebate_broker_commission_historyGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebate_broker_transaction_historyGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebate_user_infoGET /rebate/user/infoUser obtains rebate information
RebateApiuser_sub_relationGET /rebate/user/sub_relationUser subordinate relationship
RebateApiget_partner_application_recentGET /rebate/partner/applications/recentGet recent partner application records
RebateApiget_partner_eligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApiget_partner_agent_data_aggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilist_currenciesGET /spot/currenciesQuery all currency information
SpotApiget_currencyGET /spot/currencies/{currency}Query single currency information
SpotApilist_currency_pairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApiget_currency_pairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilist_tickersGET /spot/tickersGet currency pair ticker information
SpotApilist_order_bookGET /spot/order_bookGet market depth information
SpotApilist_tradesGET /spot/tradesQuery market transaction records
SpotApilist_candlesticksGET /spot/candlesticksMarket K-line chart
SpotApiget_feeGET /spot/feeQuery account fee rates
SpotApiget_batch_spot_feeGET /spot/batch_feeBatch query account fee rates
SpotApilist_spot_accountsGET /spot/accountsList spot trading accounts
SpotApilist_spot_account_bookGET /spot/account_bookQuery spot account transaction history
SpotApicreate_batch_ordersPOST /spot/batch_ordersBatch place orders
SpotApilist_all_open_ordersGET /spot/open_ordersList all open orders
SpotApicreate_cross_liquidate_orderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilist_ordersGET /spot/ordersList orders
SpotApicreate_orderPOST /spot/ordersCreate order
SpotApicancel_ordersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancel_batch_ordersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApiget_orderGET /spot/orders/{order_id}Query single order details
SpotApicancel_orderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamend_orderPATCH /spot/orders/{order_id}Amend single order
SpotApilist_my_tradesGET /spot/my_tradesQuery personal trading records
SpotApiget_system_timeGET /spot/timeGet server current time
SpotApicountdown_cancel_all_spotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamend_batch_ordersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApiget_spot_insurance_historyGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilist_spot_price_triggered_ordersGET /spot/price_ordersQuery running auto order list
SpotApicreate_spot_price_triggered_orderPOST /spot/price_ordersCreate price-triggered order
SpotApicancel_spot_price_triggered_order_listDELETE /spot/price_ordersCancel all auto orders
SpotApiget_spot_price_triggered_orderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancel_spot_price_triggered_orderDELETE /spot/price_orders/{order_id}Cancel single auto order
SpotApilist_spot_pov_ordersGET /spot/pov_ordersList Spot POV orders
SpotApicreate_spot_pov_orderPOST /spot/pov_ordersCreate a Spot POV order
SpotApicancel_spot_pov_ordersDELETE /spot/pov_ordersCancel Spot POV orders
SpotApiget_spot_pov_orderGET /spot/pov_orders/{order_id}Query Spot POV order details
SpotApicancel_spot_pov_orderDELETE /spot/pov_orders/{order_id}Cancel a Spot POV order
SquareApilist_square_ai_searchGET /social/message/searchAI MCP Dynamic Search
SquareApilist_live_replayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
WalletApilist_currency_chainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApiget_deposit_addressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilist_withdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilist_depositsGET /wallet/depositsGet deposit records
WalletApiget_transferGET /wallet/transfersGet trading account transfer
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilist_sub_account_transfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransfer_with_sub_accountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisub_account_to_sub_accountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApiget_transfer_order_statusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilist_withdraw_statusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilist_sub_account_balancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilist_sub_account_margin_balancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilist_sub_account_futures_balancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilist_sub_account_cross_margin_balancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilist_saved_addressGET /wallet/saved_addressQuery saved address
WalletApiget_trade_feeGET /wallet/feeQuery personal trading fees
WalletApiget_total_balanceGET /wallet/total_balanceQuery personal account totals
WalletApilist_small_balanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvert_small_balancePOST /wallet/small_balanceConvert small balance currency
WalletApilist_small_balance_historyGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilist_push_ordersGET /wallet/pushGet UID transfer history
WalletApiget_low_cap_exchange_listGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApiget_user_identityGET /rewards/getUserIdentityGet user identity
WelfareApiget_beginner_task_listGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaim_taskPOST /rewards/claimTaskGet the task
WelfareApiclaim_rewardPOST /rewards/claimRewardReceive mission rewards
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdraw_push_orderPOST /withdrawals/pushUID transfer
WithdrawalApicancel_withdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

apiv4

Authentication with APIv4 key and secret

For details, refer to: APIv4 signed request requirements

Author

support@mail.gate.com

About

No description, website, or topics provided.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - gate/gateapi-python · GitHub
Skip to content

Repository files navigation

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 Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.129
  • Package version: 7.2.129
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gate.com/page/contacts

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly using:

pip install --user gate-api

Then import the package:

importgate_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgate_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.ActivityApi(api_client)
try:
# My activity entryapi_response=api_instance.get_my_activity_entry()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling ActivityApi->get_my_activity_entry: %s\n"%e)

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ActivityApiget_my_activity_entryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilist_activitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilist_activity_typesGET /rewards/activity/activity-typeActivity type list
CFDApiquery_mt5_account_infoGET /tradfi/users/mt5-accountQuery MT5 account information
CFDApiquery_categoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
CFDApiquery_symbol_commissionsGET /tradfi/symbols/commissionsQuery symbol commission rates
CFDApiquery_symbolsGET /tradfi/symbolsQuery trading symbol list
CFDApiquery_symbol_detailGET /tradfi/symbols/detailQuery trading symbol details
CFDApiquery_symbol_klineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
CFDApiquery_symbol_tickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
CFDApicreate_trad_fi_userPOST /tradfi/usersCreate CFD user
CFDApiquery_user_assetsGET /tradfi/users/assetsQuery account assets
CFDApiquery_transactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
CFDApicreate_transactionPOST /tradfi/transactionsFund transfer
CFDApiquery_order_listGET /tradfi/ordersQuery active order list
CFDApicreate_trad_fi_orderPOST /tradfi/ordersCreate order
CFDApiupdate_orderPUT /tradfi/orders/{order_id}Modify order
CFDApidelete_orderDELETE /tradfi/orders/{order_id}Cancel order
CFDApiquery_order_history_listGET /tradfi/orders/historyQuery historical order list
CFDApiquery_order_logGET /tradfi/orders/log/{log_id}Get order details by log ID
CFDApiquery_position_listGET /tradfi/positionsQuery active position list
CFDApiupdate_positionPUT /tradfi/positions/{position_id}Modify position
CFDApiclose_positionPOST /tradfi/positions/{position_id}/closeClose position
CFDApiquery_position_history_listGET /tradfi/positions/historyQuery historical position list
CrossExApilist_crossex_rule_symbolsGET /crossex/rule/symbolsQuery symbol information
CrossExApilist_crossex_rule_risk_limitsGET /crossex/rule/risk_limitsQuery risk limit information
CrossExApilist_crossex_transfer_coinsGET /crossex/transfers/coinQuery supported transfer currencies
CrossExApilist_crossex_transfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreate_crossex_transferPOST /crossex/transfersFund Transfer
CrossExApicreate_crossex_orderPOST /crossex/ordersCreate order
CrossExApicancel_batch_crossex_ordersPOST /crossex/batch_cancel_ordersBatch cancel orders
CrossExApiget_crossex_orderGET /crossex/orders/{order_id}Query order details
CrossExApiupdate_crossex_orderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancel_crossex_orderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreate_crossex_convert_quotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreate_crossex_convert_orderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApiget_crossex_accountGET /crossex/accountsQuery Account Assets
CrossExApiupdate_crossex_accountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApiget_crossex_positions_leverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_positions_leveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApiget_crossex_margin_positions_leverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_margin_positions_leveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApiclose_crossex_positionPOST /crossex/positionFull Close Position
CrossExApiget_crossex_positions_margin_modeGET /crossex/positions/margin_modeGet futures position margin mode
CrossExApiupdate_crossex_positions_margin_modePOST /crossex/positions/margin_modeUpdate futures position margin mode
CrossExApiupdate_crossex_positions_marginPOST /crossex/positions/marginIncrease or decrease isolated margin
CrossExApiget_crossex_interest_rateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApiget_crossex_feeGET /crossex/feeQuery User Fee Rates
CrossExApilist_crossex_positionsGET /crossex/positionsQuery Contract Positions
CrossExApilist_crossex_margin_positionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilist_crossex_adl_rankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilist_crossex_open_ordersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilist_crossex_history_ordersGET /crossex/history_ordersQuery order history
CrossExApilist_crossex_history_positionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilist_crossex_history_margin_positionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilist_crossex_history_margin_interestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilist_crossex_history_tradesGET /crossex/history_tradesQuery filled history
CrossExApilist_crossex_account_bookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilist_crossex_coin_discount_rateGET /crossex/coin_discount_rateQuery Currency Discount Rate
CrossExApilist_crossex_market_tickersGET /crossex/market/tickersGet exchange tickers
CrossExApilist_crossex_market_funding_infoGET /crossex/market/funding_infoGet exchange futures funding rate information
EarnUniApilist_uni_currenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApiget_uni_currencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilist_user_uni_lendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreate_uni_lendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichange_uni_lendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilist_uni_lend_recordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApiget_uni_interestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilist_uni_interest_recordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApiget_uni_interest_statusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilist_uni_chartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilist_uni_rateGET /earn/uni/rateCurrency estimated annualized interest rate
MarginUniApilist_uni_currency_pairsGET /margin/uni/currency_pairsList lending markets
MarginUniApiget_uni_currency_pairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApiget_margin_uni_estimate_rateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilist_uni_loansGET /margin/uni/loansQuery loans
MarginUniApicreate_uni_loanPOST /margin/uni/loansBorrow or repay
MarginUniApilist_uni_loan_recordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilist_uni_loan_interest_recordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApiget_uni_borrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
OTCApicreate_otc_quotePOST /otc/quoteFiat and stablecoin quote
OTCApicreate_otc_orderPOST /otc/order/createCreate fiat order
OTCApicreate_stable_coin_orderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApiget_bank_list_inner_pathGET /otc/bank/listGet user bank card list
OTCApicreate_otc_bankPOST /otc/bank/createCreate bank card
OTCApidelete_otc_bankPOST /otc/bank/deleteDelete bank card
OTCApiset_default_otc_bankPOST /otc/bank/set_defaultSet default bank card
OTCApiget_otc_bank_supplement_checklistGET /otc/bank/bank_supplement_checklistQuery the checklist of materials to supplement for a bank card
OTCApisubmit_otc_bank_personal_supplementPOST /otc/bank/personal/bank_supplementSubmit Bank Card Supplement Materials (Personal)
OTCApisubmit_otc_bank_enterprise_supplementPOST /otc/bank/enterprise/bank_supplementSubmit Bank Card Supplement Materials (Enterprise)
OTCApimark_otc_order_paidPOST /otc/order/paidMark fiat order as paid (deposit confirmation)
OTCApicancel_otc_orderPOST /otc/order/cancelFiat order cancellation
OTCApilist_otc_ordersGET /otc/order/listFiat order list
OTCApilist_stable_coin_ordersGET /otc/stable_coin/order/listStablecoin order list
OTCApiget_otc_order_detailGET /otc/order/detailFiat order details
StockApiquery_stock_user_assetsGET /stock/users/assetsQuery user assets
StockApiquery_stock_symbolsGET /stock/symbolsQuery symbol list
StockApiquery_stock_symbol_detailGET /stock/symbols/detailQuery symbol details
StockApiquery_stock_order_bookGET /stock/market/{symbol}/orderbookQuery market order book
StockApiquery_stock_order_listGET /stock/ordersQuery open order list
StockApicreate_stock_orderPOST /stock/ordersCreate order
StockApidelete_all_stock_ordersDELETE /stock/ordersCancel all open orders
StockApiquery_stock_order_historyGET /stock/orders/historyQuery historical order list
StockApiupdate_stock_orderPUT /stock/orders/{order_id}Modify order
StockApidelete_stock_orderDELETE /stock/orders/{order_id}Cancel order
StockApiquery_stock_positionsGET /stock/positionsQuery current position list
StockApiclose_stock_positionPOST /stock/positions/closeClose position
StockApiquery_stock_transactionsGET /stock/transactionsQuery transaction records
StockApicreate_stock_transactionPOST /stock/transactionsFund transfer
StockApiquery_stock_exchangesGET /stock/exchangesQuery supported exchanges
StockApiquery_stock_fee_rateGET /stock/fee-rateQuery fee rates for Japanese and Korean stocks
SubAccountApilist_sub_accountsGET /sub_accountsList sub-accounts
SubAccountApicreate_sub_accountsPOST /sub_accountsCreate a new sub-account
SubAccountApiget_sub_accountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilist_sub_account_keysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreate_sub_account_keysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApiget_sub_account_keyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdate_sub_account_keysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApidelete_sub_account_keysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilock_sub_accountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlock_sub_accountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilist_unified_modeGET /sub_accounts/unified_modeGet sub-account mode
UnifiedApilist_unified_accountsGET /unified/accountsGet unified account information
UnifiedApiget_unified_borrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApiget_unified_transferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApiget_unified_transferablesGET /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
UnifiedApiget_unified_borrowable_listGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilist_unified_loansGET /unified/loansQuery loans
UnifiedApicreate_unified_loanPOST /unified/loansBorrow or repay
UnifiedApilist_unified_loan_recordsGET /unified/loan_recordsQuery loan records
UnifiedApilist_unified_loan_interest_recordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApiget_unified_risk_unitsGET /unified/risk_unitsGet user risk unit details
UnifiedApiget_unified_modeGET /unified/unified_modeQuery mode of the unified account
UnifiedApiset_unified_modePUT /unified/unified_modeSet unified account mode
UnifiedApiget_unified_estimate_rateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilist_currency_discount_tiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilist_loan_margin_tiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculate_portfolio_marginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApiset_user_leveragePOST /unified/leverage/user_settingSet leverage for all of the user's borrowed currencies
UnifiedApiget_user_leverage_currency_configGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApiget_user_leverage_currency_settingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApiset_user_leverage_currency_settingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilist_unified_currenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApiget_history_loan_rateGET /unified/history_loan_rateGet historical lending rates
UnifiedApiset_unified_collateralPOST /unified/collateral_currenciesSet collateral currency
UnifiedApiget_estimated_quick_repaymentGET /unified/estimated_quick_repaymentEstimated quick repayment details
UnifiedApicreate_quick_repaymentPOST /unified/quick_repaymentQuick repayment
UnifiedApiget_unified_delta_neutralGET /unified/delta_neutralQuery the account Delta-neutral strategy mode setting
UnifiedApiset_unified_delta_neutralPOST /unified/delta_neutralSet the account Delta-neutral strategy mode
AccountApiget_account_detailGET /account/detailRetrieve user account information
AccountApiget_account_main_keysGET /account/main_keysQuery All Main Account Key Information
AccountApiget_account_rate_limitGET /account/rate_limitGet user transaction rate limit information
AccountApilist_stp_groupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreate_stp_groupPOST /account/stp_groupsCreate STP user group
AccountApilist_stp_groups_usersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiadd_stp_group_usersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApidelete_stp_group_usersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApiget_debit_feeGET /account/debit_feeQuery GT fee deduction configuration
AccountApiset_debit_feePOST /account/debit_feeConfigure GT fee deduction
AlphaApilist_alpha_accountsGET /alpha/accountsAlpha Account API
AlphaApilist_alpha_account_bookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquote_alpha_orderPOST /alpha/quoteAlpha Quote API
AlphaApilist_alpha_orderGET /alpha/ordersAlpha Order List API
AlphaApiplace_alpha_orderPOST /alpha/ordersAlpha Order API
AlphaApiget_alpha_orderGET /alpha/orderAlpha Single Order Query API
AlphaApilist_alpha_currenciesGET /alpha/currenciesQuery currency information
AlphaApilist_alpha_tickersGET /alpha/tickersQuery currency ticker
AlphaApilist_alpha_tokensGET /alpha/tokensQuery Token Information
AssetswapApilist_asset_swap_assetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApiget_asset_swap_configGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluate_asset_swapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreate_asset_swap_order_v1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilist_asset_swap_orders_v1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreview_asset_swap_order_v1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApiget_asset_swap_order_v1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApiget_ai_hub_strategy_recommendGET /bot/strategy/recommendGet AIHub strategy recommendations
BotApipost_ai_hub_spot_grid_createPOST /bot/spot-grid/createCreate spot grid
BotApipost_ai_hub_margin_grid_createPOST /bot/margin-grid/createCreate a lever grid
BotApipost_ai_hub_infinite_grid_createPOST /bot/infinite-grid/createCreate infinite grid
BotApipost_ai_hub_futures_grid_createPOST /bot/futures-grid/createCreate a contract grid
BotApipost_ai_hub_spot_martingale_createPOST /bot/spot-martingale/createCreate Spot Martin
BotApipost_ai_hub_contract_martingale_createPOST /bot/contract-martingale/createCreate contract martin
BotApiget_ai_hub_portfolio_runningGET /bot/portfolio/runningQuery the list of running policies
BotApiget_ai_hub_portfolio_detailGET /bot/portfolio/detailQuery order policy details
BotApipost_ai_hub_portfolio_stopPOST /bot/portfolio/stopTerminate a single running policy
CouponApilist_user_couponsGET /coupon/user-coupon-listCoupon Center list
CouponApiget_user_coupon_detailGET /coupon/user-coupon-detailCoupon Center details
DeliveryApilist_delivery_contractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApiget_delivery_contractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilist_delivery_order_bookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilist_delivery_tradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilist_delivery_candlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilist_delivery_tickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilist_delivery_insurance_ledgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilist_delivery_accountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilist_delivery_account_bookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilist_delivery_positionsGET /delivery/{settle}/positionsGet user position list
DeliveryApiget_delivery_positionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdate_delivery_position_marginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdate_delivery_position_leveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdate_delivery_position_risk_limitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilist_delivery_ordersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreate_delivery_orderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancel_delivery_ordersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApiget_delivery_orderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancel_delivery_orderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApiget_my_delivery_tradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilist_delivery_position_closeGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilist_delivery_liquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilist_delivery_settlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilist_delivery_risk_limit_tiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilist_price_triggered_delivery_ordersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreate_price_triggered_delivery_orderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancel_price_triggered_delivery_order_listDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApiget_price_triggered_delivery_orderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancel_price_triggered_delivery_orderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilist_dual_investment_plansGET /earn/dual/investment_planDual Investment product list
EarnApilist_dual_ordersGET /earn/dual/ordersDual Investment order list
EarnApiplace_dual_orderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilist_dual_balanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApiget_dual_order_refund_previewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplace_dual_order_refundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodify_dual_order_reinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApiget_dual_project_recommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifind_coinGET /earn/staking/coinsStaking coins
EarnApiswap_staking_coinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorder_listGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiaward_listGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiasset_listGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreate_auto_invest_planPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdate_auto_invest_planPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistop_auto_invest_planPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiadd_position_auto_invest_planPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilist_auto_invest_coinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApiget_auto_invest_min_amountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilist_auto_invest_plan_recordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilist_auto_invest_ordersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilist_auto_invest_configGET /earn/autoinvest/configList investment currency configuration
EarnApiget_auto_invest_plan_detailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilist_auto_invest_plansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilist_earn_fixed_term_productsGET /earn/fixed-term/productGet product list
EarnApilist_earn_fixed_term_products_by_assetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilist_earn_fixed_term_lendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreate_earn_fixed_term_lendPOST /earn/fixed-term/user/lendSubscription
EarnApicreate_earn_fixed_term_pre_redeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilist_earn_fixed_term_historyGET /earn/fixed-term/user/historySubscription history
FlashSwapApilist_flash_swap_currency_pairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilist_flash_swap_ordersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreate_flash_swap_orderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApiget_flash_swap_orderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreview_flash_swap_orderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreate_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreview_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreate_flash_swap_order_v1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreate_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreview_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreview_flash_swap_order_v1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilist_futures_contractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApilist_futures_contracts_allGET /futures/{settle}/contracts_allQuery all contract information (including delisted)
FuturesApiget_futures_contractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilist_futures_adl_risk_statesGET /futures/{settle}/adl_risk_statesList market-level ADL risk states
FuturesApilist_futures_order_bookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilist_futures_tradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilist_futures_candlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilist_futures_premium_indexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilist_futures_tickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilist_futures_funding_rate_historyGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilist_batch_futures_funding_ratesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilist_futures_insurance_ledgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilist_contract_statsGET /futures/{settle}/contract_statsFutures statistics
FuturesApiget_index_constituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilist_liquidated_ordersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilist_futures_risk_limit_tiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilist_futures_accountsGET /futures/{settle}/accountsGet futures account
FuturesApilist_futures_account_bookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilist_positionsGET /futures/{settle}/positionsGet user position list
FuturesApilist_positions_timerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApiget_positionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApiget_leverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdate_position_marginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdate_position_leveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdate_contract_position_leveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdate_position_cross_modePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdate_dual_comp_position_cross_modePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdate_position_risk_limitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApiset_dual_modePOST /futures/{settle}/dual_modeSet position mode
FuturesApiset_position_modePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApiget_dual_mode_positionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdate_dual_mode_position_marginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdate_dual_mode_position_leveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdate_dual_mode_position_risk_limitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilist_futures_ordersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreate_futures_orderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancel_futures_ordersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApiget_orders_with_time_rangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreate_batch_futures_orderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApiget_futures_orderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamend_futures_orderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancel_futures_orderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApiget_my_tradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApiget_my_trades_with_time_rangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilist_position_closeGET /futures/{settle}/position_closeQuery position close history
FuturesApilist_liquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilist_auto_deleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdown_cancel_all_futuresPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApiget_futures_feeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancel_batch_future_ordersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamend_batch_future_ordersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApiget_futures_risk_limit_tableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreate_futures_bbo_orderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistop_trail_orderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistop_all_trail_ordersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApiget_trail_ordersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApiget_trail_order_detailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApiget_trail_order_change_logGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApicreate_chase_orderPOST /futures/{settle}/autoorder/v1/chase/createCreate a chase order
FuturesApistop_chase_orderPOST /futures/{settle}/autoorder/v1/chase/stopStop a chase order
FuturesApistop_all_chase_ordersPOST /futures/{settle}/autoorder/v1/chase/stop_allStop chase orders in batch
FuturesApiget_chase_ordersGET /futures/{settle}/autoorder/v1/chase/listList chase orders
FuturesApiget_chase_order_detailGET /futures/{settle}/autoorder/v1/chase/detailGet chase order detail
FuturesApilist_price_triggered_ordersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreate_price_triggered_orderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancel_price_triggered_order_listDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApiget_price_triggered_orderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancel_price_triggered_orderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdate_price_triggered_orderPUT /futures/{settle}/price_orders/amendModify a Single Auto Order
MarginApilist_margin_accountsGET /margin/accountsMargin account list
MarginApilist_margin_account_bookGET /margin/account_bookQuery margin account balance change history
MarginApilist_funding_accountsGET /margin/funding_accountsFunding account list
MarginApiget_auto_repay_statusGET /margin/auto_repayQuery user auto repayment settings
MarginApiset_auto_repayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApiget_margin_transferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApiget_user_margin_tierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApiget_market_margin_tierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApiset_user_market_leveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilist_margin_user_accountGET /margin/user/accountQuery user's isolated margin account list
MarginApilist_cross_margin_loansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilist_cross_margin_repaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MultiCollateralLoanApilist_multi_collateral_ordersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreate_multi_collateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApiget_multi_collateral_order_detailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilist_multi_repay_recordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepay_multi_collateral_loanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilist_multi_collateral_recordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperate_multi_collateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilist_user_currency_quotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilist_multi_collateral_currenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApiget_multi_collateral_ltvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApiget_multi_collateral_fix_rateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApiget_multi_collateral_current_rateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OptionsApilist_options_underlyingsGET /options/underlyingsList all underlying assets
OptionsApilist_options_expirationsGET /options/expirationsList all expiration dates
OptionsApilist_options_contractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApiget_options_contractGET /options/contracts/{contract}Query specified contract details
OptionsApilist_options_settlementsGET /options/settlementsList settlement history
OptionsApiget_options_settlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilist_my_options_settlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilist_options_order_bookGET /options/order_bookQuery options contract order book
OptionsApilist_options_tickersGET /options/tickersQuery options market ticker information
OptionsApilist_options_underlying_tickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilist_options_candlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilist_options_underlying_candlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilist_options_tradesGET /options/tradesMarket trade records
OptionsApilist_options_accountGET /options/accountsQuery account information
OptionsApilist_options_account_bookGET /options/account_bookQuery account change history
OptionsApilist_options_positionsGET /options/positionsList user's positions of specified underlying
OptionsApiget_options_positionGET /options/positions/{contract}Get specified contract position
OptionsApilist_options_position_closeGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilist_options_ordersGET /options/ordersList options orders
OptionsApicreate_options_orderPOST /options/ordersCreate an options order
OptionsApicancel_options_ordersDELETE /options/ordersCancel all orders with 'open' status
OptionsApiget_options_orderGET /options/orders/{order_id}Query single order details
OptionsApiamend_options_orderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancel_options_orderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdown_cancel_all_optionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilist_my_options_tradesGET /options/my_tradesQuery personal trading records
OptionsApiget_options_mmpGET /options/mmpMMP Query.
OptionsApiset_options_mmpPOST /options/mmpMMP Settings
OptionsApireset_options_mmpPOST /options/mmp/resetMMP Reset
P2pApip2p_merchant_account_get_user_infoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2p_merchant_account_get_counterparty_user_infoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2p_merchant_account_get_myself_paymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2p_merchant_account_set_merchant_work_hoursPOST /p2p/merchant/account/set_merchant_work_hoursSet merchant working status and custom working hours
P2pApip2p_merchant_transaction_get_pending_transaction_listPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2p_merchant_transaction_get_completed_transaction_listPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2p_merchant_transaction_get_transaction_detailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2p_merchant_transaction_confirm_paymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2p_merchant_transaction_confirm_receiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2p_merchant_transaction_cancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2p_merchant_books_place_biz_push_orderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2p_merchant_books_ads_update_statusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2p_merchant_books_ads_detailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2p_merchant_books_my_ads_listPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2p_merchant_books_ads_listPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2p_merchant_chat_get_chats_listPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2p_merchant_chat_send_chat_messagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2p_merchant_chat_upload_chat_filePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagency_transaction_historyGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagency_commissions_historyGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartner_transaction_historyGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartner_commissions_historyGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartner_sub_listGET /rebate/partner/sub_listPartner subordinate list
RebateApirebate_broker_commission_historyGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebate_broker_transaction_historyGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebate_user_infoGET /rebate/user/infoUser obtains rebate information
RebateApiuser_sub_relationGET /rebate/user/sub_relationUser subordinate relationship
RebateApiget_partner_application_recentGET /rebate/partner/applications/recentGet recent partner application records
RebateApiget_partner_eligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApiget_partner_agent_data_aggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilist_currenciesGET /spot/currenciesQuery all currency information
SpotApiget_currencyGET /spot/currencies/{currency}Query single currency information
SpotApilist_currency_pairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApiget_currency_pairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilist_tickersGET /spot/tickersGet currency pair ticker information
SpotApilist_order_bookGET /spot/order_bookGet market depth information
SpotApilist_tradesGET /spot/tradesQuery market transaction records
SpotApilist_candlesticksGET /spot/candlesticksMarket K-line chart
SpotApiget_feeGET /spot/feeQuery account fee rates
SpotApiget_batch_spot_feeGET /spot/batch_feeBatch query account fee rates
SpotApilist_spot_accountsGET /spot/accountsList spot trading accounts
SpotApilist_spot_account_bookGET /spot/account_bookQuery spot account transaction history
SpotApicreate_batch_ordersPOST /spot/batch_ordersBatch place orders
SpotApilist_all_open_ordersGET /spot/open_ordersList all open orders
SpotApicreate_cross_liquidate_orderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilist_ordersGET /spot/ordersList orders
SpotApicreate_orderPOST /spot/ordersCreate order
SpotApicancel_ordersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancel_batch_ordersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApiget_orderGET /spot/orders/{order_id}Query single order details
SpotApicancel_orderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamend_orderPATCH /spot/orders/{order_id}Amend single order
SpotApilist_my_tradesGET /spot/my_tradesQuery personal trading records
SpotApiget_system_timeGET /spot/timeGet server current time
SpotApicountdown_cancel_all_spotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamend_batch_ordersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApiget_spot_insurance_historyGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilist_spot_price_triggered_ordersGET /spot/price_ordersQuery running auto order list
SpotApicreate_spot_price_triggered_orderPOST /spot/price_ordersCreate price-triggered order
SpotApicancel_spot_price_triggered_order_listDELETE /spot/price_ordersCancel all auto orders
SpotApiget_spot_price_triggered_orderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancel_spot_price_triggered_orderDELETE /spot/price_orders/{order_id}Cancel single auto order
SpotApilist_spot_pov_ordersGET /spot/pov_ordersList Spot POV orders
SpotApicreate_spot_pov_orderPOST /spot/pov_ordersCreate a Spot POV order
SpotApicancel_spot_pov_ordersDELETE /spot/pov_ordersCancel Spot POV orders
SpotApiget_spot_pov_orderGET /spot/pov_orders/{order_id}Query Spot POV order details
SpotApicancel_spot_pov_orderDELETE /spot/pov_orders/{order_id}Cancel a Spot POV order
SquareApilist_square_ai_searchGET /social/message/searchAI MCP Dynamic Search
SquareApilist_live_replayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
WalletApilist_currency_chainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApiget_deposit_addressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilist_withdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilist_depositsGET /wallet/depositsGet deposit records
WalletApiget_transferGET /wallet/transfersGet trading account transfer
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilist_sub_account_transfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransfer_with_sub_accountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisub_account_to_sub_accountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApiget_transfer_order_statusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilist_withdraw_statusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilist_sub_account_balancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilist_sub_account_margin_balancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilist_sub_account_futures_balancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilist_sub_account_cross_margin_balancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilist_saved_addressGET /wallet/saved_addressQuery saved address
WalletApiget_trade_feeGET /wallet/feeQuery personal trading fees
WalletApiget_total_balanceGET /wallet/total_balanceQuery personal account totals
WalletApilist_small_balanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvert_small_balancePOST /wallet/small_balanceConvert small balance currency
WalletApilist_small_balance_historyGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilist_push_ordersGET /wallet/pushGet UID transfer history
WalletApiget_low_cap_exchange_listGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApiget_user_identityGET /rewards/getUserIdentityGet user identity
WelfareApiget_beginner_task_listGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaim_taskPOST /rewards/claimTaskGet the task
WelfareApiclaim_rewardPOST /rewards/claimRewardReceive mission rewards
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdraw_push_orderPOST /withdrawals/pushUID transfer
WithdrawalApicancel_withdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

apiv4

Authentication with APIv4 key and secret

For details, refer to: APIv4 signed request requirements

Author

support@mail.gate.com

About

No description, website, or topics provided.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - gate/gateapi-python · GitHub
Skip to content

Repository files navigation

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 Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.129
  • Package version: 7.2.129
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gate.com/page/contacts

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly using:

pip install --user gate-api

Then import the package:

importgate_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgate_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.ActivityApi(api_client)
try:
# My activity entryapi_response=api_instance.get_my_activity_entry()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling ActivityApi->get_my_activity_entry: %s\n"%e)

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ActivityApiget_my_activity_entryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilist_activitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilist_activity_typesGET /rewards/activity/activity-typeActivity type list
CFDApiquery_mt5_account_infoGET /tradfi/users/mt5-accountQuery MT5 account information
CFDApiquery_categoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
CFDApiquery_symbol_commissionsGET /tradfi/symbols/commissionsQuery symbol commission rates
CFDApiquery_symbolsGET /tradfi/symbolsQuery trading symbol list
CFDApiquery_symbol_detailGET /tradfi/symbols/detailQuery trading symbol details
CFDApiquery_symbol_klineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
CFDApiquery_symbol_tickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
CFDApicreate_trad_fi_userPOST /tradfi/usersCreate CFD user
CFDApiquery_user_assetsGET /tradfi/users/assetsQuery account assets
CFDApiquery_transactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
CFDApicreate_transactionPOST /tradfi/transactionsFund transfer
CFDApiquery_order_listGET /tradfi/ordersQuery active order list
CFDApicreate_trad_fi_orderPOST /tradfi/ordersCreate order
CFDApiupdate_orderPUT /tradfi/orders/{order_id}Modify order
CFDApidelete_orderDELETE /tradfi/orders/{order_id}Cancel order
CFDApiquery_order_history_listGET /tradfi/orders/historyQuery historical order list
CFDApiquery_order_logGET /tradfi/orders/log/{log_id}Get order details by log ID
CFDApiquery_position_listGET /tradfi/positionsQuery active position list
CFDApiupdate_positionPUT /tradfi/positions/{position_id}Modify position
CFDApiclose_positionPOST /tradfi/positions/{position_id}/closeClose position
CFDApiquery_position_history_listGET /tradfi/positions/historyQuery historical position list
CrossExApilist_crossex_rule_symbolsGET /crossex/rule/symbolsQuery symbol information
CrossExApilist_crossex_rule_risk_limitsGET /crossex/rule/risk_limitsQuery risk limit information
CrossExApilist_crossex_transfer_coinsGET /crossex/transfers/coinQuery supported transfer currencies
CrossExApilist_crossex_transfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreate_crossex_transferPOST /crossex/transfersFund Transfer
CrossExApicreate_crossex_orderPOST /crossex/ordersCreate order
CrossExApicancel_batch_crossex_ordersPOST /crossex/batch_cancel_ordersBatch cancel orders
CrossExApiget_crossex_orderGET /crossex/orders/{order_id}Query order details
CrossExApiupdate_crossex_orderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancel_crossex_orderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreate_crossex_convert_quotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreate_crossex_convert_orderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApiget_crossex_accountGET /crossex/accountsQuery Account Assets
CrossExApiupdate_crossex_accountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApiget_crossex_positions_leverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_positions_leveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApiget_crossex_margin_positions_leverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_margin_positions_leveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApiclose_crossex_positionPOST /crossex/positionFull Close Position
CrossExApiget_crossex_positions_margin_modeGET /crossex/positions/margin_modeGet futures position margin mode
CrossExApiupdate_crossex_positions_margin_modePOST /crossex/positions/margin_modeUpdate futures position margin mode
CrossExApiupdate_crossex_positions_marginPOST /crossex/positions/marginIncrease or decrease isolated margin
CrossExApiget_crossex_interest_rateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApiget_crossex_feeGET /crossex/feeQuery User Fee Rates
CrossExApilist_crossex_positionsGET /crossex/positionsQuery Contract Positions
CrossExApilist_crossex_margin_positionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilist_crossex_adl_rankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilist_crossex_open_ordersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilist_crossex_history_ordersGET /crossex/history_ordersQuery order history
CrossExApilist_crossex_history_positionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilist_crossex_history_margin_positionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilist_crossex_history_margin_interestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilist_crossex_history_tradesGET /crossex/history_tradesQuery filled history
CrossExApilist_crossex_account_bookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilist_crossex_coin_discount_rateGET /crossex/coin_discount_rateQuery Currency Discount Rate
CrossExApilist_crossex_market_tickersGET /crossex/market/tickersGet exchange tickers
CrossExApilist_crossex_market_funding_infoGET /crossex/market/funding_infoGet exchange futures funding rate information
EarnUniApilist_uni_currenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApiget_uni_currencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilist_user_uni_lendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreate_uni_lendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichange_uni_lendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilist_uni_lend_recordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApiget_uni_interestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilist_uni_interest_recordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApiget_uni_interest_statusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilist_uni_chartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilist_uni_rateGET /earn/uni/rateCurrency estimated annualized interest rate
MarginUniApilist_uni_currency_pairsGET /margin/uni/currency_pairsList lending markets
MarginUniApiget_uni_currency_pairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApiget_margin_uni_estimate_rateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilist_uni_loansGET /margin/uni/loansQuery loans
MarginUniApicreate_uni_loanPOST /margin/uni/loansBorrow or repay
MarginUniApilist_uni_loan_recordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilist_uni_loan_interest_recordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApiget_uni_borrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
OTCApicreate_otc_quotePOST /otc/quoteFiat and stablecoin quote
OTCApicreate_otc_orderPOST /otc/order/createCreate fiat order
OTCApicreate_stable_coin_orderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApiget_bank_list_inner_pathGET /otc/bank/listGet user bank card list
OTCApicreate_otc_bankPOST /otc/bank/createCreate bank card
OTCApidelete_otc_bankPOST /otc/bank/deleteDelete bank card
OTCApiset_default_otc_bankPOST /otc/bank/set_defaultSet default bank card
OTCApiget_otc_bank_supplement_checklistGET /otc/bank/bank_supplement_checklistQuery the checklist of materials to supplement for a bank card
OTCApisubmit_otc_bank_personal_supplementPOST /otc/bank/personal/bank_supplementSubmit Bank Card Supplement Materials (Personal)
OTCApisubmit_otc_bank_enterprise_supplementPOST /otc/bank/enterprise/bank_supplementSubmit Bank Card Supplement Materials (Enterprise)
OTCApimark_otc_order_paidPOST /otc/order/paidMark fiat order as paid (deposit confirmation)
OTCApicancel_otc_orderPOST /otc/order/cancelFiat order cancellation
OTCApilist_otc_ordersGET /otc/order/listFiat order list
OTCApilist_stable_coin_ordersGET /otc/stable_coin/order/listStablecoin order list
OTCApiget_otc_order_detailGET /otc/order/detailFiat order details
StockApiquery_stock_user_assetsGET /stock/users/assetsQuery user assets
StockApiquery_stock_symbolsGET /stock/symbolsQuery symbol list
StockApiquery_stock_symbol_detailGET /stock/symbols/detailQuery symbol details
StockApiquery_stock_order_bookGET /stock/market/{symbol}/orderbookQuery market order book
StockApiquery_stock_order_listGET /stock/ordersQuery open order list
StockApicreate_stock_orderPOST /stock/ordersCreate order
StockApidelete_all_stock_ordersDELETE /stock/ordersCancel all open orders
StockApiquery_stock_order_historyGET /stock/orders/historyQuery historical order list
StockApiupdate_stock_orderPUT /stock/orders/{order_id}Modify order
StockApidelete_stock_orderDELETE /stock/orders/{order_id}Cancel order
StockApiquery_stock_positionsGET /stock/positionsQuery current position list
StockApiclose_stock_positionPOST /stock/positions/closeClose position
StockApiquery_stock_transactionsGET /stock/transactionsQuery transaction records
StockApicreate_stock_transactionPOST /stock/transactionsFund transfer
StockApiquery_stock_exchangesGET /stock/exchangesQuery supported exchanges
StockApiquery_stock_fee_rateGET /stock/fee-rateQuery fee rates for Japanese and Korean stocks
SubAccountApilist_sub_accountsGET /sub_accountsList sub-accounts
SubAccountApicreate_sub_accountsPOST /sub_accountsCreate a new sub-account
SubAccountApiget_sub_accountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilist_sub_account_keysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreate_sub_account_keysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApiget_sub_account_keyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdate_sub_account_keysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApidelete_sub_account_keysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilock_sub_accountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlock_sub_accountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilist_unified_modeGET /sub_accounts/unified_modeGet sub-account mode
UnifiedApilist_unified_accountsGET /unified/accountsGet unified account information
UnifiedApiget_unified_borrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApiget_unified_transferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApiget_unified_transferablesGET /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
UnifiedApiget_unified_borrowable_listGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilist_unified_loansGET /unified/loansQuery loans
UnifiedApicreate_unified_loanPOST /unified/loansBorrow or repay
UnifiedApilist_unified_loan_recordsGET /unified/loan_recordsQuery loan records
UnifiedApilist_unified_loan_interest_recordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApiget_unified_risk_unitsGET /unified/risk_unitsGet user risk unit details
UnifiedApiget_unified_modeGET /unified/unified_modeQuery mode of the unified account
UnifiedApiset_unified_modePUT /unified/unified_modeSet unified account mode
UnifiedApiget_unified_estimate_rateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilist_currency_discount_tiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilist_loan_margin_tiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculate_portfolio_marginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApiset_user_leveragePOST /unified/leverage/user_settingSet leverage for all of the user's borrowed currencies
UnifiedApiget_user_leverage_currency_configGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApiget_user_leverage_currency_settingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApiset_user_leverage_currency_settingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilist_unified_currenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApiget_history_loan_rateGET /unified/history_loan_rateGet historical lending rates
UnifiedApiset_unified_collateralPOST /unified/collateral_currenciesSet collateral currency
UnifiedApiget_estimated_quick_repaymentGET /unified/estimated_quick_repaymentEstimated quick repayment details
UnifiedApicreate_quick_repaymentPOST /unified/quick_repaymentQuick repayment
UnifiedApiget_unified_delta_neutralGET /unified/delta_neutralQuery the account Delta-neutral strategy mode setting
UnifiedApiset_unified_delta_neutralPOST /unified/delta_neutralSet the account Delta-neutral strategy mode
AccountApiget_account_detailGET /account/detailRetrieve user account information
AccountApiget_account_main_keysGET /account/main_keysQuery All Main Account Key Information
AccountApiget_account_rate_limitGET /account/rate_limitGet user transaction rate limit information
AccountApilist_stp_groupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreate_stp_groupPOST /account/stp_groupsCreate STP user group
AccountApilist_stp_groups_usersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiadd_stp_group_usersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApidelete_stp_group_usersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApiget_debit_feeGET /account/debit_feeQuery GT fee deduction configuration
AccountApiset_debit_feePOST /account/debit_feeConfigure GT fee deduction
AlphaApilist_alpha_accountsGET /alpha/accountsAlpha Account API
AlphaApilist_alpha_account_bookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquote_alpha_orderPOST /alpha/quoteAlpha Quote API
AlphaApilist_alpha_orderGET /alpha/ordersAlpha Order List API
AlphaApiplace_alpha_orderPOST /alpha/ordersAlpha Order API
AlphaApiget_alpha_orderGET /alpha/orderAlpha Single Order Query API
AlphaApilist_alpha_currenciesGET /alpha/currenciesQuery currency information
AlphaApilist_alpha_tickersGET /alpha/tickersQuery currency ticker
AlphaApilist_alpha_tokensGET /alpha/tokensQuery Token Information
AssetswapApilist_asset_swap_assetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApiget_asset_swap_configGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluate_asset_swapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreate_asset_swap_order_v1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilist_asset_swap_orders_v1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreview_asset_swap_order_v1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApiget_asset_swap_order_v1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApiget_ai_hub_strategy_recommendGET /bot/strategy/recommendGet AIHub strategy recommendations
BotApipost_ai_hub_spot_grid_createPOST /bot/spot-grid/createCreate spot grid
BotApipost_ai_hub_margin_grid_createPOST /bot/margin-grid/createCreate a lever grid
BotApipost_ai_hub_infinite_grid_createPOST /bot/infinite-grid/createCreate infinite grid
BotApipost_ai_hub_futures_grid_createPOST /bot/futures-grid/createCreate a contract grid
BotApipost_ai_hub_spot_martingale_createPOST /bot/spot-martingale/createCreate Spot Martin
BotApipost_ai_hub_contract_martingale_createPOST /bot/contract-martingale/createCreate contract martin
BotApiget_ai_hub_portfolio_runningGET /bot/portfolio/runningQuery the list of running policies
BotApiget_ai_hub_portfolio_detailGET /bot/portfolio/detailQuery order policy details
BotApipost_ai_hub_portfolio_stopPOST /bot/portfolio/stopTerminate a single running policy
CouponApilist_user_couponsGET /coupon/user-coupon-listCoupon Center list
CouponApiget_user_coupon_detailGET /coupon/user-coupon-detailCoupon Center details
DeliveryApilist_delivery_contractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApiget_delivery_contractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilist_delivery_order_bookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilist_delivery_tradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilist_delivery_candlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilist_delivery_tickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilist_delivery_insurance_ledgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilist_delivery_accountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilist_delivery_account_bookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilist_delivery_positionsGET /delivery/{settle}/positionsGet user position list
DeliveryApiget_delivery_positionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdate_delivery_position_marginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdate_delivery_position_leveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdate_delivery_position_risk_limitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilist_delivery_ordersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreate_delivery_orderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancel_delivery_ordersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApiget_delivery_orderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancel_delivery_orderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApiget_my_delivery_tradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilist_delivery_position_closeGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilist_delivery_liquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilist_delivery_settlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilist_delivery_risk_limit_tiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilist_price_triggered_delivery_ordersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreate_price_triggered_delivery_orderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancel_price_triggered_delivery_order_listDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApiget_price_triggered_delivery_orderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancel_price_triggered_delivery_orderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilist_dual_investment_plansGET /earn/dual/investment_planDual Investment product list
EarnApilist_dual_ordersGET /earn/dual/ordersDual Investment order list
EarnApiplace_dual_orderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilist_dual_balanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApiget_dual_order_refund_previewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplace_dual_order_refundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodify_dual_order_reinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApiget_dual_project_recommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifind_coinGET /earn/staking/coinsStaking coins
EarnApiswap_staking_coinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorder_listGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiaward_listGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiasset_listGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreate_auto_invest_planPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdate_auto_invest_planPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistop_auto_invest_planPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiadd_position_auto_invest_planPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilist_auto_invest_coinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApiget_auto_invest_min_amountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilist_auto_invest_plan_recordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilist_auto_invest_ordersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilist_auto_invest_configGET /earn/autoinvest/configList investment currency configuration
EarnApiget_auto_invest_plan_detailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilist_auto_invest_plansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilist_earn_fixed_term_productsGET /earn/fixed-term/productGet product list
EarnApilist_earn_fixed_term_products_by_assetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilist_earn_fixed_term_lendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreate_earn_fixed_term_lendPOST /earn/fixed-term/user/lendSubscription
EarnApicreate_earn_fixed_term_pre_redeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilist_earn_fixed_term_historyGET /earn/fixed-term/user/historySubscription history
FlashSwapApilist_flash_swap_currency_pairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilist_flash_swap_ordersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreate_flash_swap_orderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApiget_flash_swap_orderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreview_flash_swap_orderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreate_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreview_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreate_flash_swap_order_v1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreate_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreview_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreview_flash_swap_order_v1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilist_futures_contractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApilist_futures_contracts_allGET /futures/{settle}/contracts_allQuery all contract information (including delisted)
FuturesApiget_futures_contractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilist_futures_adl_risk_statesGET /futures/{settle}/adl_risk_statesList market-level ADL risk states
FuturesApilist_futures_order_bookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilist_futures_tradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilist_futures_candlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilist_futures_premium_indexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilist_futures_tickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilist_futures_funding_rate_historyGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilist_batch_futures_funding_ratesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilist_futures_insurance_ledgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilist_contract_statsGET /futures/{settle}/contract_statsFutures statistics
FuturesApiget_index_constituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilist_liquidated_ordersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilist_futures_risk_limit_tiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilist_futures_accountsGET /futures/{settle}/accountsGet futures account
FuturesApilist_futures_account_bookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilist_positionsGET /futures/{settle}/positionsGet user position list
FuturesApilist_positions_timerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApiget_positionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApiget_leverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdate_position_marginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdate_position_leveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdate_contract_position_leveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdate_position_cross_modePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdate_dual_comp_position_cross_modePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdate_position_risk_limitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApiset_dual_modePOST /futures/{settle}/dual_modeSet position mode
FuturesApiset_position_modePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApiget_dual_mode_positionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdate_dual_mode_position_marginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdate_dual_mode_position_leveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdate_dual_mode_position_risk_limitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilist_futures_ordersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreate_futures_orderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancel_futures_ordersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApiget_orders_with_time_rangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreate_batch_futures_orderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApiget_futures_orderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamend_futures_orderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancel_futures_orderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApiget_my_tradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApiget_my_trades_with_time_rangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilist_position_closeGET /futures/{settle}/position_closeQuery position close history
FuturesApilist_liquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilist_auto_deleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdown_cancel_all_futuresPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApiget_futures_feeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancel_batch_future_ordersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamend_batch_future_ordersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApiget_futures_risk_limit_tableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreate_futures_bbo_orderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistop_trail_orderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistop_all_trail_ordersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApiget_trail_ordersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApiget_trail_order_detailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApiget_trail_order_change_logGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApicreate_chase_orderPOST /futures/{settle}/autoorder/v1/chase/createCreate a chase order
FuturesApistop_chase_orderPOST /futures/{settle}/autoorder/v1/chase/stopStop a chase order
FuturesApistop_all_chase_ordersPOST /futures/{settle}/autoorder/v1/chase/stop_allStop chase orders in batch
FuturesApiget_chase_ordersGET /futures/{settle}/autoorder/v1/chase/listList chase orders
FuturesApiget_chase_order_detailGET /futures/{settle}/autoorder/v1/chase/detailGet chase order detail
FuturesApilist_price_triggered_ordersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreate_price_triggered_orderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancel_price_triggered_order_listDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApiget_price_triggered_orderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancel_price_triggered_orderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdate_price_triggered_orderPUT /futures/{settle}/price_orders/amendModify a Single Auto Order
MarginApilist_margin_accountsGET /margin/accountsMargin account list
MarginApilist_margin_account_bookGET /margin/account_bookQuery margin account balance change history
MarginApilist_funding_accountsGET /margin/funding_accountsFunding account list
MarginApiget_auto_repay_statusGET /margin/auto_repayQuery user auto repayment settings
MarginApiset_auto_repayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApiget_margin_transferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApiget_user_margin_tierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApiget_market_margin_tierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApiset_user_market_leveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilist_margin_user_accountGET /margin/user/accountQuery user's isolated margin account list
MarginApilist_cross_margin_loansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilist_cross_margin_repaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MultiCollateralLoanApilist_multi_collateral_ordersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreate_multi_collateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApiget_multi_collateral_order_detailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilist_multi_repay_recordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepay_multi_collateral_loanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilist_multi_collateral_recordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperate_multi_collateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilist_user_currency_quotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilist_multi_collateral_currenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApiget_multi_collateral_ltvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApiget_multi_collateral_fix_rateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApiget_multi_collateral_current_rateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OptionsApilist_options_underlyingsGET /options/underlyingsList all underlying assets
OptionsApilist_options_expirationsGET /options/expirationsList all expiration dates
OptionsApilist_options_contractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApiget_options_contractGET /options/contracts/{contract}Query specified contract details
OptionsApilist_options_settlementsGET /options/settlementsList settlement history
OptionsApiget_options_settlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilist_my_options_settlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilist_options_order_bookGET /options/order_bookQuery options contract order book
OptionsApilist_options_tickersGET /options/tickersQuery options market ticker information
OptionsApilist_options_underlying_tickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilist_options_candlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilist_options_underlying_candlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilist_options_tradesGET /options/tradesMarket trade records
OptionsApilist_options_accountGET /options/accountsQuery account information
OptionsApilist_options_account_bookGET /options/account_bookQuery account change history
OptionsApilist_options_positionsGET /options/positionsList user's positions of specified underlying
OptionsApiget_options_positionGET /options/positions/{contract}Get specified contract position
OptionsApilist_options_position_closeGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilist_options_ordersGET /options/ordersList options orders
OptionsApicreate_options_orderPOST /options/ordersCreate an options order
OptionsApicancel_options_ordersDELETE /options/ordersCancel all orders with 'open' status
OptionsApiget_options_orderGET /options/orders/{order_id}Query single order details
OptionsApiamend_options_orderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancel_options_orderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdown_cancel_all_optionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilist_my_options_tradesGET /options/my_tradesQuery personal trading records
OptionsApiget_options_mmpGET /options/mmpMMP Query.
OptionsApiset_options_mmpPOST /options/mmpMMP Settings
OptionsApireset_options_mmpPOST /options/mmp/resetMMP Reset
P2pApip2p_merchant_account_get_user_infoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2p_merchant_account_get_counterparty_user_infoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2p_merchant_account_get_myself_paymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2p_merchant_account_set_merchant_work_hoursPOST /p2p/merchant/account/set_merchant_work_hoursSet merchant working status and custom working hours
P2pApip2p_merchant_transaction_get_pending_transaction_listPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2p_merchant_transaction_get_completed_transaction_listPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2p_merchant_transaction_get_transaction_detailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2p_merchant_transaction_confirm_paymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2p_merchant_transaction_confirm_receiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2p_merchant_transaction_cancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2p_merchant_books_place_biz_push_orderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2p_merchant_books_ads_update_statusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2p_merchant_books_ads_detailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2p_merchant_books_my_ads_listPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2p_merchant_books_ads_listPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2p_merchant_chat_get_chats_listPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2p_merchant_chat_send_chat_messagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2p_merchant_chat_upload_chat_filePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagency_transaction_historyGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagency_commissions_historyGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartner_transaction_historyGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartner_commissions_historyGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartner_sub_listGET /rebate/partner/sub_listPartner subordinate list
RebateApirebate_broker_commission_historyGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebate_broker_transaction_historyGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebate_user_infoGET /rebate/user/infoUser obtains rebate information
RebateApiuser_sub_relationGET /rebate/user/sub_relationUser subordinate relationship
RebateApiget_partner_application_recentGET /rebate/partner/applications/recentGet recent partner application records
RebateApiget_partner_eligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApiget_partner_agent_data_aggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilist_currenciesGET /spot/currenciesQuery all currency information
SpotApiget_currencyGET /spot/currencies/{currency}Query single currency information
SpotApilist_currency_pairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApiget_currency_pairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilist_tickersGET /spot/tickersGet currency pair ticker information
SpotApilist_order_bookGET /spot/order_bookGet market depth information
SpotApilist_tradesGET /spot/tradesQuery market transaction records
SpotApilist_candlesticksGET /spot/candlesticksMarket K-line chart
SpotApiget_feeGET /spot/feeQuery account fee rates
SpotApiget_batch_spot_feeGET /spot/batch_feeBatch query account fee rates
SpotApilist_spot_accountsGET /spot/accountsList spot trading accounts
SpotApilist_spot_account_bookGET /spot/account_bookQuery spot account transaction history
SpotApicreate_batch_ordersPOST /spot/batch_ordersBatch place orders
SpotApilist_all_open_ordersGET /spot/open_ordersList all open orders
SpotApicreate_cross_liquidate_orderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilist_ordersGET /spot/ordersList orders
SpotApicreate_orderPOST /spot/ordersCreate order
SpotApicancel_ordersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancel_batch_ordersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApiget_orderGET /spot/orders/{order_id}Query single order details
SpotApicancel_orderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamend_orderPATCH /spot/orders/{order_id}Amend single order
SpotApilist_my_tradesGET /spot/my_tradesQuery personal trading records
SpotApiget_system_timeGET /spot/timeGet server current time
SpotApicountdown_cancel_all_spotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamend_batch_ordersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApiget_spot_insurance_historyGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilist_spot_price_triggered_ordersGET /spot/price_ordersQuery running auto order list
SpotApicreate_spot_price_triggered_orderPOST /spot/price_ordersCreate price-triggered order
SpotApicancel_spot_price_triggered_order_listDELETE /spot/price_ordersCancel all auto orders
SpotApiget_spot_price_triggered_orderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancel_spot_price_triggered_orderDELETE /spot/price_orders/{order_id}Cancel single auto order
SpotApilist_spot_pov_ordersGET /spot/pov_ordersList Spot POV orders
SpotApicreate_spot_pov_orderPOST /spot/pov_ordersCreate a Spot POV order
SpotApicancel_spot_pov_ordersDELETE /spot/pov_ordersCancel Spot POV orders
SpotApiget_spot_pov_orderGET /spot/pov_orders/{order_id}Query Spot POV order details
SpotApicancel_spot_pov_orderDELETE /spot/pov_orders/{order_id}Cancel a Spot POV order
SquareApilist_square_ai_searchGET /social/message/searchAI MCP Dynamic Search
SquareApilist_live_replayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
WalletApilist_currency_chainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApiget_deposit_addressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilist_withdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilist_depositsGET /wallet/depositsGet deposit records
WalletApiget_transferGET /wallet/transfersGet trading account transfer
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilist_sub_account_transfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransfer_with_sub_accountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisub_account_to_sub_accountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApiget_transfer_order_statusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilist_withdraw_statusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilist_sub_account_balancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilist_sub_account_margin_balancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilist_sub_account_futures_balancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilist_sub_account_cross_margin_balancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilist_saved_addressGET /wallet/saved_addressQuery saved address
WalletApiget_trade_feeGET /wallet/feeQuery personal trading fees
WalletApiget_total_balanceGET /wallet/total_balanceQuery personal account totals
WalletApilist_small_balanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvert_small_balancePOST /wallet/small_balanceConvert small balance currency
WalletApilist_small_balance_historyGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilist_push_ordersGET /wallet/pushGet UID transfer history
WalletApiget_low_cap_exchange_listGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApiget_user_identityGET /rewards/getUserIdentityGet user identity
WelfareApiget_beginner_task_listGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaim_taskPOST /rewards/claimTaskGet the task
WelfareApiclaim_rewardPOST /rewards/claimRewardReceive mission rewards
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdraw_push_orderPOST /withdrawals/pushUID transfer
WithdrawalApicancel_withdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

apiv4

Authentication with APIv4 key and secret

For details, refer to: APIv4 signed request requirements

Author

support@mail.gate.com

About

No description, website, or topics provided.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - gate/gateapi-python · GitHub
Skip to content

Repository files navigation

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 Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.129
  • Package version: 7.2.129
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gate.com/page/contacts

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly using:

pip install --user gate-api

Then import the package:

importgate_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgate_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.ActivityApi(api_client)
try:
# My activity entryapi_response=api_instance.get_my_activity_entry()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling ActivityApi->get_my_activity_entry: %s\n"%e)

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ActivityApiget_my_activity_entryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilist_activitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilist_activity_typesGET /rewards/activity/activity-typeActivity type list
CFDApiquery_mt5_account_infoGET /tradfi/users/mt5-accountQuery MT5 account information
CFDApiquery_categoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
CFDApiquery_symbol_commissionsGET /tradfi/symbols/commissionsQuery symbol commission rates
CFDApiquery_symbolsGET /tradfi/symbolsQuery trading symbol list
CFDApiquery_symbol_detailGET /tradfi/symbols/detailQuery trading symbol details
CFDApiquery_symbol_klineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
CFDApiquery_symbol_tickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
CFDApicreate_trad_fi_userPOST /tradfi/usersCreate CFD user
CFDApiquery_user_assetsGET /tradfi/users/assetsQuery account assets
CFDApiquery_transactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
CFDApicreate_transactionPOST /tradfi/transactionsFund transfer
CFDApiquery_order_listGET /tradfi/ordersQuery active order list
CFDApicreate_trad_fi_orderPOST /tradfi/ordersCreate order
CFDApiupdate_orderPUT /tradfi/orders/{order_id}Modify order
CFDApidelete_orderDELETE /tradfi/orders/{order_id}Cancel order
CFDApiquery_order_history_listGET /tradfi/orders/historyQuery historical order list
CFDApiquery_order_logGET /tradfi/orders/log/{log_id}Get order details by log ID
CFDApiquery_position_listGET /tradfi/positionsQuery active position list
CFDApiupdate_positionPUT /tradfi/positions/{position_id}Modify position
CFDApiclose_positionPOST /tradfi/positions/{position_id}/closeClose position
CFDApiquery_position_history_listGET /tradfi/positions/historyQuery historical position list
CrossExApilist_crossex_rule_symbolsGET /crossex/rule/symbolsQuery symbol information
CrossExApilist_crossex_rule_risk_limitsGET /crossex/rule/risk_limitsQuery risk limit information
CrossExApilist_crossex_transfer_coinsGET /crossex/transfers/coinQuery supported transfer currencies
CrossExApilist_crossex_transfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreate_crossex_transferPOST /crossex/transfersFund Transfer
CrossExApicreate_crossex_orderPOST /crossex/ordersCreate order
CrossExApicancel_batch_crossex_ordersPOST /crossex/batch_cancel_ordersBatch cancel orders
CrossExApiget_crossex_orderGET /crossex/orders/{order_id}Query order details
CrossExApiupdate_crossex_orderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancel_crossex_orderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreate_crossex_convert_quotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreate_crossex_convert_orderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApiget_crossex_accountGET /crossex/accountsQuery Account Assets
CrossExApiupdate_crossex_accountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApiget_crossex_positions_leverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_positions_leveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApiget_crossex_margin_positions_leverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_margin_positions_leveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApiclose_crossex_positionPOST /crossex/positionFull Close Position
CrossExApiget_crossex_positions_margin_modeGET /crossex/positions/margin_modeGet futures position margin mode
CrossExApiupdate_crossex_positions_margin_modePOST /crossex/positions/margin_modeUpdate futures position margin mode
CrossExApiupdate_crossex_positions_marginPOST /crossex/positions/marginIncrease or decrease isolated margin
CrossExApiget_crossex_interest_rateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApiget_crossex_feeGET /crossex/feeQuery User Fee Rates
CrossExApilist_crossex_positionsGET /crossex/positionsQuery Contract Positions
CrossExApilist_crossex_margin_positionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilist_crossex_adl_rankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilist_crossex_open_ordersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilist_crossex_history_ordersGET /crossex/history_ordersQuery order history
CrossExApilist_crossex_history_positionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilist_crossex_history_margin_positionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilist_crossex_history_margin_interestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilist_crossex_history_tradesGET /crossex/history_tradesQuery filled history
CrossExApilist_crossex_account_bookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilist_crossex_coin_discount_rateGET /crossex/coin_discount_rateQuery Currency Discount Rate
CrossExApilist_crossex_market_tickersGET /crossex/market/tickersGet exchange tickers
CrossExApilist_crossex_market_funding_infoGET /crossex/market/funding_infoGet exchange futures funding rate information
EarnUniApilist_uni_currenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApiget_uni_currencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilist_user_uni_lendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreate_uni_lendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichange_uni_lendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilist_uni_lend_recordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApiget_uni_interestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilist_uni_interest_recordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApiget_uni_interest_statusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilist_uni_chartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilist_uni_rateGET /earn/uni/rateCurrency estimated annualized interest rate
MarginUniApilist_uni_currency_pairsGET /margin/uni/currency_pairsList lending markets
MarginUniApiget_uni_currency_pairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApiget_margin_uni_estimate_rateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilist_uni_loansGET /margin/uni/loansQuery loans
MarginUniApicreate_uni_loanPOST /margin/uni/loansBorrow or repay
MarginUniApilist_uni_loan_recordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilist_uni_loan_interest_recordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApiget_uni_borrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
OTCApicreate_otc_quotePOST /otc/quoteFiat and stablecoin quote
OTCApicreate_otc_orderPOST /otc/order/createCreate fiat order
OTCApicreate_stable_coin_orderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApiget_bank_list_inner_pathGET /otc/bank/listGet user bank card list
OTCApicreate_otc_bankPOST /otc/bank/createCreate bank card
OTCApidelete_otc_bankPOST /otc/bank/deleteDelete bank card
OTCApiset_default_otc_bankPOST /otc/bank/set_defaultSet default bank card
OTCApiget_otc_bank_supplement_checklistGET /otc/bank/bank_supplement_checklistQuery the checklist of materials to supplement for a bank card
OTCApisubmit_otc_bank_personal_supplementPOST /otc/bank/personal/bank_supplementSubmit Bank Card Supplement Materials (Personal)
OTCApisubmit_otc_bank_enterprise_supplementPOST /otc/bank/enterprise/bank_supplementSubmit Bank Card Supplement Materials (Enterprise)
OTCApimark_otc_order_paidPOST /otc/order/paidMark fiat order as paid (deposit confirmation)
OTCApicancel_otc_orderPOST /otc/order/cancelFiat order cancellation
OTCApilist_otc_ordersGET /otc/order/listFiat order list
OTCApilist_stable_coin_ordersGET /otc/stable_coin/order/listStablecoin order list
OTCApiget_otc_order_detailGET /otc/order/detailFiat order details
StockApiquery_stock_user_assetsGET /stock/users/assetsQuery user assets
StockApiquery_stock_symbolsGET /stock/symbolsQuery symbol list
StockApiquery_stock_symbol_detailGET /stock/symbols/detailQuery symbol details
StockApiquery_stock_order_bookGET /stock/market/{symbol}/orderbookQuery market order book
StockApiquery_stock_order_listGET /stock/ordersQuery open order list
StockApicreate_stock_orderPOST /stock/ordersCreate order
StockApidelete_all_stock_ordersDELETE /stock/ordersCancel all open orders
StockApiquery_stock_order_historyGET /stock/orders/historyQuery historical order list
StockApiupdate_stock_orderPUT /stock/orders/{order_id}Modify order
StockApidelete_stock_orderDELETE /stock/orders/{order_id}Cancel order
StockApiquery_stock_positionsGET /stock/positionsQuery current position list
StockApiclose_stock_positionPOST /stock/positions/closeClose position
StockApiquery_stock_transactionsGET /stock/transactionsQuery transaction records
StockApicreate_stock_transactionPOST /stock/transactionsFund transfer
StockApiquery_stock_exchangesGET /stock/exchangesQuery supported exchanges
StockApiquery_stock_fee_rateGET /stock/fee-rateQuery fee rates for Japanese and Korean stocks
SubAccountApilist_sub_accountsGET /sub_accountsList sub-accounts
SubAccountApicreate_sub_accountsPOST /sub_accountsCreate a new sub-account
SubAccountApiget_sub_accountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilist_sub_account_keysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreate_sub_account_keysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApiget_sub_account_keyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdate_sub_account_keysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApidelete_sub_account_keysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilock_sub_accountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlock_sub_accountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilist_unified_modeGET /sub_accounts/unified_modeGet sub-account mode
UnifiedApilist_unified_accountsGET /unified/accountsGet unified account information
UnifiedApiget_unified_borrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApiget_unified_transferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApiget_unified_transferablesGET /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
UnifiedApiget_unified_borrowable_listGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilist_unified_loansGET /unified/loansQuery loans
UnifiedApicreate_unified_loanPOST /unified/loansBorrow or repay
UnifiedApilist_unified_loan_recordsGET /unified/loan_recordsQuery loan records
UnifiedApilist_unified_loan_interest_recordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApiget_unified_risk_unitsGET /unified/risk_unitsGet user risk unit details
UnifiedApiget_unified_modeGET /unified/unified_modeQuery mode of the unified account
UnifiedApiset_unified_modePUT /unified/unified_modeSet unified account mode
UnifiedApiget_unified_estimate_rateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilist_currency_discount_tiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilist_loan_margin_tiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculate_portfolio_marginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApiset_user_leveragePOST /unified/leverage/user_settingSet leverage for all of the user's borrowed currencies
UnifiedApiget_user_leverage_currency_configGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApiget_user_leverage_currency_settingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApiset_user_leverage_currency_settingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilist_unified_currenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApiget_history_loan_rateGET /unified/history_loan_rateGet historical lending rates
UnifiedApiset_unified_collateralPOST /unified/collateral_currenciesSet collateral currency
UnifiedApiget_estimated_quick_repaymentGET /unified/estimated_quick_repaymentEstimated quick repayment details
UnifiedApicreate_quick_repaymentPOST /unified/quick_repaymentQuick repayment
UnifiedApiget_unified_delta_neutralGET /unified/delta_neutralQuery the account Delta-neutral strategy mode setting
UnifiedApiset_unified_delta_neutralPOST /unified/delta_neutralSet the account Delta-neutral strategy mode
AccountApiget_account_detailGET /account/detailRetrieve user account information
AccountApiget_account_main_keysGET /account/main_keysQuery All Main Account Key Information
AccountApiget_account_rate_limitGET /account/rate_limitGet user transaction rate limit information
AccountApilist_stp_groupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreate_stp_groupPOST /account/stp_groupsCreate STP user group
AccountApilist_stp_groups_usersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiadd_stp_group_usersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApidelete_stp_group_usersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApiget_debit_feeGET /account/debit_feeQuery GT fee deduction configuration
AccountApiset_debit_feePOST /account/debit_feeConfigure GT fee deduction
AlphaApilist_alpha_accountsGET /alpha/accountsAlpha Account API
AlphaApilist_alpha_account_bookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquote_alpha_orderPOST /alpha/quoteAlpha Quote API
AlphaApilist_alpha_orderGET /alpha/ordersAlpha Order List API
AlphaApiplace_alpha_orderPOST /alpha/ordersAlpha Order API
AlphaApiget_alpha_orderGET /alpha/orderAlpha Single Order Query API
AlphaApilist_alpha_currenciesGET /alpha/currenciesQuery currency information
AlphaApilist_alpha_tickersGET /alpha/tickersQuery currency ticker
AlphaApilist_alpha_tokensGET /alpha/tokensQuery Token Information
AssetswapApilist_asset_swap_assetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApiget_asset_swap_configGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluate_asset_swapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreate_asset_swap_order_v1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilist_asset_swap_orders_v1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreview_asset_swap_order_v1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApiget_asset_swap_order_v1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApiget_ai_hub_strategy_recommendGET /bot/strategy/recommendGet AIHub strategy recommendations
BotApipost_ai_hub_spot_grid_createPOST /bot/spot-grid/createCreate spot grid
BotApipost_ai_hub_margin_grid_createPOST /bot/margin-grid/createCreate a lever grid
BotApipost_ai_hub_infinite_grid_createPOST /bot/infinite-grid/createCreate infinite grid
BotApipost_ai_hub_futures_grid_createPOST /bot/futures-grid/createCreate a contract grid
BotApipost_ai_hub_spot_martingale_createPOST /bot/spot-martingale/createCreate Spot Martin
BotApipost_ai_hub_contract_martingale_createPOST /bot/contract-martingale/createCreate contract martin
BotApiget_ai_hub_portfolio_runningGET /bot/portfolio/runningQuery the list of running policies
BotApiget_ai_hub_portfolio_detailGET /bot/portfolio/detailQuery order policy details
BotApipost_ai_hub_portfolio_stopPOST /bot/portfolio/stopTerminate a single running policy
CouponApilist_user_couponsGET /coupon/user-coupon-listCoupon Center list
CouponApiget_user_coupon_detailGET /coupon/user-coupon-detailCoupon Center details
DeliveryApilist_delivery_contractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApiget_delivery_contractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilist_delivery_order_bookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilist_delivery_tradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilist_delivery_candlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilist_delivery_tickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilist_delivery_insurance_ledgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilist_delivery_accountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilist_delivery_account_bookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilist_delivery_positionsGET /delivery/{settle}/positionsGet user position list
DeliveryApiget_delivery_positionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdate_delivery_position_marginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdate_delivery_position_leveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdate_delivery_position_risk_limitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilist_delivery_ordersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreate_delivery_orderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancel_delivery_ordersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApiget_delivery_orderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancel_delivery_orderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApiget_my_delivery_tradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilist_delivery_position_closeGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilist_delivery_liquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilist_delivery_settlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilist_delivery_risk_limit_tiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilist_price_triggered_delivery_ordersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreate_price_triggered_delivery_orderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancel_price_triggered_delivery_order_listDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApiget_price_triggered_delivery_orderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancel_price_triggered_delivery_orderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilist_dual_investment_plansGET /earn/dual/investment_planDual Investment product list
EarnApilist_dual_ordersGET /earn/dual/ordersDual Investment order list
EarnApiplace_dual_orderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilist_dual_balanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApiget_dual_order_refund_previewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplace_dual_order_refundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodify_dual_order_reinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApiget_dual_project_recommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifind_coinGET /earn/staking/coinsStaking coins
EarnApiswap_staking_coinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorder_listGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiaward_listGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiasset_listGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreate_auto_invest_planPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdate_auto_invest_planPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistop_auto_invest_planPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiadd_position_auto_invest_planPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilist_auto_invest_coinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApiget_auto_invest_min_amountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilist_auto_invest_plan_recordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilist_auto_invest_ordersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilist_auto_invest_configGET /earn/autoinvest/configList investment currency configuration
EarnApiget_auto_invest_plan_detailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilist_auto_invest_plansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilist_earn_fixed_term_productsGET /earn/fixed-term/productGet product list
EarnApilist_earn_fixed_term_products_by_assetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilist_earn_fixed_term_lendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreate_earn_fixed_term_lendPOST /earn/fixed-term/user/lendSubscription
EarnApicreate_earn_fixed_term_pre_redeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilist_earn_fixed_term_historyGET /earn/fixed-term/user/historySubscription history
FlashSwapApilist_flash_swap_currency_pairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilist_flash_swap_ordersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreate_flash_swap_orderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApiget_flash_swap_orderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreview_flash_swap_orderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreate_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreview_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreate_flash_swap_order_v1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreate_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreview_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreview_flash_swap_order_v1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilist_futures_contractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApilist_futures_contracts_allGET /futures/{settle}/contracts_allQuery all contract information (including delisted)
FuturesApiget_futures_contractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilist_futures_adl_risk_statesGET /futures/{settle}/adl_risk_statesList market-level ADL risk states
FuturesApilist_futures_order_bookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilist_futures_tradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilist_futures_candlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilist_futures_premium_indexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilist_futures_tickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilist_futures_funding_rate_historyGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilist_batch_futures_funding_ratesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilist_futures_insurance_ledgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilist_contract_statsGET /futures/{settle}/contract_statsFutures statistics
FuturesApiget_index_constituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilist_liquidated_ordersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilist_futures_risk_limit_tiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilist_futures_accountsGET /futures/{settle}/accountsGet futures account
FuturesApilist_futures_account_bookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilist_positionsGET /futures/{settle}/positionsGet user position list
FuturesApilist_positions_timerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApiget_positionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApiget_leverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdate_position_marginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdate_position_leveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdate_contract_position_leveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdate_position_cross_modePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdate_dual_comp_position_cross_modePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdate_position_risk_limitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApiset_dual_modePOST /futures/{settle}/dual_modeSet position mode
FuturesApiset_position_modePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApiget_dual_mode_positionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdate_dual_mode_position_marginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdate_dual_mode_position_leveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdate_dual_mode_position_risk_limitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilist_futures_ordersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreate_futures_orderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancel_futures_ordersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApiget_orders_with_time_rangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreate_batch_futures_orderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApiget_futures_orderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamend_futures_orderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancel_futures_orderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApiget_my_tradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApiget_my_trades_with_time_rangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilist_position_closeGET /futures/{settle}/position_closeQuery position close history
FuturesApilist_liquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilist_auto_deleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdown_cancel_all_futuresPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApiget_futures_feeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancel_batch_future_ordersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamend_batch_future_ordersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApiget_futures_risk_limit_tableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreate_futures_bbo_orderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistop_trail_orderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistop_all_trail_ordersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApiget_trail_ordersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApiget_trail_order_detailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApiget_trail_order_change_logGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApicreate_chase_orderPOST /futures/{settle}/autoorder/v1/chase/createCreate a chase order
FuturesApistop_chase_orderPOST /futures/{settle}/autoorder/v1/chase/stopStop a chase order
FuturesApistop_all_chase_ordersPOST /futures/{settle}/autoorder/v1/chase/stop_allStop chase orders in batch
FuturesApiget_chase_ordersGET /futures/{settle}/autoorder/v1/chase/listList chase orders
FuturesApiget_chase_order_detailGET /futures/{settle}/autoorder/v1/chase/detailGet chase order detail
FuturesApilist_price_triggered_ordersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreate_price_triggered_orderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancel_price_triggered_order_listDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApiget_price_triggered_orderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancel_price_triggered_orderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdate_price_triggered_orderPUT /futures/{settle}/price_orders/amendModify a Single Auto Order
MarginApilist_margin_accountsGET /margin/accountsMargin account list
MarginApilist_margin_account_bookGET /margin/account_bookQuery margin account balance change history
MarginApilist_funding_accountsGET /margin/funding_accountsFunding account list
MarginApiget_auto_repay_statusGET /margin/auto_repayQuery user auto repayment settings
MarginApiset_auto_repayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApiget_margin_transferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApiget_user_margin_tierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApiget_market_margin_tierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApiset_user_market_leveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilist_margin_user_accountGET /margin/user/accountQuery user's isolated margin account list
MarginApilist_cross_margin_loansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilist_cross_margin_repaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MultiCollateralLoanApilist_multi_collateral_ordersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreate_multi_collateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApiget_multi_collateral_order_detailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilist_multi_repay_recordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepay_multi_collateral_loanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilist_multi_collateral_recordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperate_multi_collateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilist_user_currency_quotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilist_multi_collateral_currenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApiget_multi_collateral_ltvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApiget_multi_collateral_fix_rateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApiget_multi_collateral_current_rateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OptionsApilist_options_underlyingsGET /options/underlyingsList all underlying assets
OptionsApilist_options_expirationsGET /options/expirationsList all expiration dates
OptionsApilist_options_contractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApiget_options_contractGET /options/contracts/{contract}Query specified contract details
OptionsApilist_options_settlementsGET /options/settlementsList settlement history
OptionsApiget_options_settlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilist_my_options_settlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilist_options_order_bookGET /options/order_bookQuery options contract order book
OptionsApilist_options_tickersGET /options/tickersQuery options market ticker information
OptionsApilist_options_underlying_tickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilist_options_candlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilist_options_underlying_candlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilist_options_tradesGET /options/tradesMarket trade records
OptionsApilist_options_accountGET /options/accountsQuery account information
OptionsApilist_options_account_bookGET /options/account_bookQuery account change history
OptionsApilist_options_positionsGET /options/positionsList user's positions of specified underlying
OptionsApiget_options_positionGET /options/positions/{contract}Get specified contract position
OptionsApilist_options_position_closeGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilist_options_ordersGET /options/ordersList options orders
OptionsApicreate_options_orderPOST /options/ordersCreate an options order
OptionsApicancel_options_ordersDELETE /options/ordersCancel all orders with 'open' status
OptionsApiget_options_orderGET /options/orders/{order_id}Query single order details
OptionsApiamend_options_orderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancel_options_orderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdown_cancel_all_optionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilist_my_options_tradesGET /options/my_tradesQuery personal trading records
OptionsApiget_options_mmpGET /options/mmpMMP Query.
OptionsApiset_options_mmpPOST /options/mmpMMP Settings
OptionsApireset_options_mmpPOST /options/mmp/resetMMP Reset
P2pApip2p_merchant_account_get_user_infoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2p_merchant_account_get_counterparty_user_infoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2p_merchant_account_get_myself_paymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2p_merchant_account_set_merchant_work_hoursPOST /p2p/merchant/account/set_merchant_work_hoursSet merchant working status and custom working hours
P2pApip2p_merchant_transaction_get_pending_transaction_listPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2p_merchant_transaction_get_completed_transaction_listPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2p_merchant_transaction_get_transaction_detailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2p_merchant_transaction_confirm_paymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2p_merchant_transaction_confirm_receiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2p_merchant_transaction_cancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2p_merchant_books_place_biz_push_orderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2p_merchant_books_ads_update_statusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2p_merchant_books_ads_detailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2p_merchant_books_my_ads_listPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2p_merchant_books_ads_listPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2p_merchant_chat_get_chats_listPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2p_merchant_chat_send_chat_messagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2p_merchant_chat_upload_chat_filePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagency_transaction_historyGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagency_commissions_historyGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartner_transaction_historyGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartner_commissions_historyGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartner_sub_listGET /rebate/partner/sub_listPartner subordinate list
RebateApirebate_broker_commission_historyGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebate_broker_transaction_historyGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebate_user_infoGET /rebate/user/infoUser obtains rebate information
RebateApiuser_sub_relationGET /rebate/user/sub_relationUser subordinate relationship
RebateApiget_partner_application_recentGET /rebate/partner/applications/recentGet recent partner application records
RebateApiget_partner_eligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApiget_partner_agent_data_aggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilist_currenciesGET /spot/currenciesQuery all currency information
SpotApiget_currencyGET /spot/currencies/{currency}Query single currency information
SpotApilist_currency_pairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApiget_currency_pairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilist_tickersGET /spot/tickersGet currency pair ticker information
SpotApilist_order_bookGET /spot/order_bookGet market depth information
SpotApilist_tradesGET /spot/tradesQuery market transaction records
SpotApilist_candlesticksGET /spot/candlesticksMarket K-line chart
SpotApiget_feeGET /spot/feeQuery account fee rates
SpotApiget_batch_spot_feeGET /spot/batch_feeBatch query account fee rates
SpotApilist_spot_accountsGET /spot/accountsList spot trading accounts
SpotApilist_spot_account_bookGET /spot/account_bookQuery spot account transaction history
SpotApicreate_batch_ordersPOST /spot/batch_ordersBatch place orders
SpotApilist_all_open_ordersGET /spot/open_ordersList all open orders
SpotApicreate_cross_liquidate_orderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilist_ordersGET /spot/ordersList orders
SpotApicreate_orderPOST /spot/ordersCreate order
SpotApicancel_ordersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancel_batch_ordersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApiget_orderGET /spot/orders/{order_id}Query single order details
SpotApicancel_orderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamend_orderPATCH /spot/orders/{order_id}Amend single order
SpotApilist_my_tradesGET /spot/my_tradesQuery personal trading records
SpotApiget_system_timeGET /spot/timeGet server current time
SpotApicountdown_cancel_all_spotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamend_batch_ordersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApiget_spot_insurance_historyGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilist_spot_price_triggered_ordersGET /spot/price_ordersQuery running auto order list
SpotApicreate_spot_price_triggered_orderPOST /spot/price_ordersCreate price-triggered order
SpotApicancel_spot_price_triggered_order_listDELETE /spot/price_ordersCancel all auto orders
SpotApiget_spot_price_triggered_orderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancel_spot_price_triggered_orderDELETE /spot/price_orders/{order_id}Cancel single auto order
SpotApilist_spot_pov_ordersGET /spot/pov_ordersList Spot POV orders
SpotApicreate_spot_pov_orderPOST /spot/pov_ordersCreate a Spot POV order
SpotApicancel_spot_pov_ordersDELETE /spot/pov_ordersCancel Spot POV orders
SpotApiget_spot_pov_orderGET /spot/pov_orders/{order_id}Query Spot POV order details
SpotApicancel_spot_pov_orderDELETE /spot/pov_orders/{order_id}Cancel a Spot POV order
SquareApilist_square_ai_searchGET /social/message/searchAI MCP Dynamic Search
SquareApilist_live_replayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
WalletApilist_currency_chainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApiget_deposit_addressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilist_withdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilist_depositsGET /wallet/depositsGet deposit records
WalletApiget_transferGET /wallet/transfersGet trading account transfer
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilist_sub_account_transfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransfer_with_sub_accountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisub_account_to_sub_accountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApiget_transfer_order_statusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilist_withdraw_statusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilist_sub_account_balancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilist_sub_account_margin_balancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilist_sub_account_futures_balancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilist_sub_account_cross_margin_balancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilist_saved_addressGET /wallet/saved_addressQuery saved address
WalletApiget_trade_feeGET /wallet/feeQuery personal trading fees
WalletApiget_total_balanceGET /wallet/total_balanceQuery personal account totals
WalletApilist_small_balanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvert_small_balancePOST /wallet/small_balanceConvert small balance currency
WalletApilist_small_balance_historyGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilist_push_ordersGET /wallet/pushGet UID transfer history
WalletApiget_low_cap_exchange_listGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApiget_user_identityGET /rewards/getUserIdentityGet user identity
WelfareApiget_beginner_task_listGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaim_taskPOST /rewards/claimTaskGet the task
WelfareApiclaim_rewardPOST /rewards/claimRewardReceive mission rewards
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdraw_push_orderPOST /withdrawals/pushUID transfer
WithdrawalApicancel_withdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

apiv4

Authentication with APIv4 key and secret

For details, refer to: APIv4 signed request requirements

Author

support@mail.gate.com

About

No description, website, or topics provided.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - gate/gateapi-python · GitHub
Skip to content

Repository files navigation

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 Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.129
  • Package version: 7.2.129
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gate.com/page/contacts

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly using:

pip install --user gate-api

Then import the package:

importgate_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgate_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.ActivityApi(api_client)
try:
# My activity entryapi_response=api_instance.get_my_activity_entry()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling ActivityApi->get_my_activity_entry: %s\n"%e)

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ActivityApiget_my_activity_entryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilist_activitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilist_activity_typesGET /rewards/activity/activity-typeActivity type list
CFDApiquery_mt5_account_infoGET /tradfi/users/mt5-accountQuery MT5 account information
CFDApiquery_categoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
CFDApiquery_symbol_commissionsGET /tradfi/symbols/commissionsQuery symbol commission rates
CFDApiquery_symbolsGET /tradfi/symbolsQuery trading symbol list
CFDApiquery_symbol_detailGET /tradfi/symbols/detailQuery trading symbol details
CFDApiquery_symbol_klineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
CFDApiquery_symbol_tickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
CFDApicreate_trad_fi_userPOST /tradfi/usersCreate CFD user
CFDApiquery_user_assetsGET /tradfi/users/assetsQuery account assets
CFDApiquery_transactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
CFDApicreate_transactionPOST /tradfi/transactionsFund transfer
CFDApiquery_order_listGET /tradfi/ordersQuery active order list
CFDApicreate_trad_fi_orderPOST /tradfi/ordersCreate order
CFDApiupdate_orderPUT /tradfi/orders/{order_id}Modify order
CFDApidelete_orderDELETE /tradfi/orders/{order_id}Cancel order
CFDApiquery_order_history_listGET /tradfi/orders/historyQuery historical order list
CFDApiquery_order_logGET /tradfi/orders/log/{log_id}Get order details by log ID
CFDApiquery_position_listGET /tradfi/positionsQuery active position list
CFDApiupdate_positionPUT /tradfi/positions/{position_id}Modify position
CFDApiclose_positionPOST /tradfi/positions/{position_id}/closeClose position
CFDApiquery_position_history_listGET /tradfi/positions/historyQuery historical position list
CrossExApilist_crossex_rule_symbolsGET /crossex/rule/symbolsQuery symbol information
CrossExApilist_crossex_rule_risk_limitsGET /crossex/rule/risk_limitsQuery risk limit information
CrossExApilist_crossex_transfer_coinsGET /crossex/transfers/coinQuery supported transfer currencies
CrossExApilist_crossex_transfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreate_crossex_transferPOST /crossex/transfersFund Transfer
CrossExApicreate_crossex_orderPOST /crossex/ordersCreate order
CrossExApicancel_batch_crossex_ordersPOST /crossex/batch_cancel_ordersBatch cancel orders
CrossExApiget_crossex_orderGET /crossex/orders/{order_id}Query order details
CrossExApiupdate_crossex_orderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancel_crossex_orderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreate_crossex_convert_quotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreate_crossex_convert_orderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApiget_crossex_accountGET /crossex/accountsQuery Account Assets
CrossExApiupdate_crossex_accountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApiget_crossex_positions_leverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_positions_leveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApiget_crossex_margin_positions_leverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_margin_positions_leveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApiclose_crossex_positionPOST /crossex/positionFull Close Position
CrossExApiget_crossex_positions_margin_modeGET /crossex/positions/margin_modeGet futures position margin mode
CrossExApiupdate_crossex_positions_margin_modePOST /crossex/positions/margin_modeUpdate futures position margin mode
CrossExApiupdate_crossex_positions_marginPOST /crossex/positions/marginIncrease or decrease isolated margin
CrossExApiget_crossex_interest_rateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApiget_crossex_feeGET /crossex/feeQuery User Fee Rates
CrossExApilist_crossex_positionsGET /crossex/positionsQuery Contract Positions
CrossExApilist_crossex_margin_positionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilist_crossex_adl_rankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilist_crossex_open_ordersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilist_crossex_history_ordersGET /crossex/history_ordersQuery order history
CrossExApilist_crossex_history_positionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilist_crossex_history_margin_positionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilist_crossex_history_margin_interestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilist_crossex_history_tradesGET /crossex/history_tradesQuery filled history
CrossExApilist_crossex_account_bookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilist_crossex_coin_discount_rateGET /crossex/coin_discount_rateQuery Currency Discount Rate
CrossExApilist_crossex_market_tickersGET /crossex/market/tickersGet exchange tickers
CrossExApilist_crossex_market_funding_infoGET /crossex/market/funding_infoGet exchange futures funding rate information
EarnUniApilist_uni_currenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApiget_uni_currencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilist_user_uni_lendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreate_uni_lendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichange_uni_lendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilist_uni_lend_recordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApiget_uni_interestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilist_uni_interest_recordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApiget_uni_interest_statusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilist_uni_chartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilist_uni_rateGET /earn/uni/rateCurrency estimated annualized interest rate
MarginUniApilist_uni_currency_pairsGET /margin/uni/currency_pairsList lending markets
MarginUniApiget_uni_currency_pairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApiget_margin_uni_estimate_rateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilist_uni_loansGET /margin/uni/loansQuery loans
MarginUniApicreate_uni_loanPOST /margin/uni/loansBorrow or repay
MarginUniApilist_uni_loan_recordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilist_uni_loan_interest_recordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApiget_uni_borrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
OTCApicreate_otc_quotePOST /otc/quoteFiat and stablecoin quote
OTCApicreate_otc_orderPOST /otc/order/createCreate fiat order
OTCApicreate_stable_coin_orderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApiget_bank_list_inner_pathGET /otc/bank/listGet user bank card list
OTCApicreate_otc_bankPOST /otc/bank/createCreate bank card
OTCApidelete_otc_bankPOST /otc/bank/deleteDelete bank card
OTCApiset_default_otc_bankPOST /otc/bank/set_defaultSet default bank card
OTCApiget_otc_bank_supplement_checklistGET /otc/bank/bank_supplement_checklistQuery the checklist of materials to supplement for a bank card
OTCApisubmit_otc_bank_personal_supplementPOST /otc/bank/personal/bank_supplementSubmit Bank Card Supplement Materials (Personal)
OTCApisubmit_otc_bank_enterprise_supplementPOST /otc/bank/enterprise/bank_supplementSubmit Bank Card Supplement Materials (Enterprise)
OTCApimark_otc_order_paidPOST /otc/order/paidMark fiat order as paid (deposit confirmation)
OTCApicancel_otc_orderPOST /otc/order/cancelFiat order cancellation
OTCApilist_otc_ordersGET /otc/order/listFiat order list
OTCApilist_stable_coin_ordersGET /otc/stable_coin/order/listStablecoin order list
OTCApiget_otc_order_detailGET /otc/order/detailFiat order details
StockApiquery_stock_user_assetsGET /stock/users/assetsQuery user assets
StockApiquery_stock_symbolsGET /stock/symbolsQuery symbol list
StockApiquery_stock_symbol_detailGET /stock/symbols/detailQuery symbol details
StockApiquery_stock_order_bookGET /stock/market/{symbol}/orderbookQuery market order book
StockApiquery_stock_order_listGET /stock/ordersQuery open order list
StockApicreate_stock_orderPOST /stock/ordersCreate order
StockApidelete_all_stock_ordersDELETE /stock/ordersCancel all open orders
StockApiquery_stock_order_historyGET /stock/orders/historyQuery historical order list
StockApiupdate_stock_orderPUT /stock/orders/{order_id}Modify order
StockApidelete_stock_orderDELETE /stock/orders/{order_id}Cancel order
StockApiquery_stock_positionsGET /stock/positionsQuery current position list
StockApiclose_stock_positionPOST /stock/positions/closeClose position
StockApiquery_stock_transactionsGET /stock/transactionsQuery transaction records
StockApicreate_stock_transactionPOST /stock/transactionsFund transfer
StockApiquery_stock_exchangesGET /stock/exchangesQuery supported exchanges
StockApiquery_stock_fee_rateGET /stock/fee-rateQuery fee rates for Japanese and Korean stocks
SubAccountApilist_sub_accountsGET /sub_accountsList sub-accounts
SubAccountApicreate_sub_accountsPOST /sub_accountsCreate a new sub-account
SubAccountApiget_sub_accountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilist_sub_account_keysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreate_sub_account_keysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApiget_sub_account_keyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdate_sub_account_keysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApidelete_sub_account_keysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilock_sub_accountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlock_sub_accountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilist_unified_modeGET /sub_accounts/unified_modeGet sub-account mode
UnifiedApilist_unified_accountsGET /unified/accountsGet unified account information
UnifiedApiget_unified_borrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApiget_unified_transferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApiget_unified_transferablesGET /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
UnifiedApiget_unified_borrowable_listGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilist_unified_loansGET /unified/loansQuery loans
UnifiedApicreate_unified_loanPOST /unified/loansBorrow or repay
UnifiedApilist_unified_loan_recordsGET /unified/loan_recordsQuery loan records
UnifiedApilist_unified_loan_interest_recordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApiget_unified_risk_unitsGET /unified/risk_unitsGet user risk unit details
UnifiedApiget_unified_modeGET /unified/unified_modeQuery mode of the unified account
UnifiedApiset_unified_modePUT /unified/unified_modeSet unified account mode
UnifiedApiget_unified_estimate_rateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilist_currency_discount_tiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilist_loan_margin_tiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculate_portfolio_marginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApiset_user_leveragePOST /unified/leverage/user_settingSet leverage for all of the user's borrowed currencies
UnifiedApiget_user_leverage_currency_configGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApiget_user_leverage_currency_settingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApiset_user_leverage_currency_settingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilist_unified_currenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApiget_history_loan_rateGET /unified/history_loan_rateGet historical lending rates
UnifiedApiset_unified_collateralPOST /unified/collateral_currenciesSet collateral currency
UnifiedApiget_estimated_quick_repaymentGET /unified/estimated_quick_repaymentEstimated quick repayment details
UnifiedApicreate_quick_repaymentPOST /unified/quick_repaymentQuick repayment
UnifiedApiget_unified_delta_neutralGET /unified/delta_neutralQuery the account Delta-neutral strategy mode setting
UnifiedApiset_unified_delta_neutralPOST /unified/delta_neutralSet the account Delta-neutral strategy mode
AccountApiget_account_detailGET /account/detailRetrieve user account information
AccountApiget_account_main_keysGET /account/main_keysQuery All Main Account Key Information
AccountApiget_account_rate_limitGET /account/rate_limitGet user transaction rate limit information
AccountApilist_stp_groupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreate_stp_groupPOST /account/stp_groupsCreate STP user group
AccountApilist_stp_groups_usersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiadd_stp_group_usersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApidelete_stp_group_usersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApiget_debit_feeGET /account/debit_feeQuery GT fee deduction configuration
AccountApiset_debit_feePOST /account/debit_feeConfigure GT fee deduction
AlphaApilist_alpha_accountsGET /alpha/accountsAlpha Account API
AlphaApilist_alpha_account_bookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquote_alpha_orderPOST /alpha/quoteAlpha Quote API
AlphaApilist_alpha_orderGET /alpha/ordersAlpha Order List API
AlphaApiplace_alpha_orderPOST /alpha/ordersAlpha Order API
AlphaApiget_alpha_orderGET /alpha/orderAlpha Single Order Query API
AlphaApilist_alpha_currenciesGET /alpha/currenciesQuery currency information
AlphaApilist_alpha_tickersGET /alpha/tickersQuery currency ticker
AlphaApilist_alpha_tokensGET /alpha/tokensQuery Token Information
AssetswapApilist_asset_swap_assetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApiget_asset_swap_configGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluate_asset_swapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreate_asset_swap_order_v1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilist_asset_swap_orders_v1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreview_asset_swap_order_v1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApiget_asset_swap_order_v1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApiget_ai_hub_strategy_recommendGET /bot/strategy/recommendGet AIHub strategy recommendations
BotApipost_ai_hub_spot_grid_createPOST /bot/spot-grid/createCreate spot grid
BotApipost_ai_hub_margin_grid_createPOST /bot/margin-grid/createCreate a lever grid
BotApipost_ai_hub_infinite_grid_createPOST /bot/infinite-grid/createCreate infinite grid
BotApipost_ai_hub_futures_grid_createPOST /bot/futures-grid/createCreate a contract grid
BotApipost_ai_hub_spot_martingale_createPOST /bot/spot-martingale/createCreate Spot Martin
BotApipost_ai_hub_contract_martingale_createPOST /bot/contract-martingale/createCreate contract martin
BotApiget_ai_hub_portfolio_runningGET /bot/portfolio/runningQuery the list of running policies
BotApiget_ai_hub_portfolio_detailGET /bot/portfolio/detailQuery order policy details
BotApipost_ai_hub_portfolio_stopPOST /bot/portfolio/stopTerminate a single running policy
CouponApilist_user_couponsGET /coupon/user-coupon-listCoupon Center list
CouponApiget_user_coupon_detailGET /coupon/user-coupon-detailCoupon Center details
DeliveryApilist_delivery_contractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApiget_delivery_contractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilist_delivery_order_bookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilist_delivery_tradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilist_delivery_candlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilist_delivery_tickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilist_delivery_insurance_ledgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilist_delivery_accountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilist_delivery_account_bookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilist_delivery_positionsGET /delivery/{settle}/positionsGet user position list
DeliveryApiget_delivery_positionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdate_delivery_position_marginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdate_delivery_position_leveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdate_delivery_position_risk_limitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilist_delivery_ordersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreate_delivery_orderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancel_delivery_ordersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApiget_delivery_orderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancel_delivery_orderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApiget_my_delivery_tradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilist_delivery_position_closeGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilist_delivery_liquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilist_delivery_settlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilist_delivery_risk_limit_tiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilist_price_triggered_delivery_ordersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreate_price_triggered_delivery_orderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancel_price_triggered_delivery_order_listDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApiget_price_triggered_delivery_orderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancel_price_triggered_delivery_orderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilist_dual_investment_plansGET /earn/dual/investment_planDual Investment product list
EarnApilist_dual_ordersGET /earn/dual/ordersDual Investment order list
EarnApiplace_dual_orderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilist_dual_balanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApiget_dual_order_refund_previewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplace_dual_order_refundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodify_dual_order_reinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApiget_dual_project_recommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifind_coinGET /earn/staking/coinsStaking coins
EarnApiswap_staking_coinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorder_listGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiaward_listGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiasset_listGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreate_auto_invest_planPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdate_auto_invest_planPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistop_auto_invest_planPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiadd_position_auto_invest_planPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilist_auto_invest_coinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApiget_auto_invest_min_amountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilist_auto_invest_plan_recordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilist_auto_invest_ordersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilist_auto_invest_configGET /earn/autoinvest/configList investment currency configuration
EarnApiget_auto_invest_plan_detailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilist_auto_invest_plansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilist_earn_fixed_term_productsGET /earn/fixed-term/productGet product list
EarnApilist_earn_fixed_term_products_by_assetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilist_earn_fixed_term_lendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreate_earn_fixed_term_lendPOST /earn/fixed-term/user/lendSubscription
EarnApicreate_earn_fixed_term_pre_redeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilist_earn_fixed_term_historyGET /earn/fixed-term/user/historySubscription history
FlashSwapApilist_flash_swap_currency_pairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilist_flash_swap_ordersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreate_flash_swap_orderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApiget_flash_swap_orderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreview_flash_swap_orderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreate_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreview_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreate_flash_swap_order_v1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreate_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreview_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreview_flash_swap_order_v1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilist_futures_contractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApilist_futures_contracts_allGET /futures/{settle}/contracts_allQuery all contract information (including delisted)
FuturesApiget_futures_contractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilist_futures_adl_risk_statesGET /futures/{settle}/adl_risk_statesList market-level ADL risk states
FuturesApilist_futures_order_bookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilist_futures_tradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilist_futures_candlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilist_futures_premium_indexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilist_futures_tickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilist_futures_funding_rate_historyGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilist_batch_futures_funding_ratesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilist_futures_insurance_ledgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilist_contract_statsGET /futures/{settle}/contract_statsFutures statistics
FuturesApiget_index_constituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilist_liquidated_ordersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilist_futures_risk_limit_tiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilist_futures_accountsGET /futures/{settle}/accountsGet futures account
FuturesApilist_futures_account_bookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilist_positionsGET /futures/{settle}/positionsGet user position list
FuturesApilist_positions_timerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApiget_positionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApiget_leverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdate_position_marginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdate_position_leveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdate_contract_position_leveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdate_position_cross_modePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdate_dual_comp_position_cross_modePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdate_position_risk_limitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApiset_dual_modePOST /futures/{settle}/dual_modeSet position mode
FuturesApiset_position_modePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApiget_dual_mode_positionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdate_dual_mode_position_marginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdate_dual_mode_position_leveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdate_dual_mode_position_risk_limitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilist_futures_ordersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreate_futures_orderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancel_futures_ordersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApiget_orders_with_time_rangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreate_batch_futures_orderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApiget_futures_orderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamend_futures_orderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancel_futures_orderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApiget_my_tradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApiget_my_trades_with_time_rangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilist_position_closeGET /futures/{settle}/position_closeQuery position close history
FuturesApilist_liquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilist_auto_deleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdown_cancel_all_futuresPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApiget_futures_feeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancel_batch_future_ordersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamend_batch_future_ordersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApiget_futures_risk_limit_tableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreate_futures_bbo_orderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistop_trail_orderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistop_all_trail_ordersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApiget_trail_ordersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApiget_trail_order_detailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApiget_trail_order_change_logGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApicreate_chase_orderPOST /futures/{settle}/autoorder/v1/chase/createCreate a chase order
FuturesApistop_chase_orderPOST /futures/{settle}/autoorder/v1/chase/stopStop a chase order
FuturesApistop_all_chase_ordersPOST /futures/{settle}/autoorder/v1/chase/stop_allStop chase orders in batch
FuturesApiget_chase_ordersGET /futures/{settle}/autoorder/v1/chase/listList chase orders
FuturesApiget_chase_order_detailGET /futures/{settle}/autoorder/v1/chase/detailGet chase order detail
FuturesApilist_price_triggered_ordersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreate_price_triggered_orderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancel_price_triggered_order_listDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApiget_price_triggered_orderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancel_price_triggered_orderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdate_price_triggered_orderPUT /futures/{settle}/price_orders/amendModify a Single Auto Order
MarginApilist_margin_accountsGET /margin/accountsMargin account list
MarginApilist_margin_account_bookGET /margin/account_bookQuery margin account balance change history
MarginApilist_funding_accountsGET /margin/funding_accountsFunding account list
MarginApiget_auto_repay_statusGET /margin/auto_repayQuery user auto repayment settings
MarginApiset_auto_repayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApiget_margin_transferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApiget_user_margin_tierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApiget_market_margin_tierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApiset_user_market_leveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilist_margin_user_accountGET /margin/user/accountQuery user's isolated margin account list
MarginApilist_cross_margin_loansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilist_cross_margin_repaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MultiCollateralLoanApilist_multi_collateral_ordersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreate_multi_collateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApiget_multi_collateral_order_detailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilist_multi_repay_recordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepay_multi_collateral_loanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilist_multi_collateral_recordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperate_multi_collateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilist_user_currency_quotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilist_multi_collateral_currenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApiget_multi_collateral_ltvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApiget_multi_collateral_fix_rateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApiget_multi_collateral_current_rateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OptionsApilist_options_underlyingsGET /options/underlyingsList all underlying assets
OptionsApilist_options_expirationsGET /options/expirationsList all expiration dates
OptionsApilist_options_contractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApiget_options_contractGET /options/contracts/{contract}Query specified contract details
OptionsApilist_options_settlementsGET /options/settlementsList settlement history
OptionsApiget_options_settlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilist_my_options_settlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilist_options_order_bookGET /options/order_bookQuery options contract order book
OptionsApilist_options_tickersGET /options/tickersQuery options market ticker information
OptionsApilist_options_underlying_tickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilist_options_candlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilist_options_underlying_candlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilist_options_tradesGET /options/tradesMarket trade records
OptionsApilist_options_accountGET /options/accountsQuery account information
OptionsApilist_options_account_bookGET /options/account_bookQuery account change history
OptionsApilist_options_positionsGET /options/positionsList user's positions of specified underlying
OptionsApiget_options_positionGET /options/positions/{contract}Get specified contract position
OptionsApilist_options_position_closeGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilist_options_ordersGET /options/ordersList options orders
OptionsApicreate_options_orderPOST /options/ordersCreate an options order
OptionsApicancel_options_ordersDELETE /options/ordersCancel all orders with 'open' status
OptionsApiget_options_orderGET /options/orders/{order_id}Query single order details
OptionsApiamend_options_orderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancel_options_orderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdown_cancel_all_optionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilist_my_options_tradesGET /options/my_tradesQuery personal trading records
OptionsApiget_options_mmpGET /options/mmpMMP Query.
OptionsApiset_options_mmpPOST /options/mmpMMP Settings
OptionsApireset_options_mmpPOST /options/mmp/resetMMP Reset
P2pApip2p_merchant_account_get_user_infoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2p_merchant_account_get_counterparty_user_infoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2p_merchant_account_get_myself_paymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2p_merchant_account_set_merchant_work_hoursPOST /p2p/merchant/account/set_merchant_work_hoursSet merchant working status and custom working hours
P2pApip2p_merchant_transaction_get_pending_transaction_listPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2p_merchant_transaction_get_completed_transaction_listPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2p_merchant_transaction_get_transaction_detailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2p_merchant_transaction_confirm_paymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2p_merchant_transaction_confirm_receiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2p_merchant_transaction_cancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2p_merchant_books_place_biz_push_orderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2p_merchant_books_ads_update_statusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2p_merchant_books_ads_detailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2p_merchant_books_my_ads_listPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2p_merchant_books_ads_listPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2p_merchant_chat_get_chats_listPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2p_merchant_chat_send_chat_messagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2p_merchant_chat_upload_chat_filePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagency_transaction_historyGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagency_commissions_historyGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartner_transaction_historyGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartner_commissions_historyGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartner_sub_listGET /rebate/partner/sub_listPartner subordinate list
RebateApirebate_broker_commission_historyGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebate_broker_transaction_historyGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebate_user_infoGET /rebate/user/infoUser obtains rebate information
RebateApiuser_sub_relationGET /rebate/user/sub_relationUser subordinate relationship
RebateApiget_partner_application_recentGET /rebate/partner/applications/recentGet recent partner application records
RebateApiget_partner_eligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApiget_partner_agent_data_aggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilist_currenciesGET /spot/currenciesQuery all currency information
SpotApiget_currencyGET /spot/currencies/{currency}Query single currency information
SpotApilist_currency_pairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApiget_currency_pairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilist_tickersGET /spot/tickersGet currency pair ticker information
SpotApilist_order_bookGET /spot/order_bookGet market depth information
SpotApilist_tradesGET /spot/tradesQuery market transaction records
SpotApilist_candlesticksGET /spot/candlesticksMarket K-line chart
SpotApiget_feeGET /spot/feeQuery account fee rates
SpotApiget_batch_spot_feeGET /spot/batch_feeBatch query account fee rates
SpotApilist_spot_accountsGET /spot/accountsList spot trading accounts
SpotApilist_spot_account_bookGET /spot/account_bookQuery spot account transaction history
SpotApicreate_batch_ordersPOST /spot/batch_ordersBatch place orders
SpotApilist_all_open_ordersGET /spot/open_ordersList all open orders
SpotApicreate_cross_liquidate_orderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilist_ordersGET /spot/ordersList orders
SpotApicreate_orderPOST /spot/ordersCreate order
SpotApicancel_ordersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancel_batch_ordersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApiget_orderGET /spot/orders/{order_id}Query single order details
SpotApicancel_orderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamend_orderPATCH /spot/orders/{order_id}Amend single order
SpotApilist_my_tradesGET /spot/my_tradesQuery personal trading records
SpotApiget_system_timeGET /spot/timeGet server current time
SpotApicountdown_cancel_all_spotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamend_batch_ordersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApiget_spot_insurance_historyGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilist_spot_price_triggered_ordersGET /spot/price_ordersQuery running auto order list
SpotApicreate_spot_price_triggered_orderPOST /spot/price_ordersCreate price-triggered order
SpotApicancel_spot_price_triggered_order_listDELETE /spot/price_ordersCancel all auto orders
SpotApiget_spot_price_triggered_orderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancel_spot_price_triggered_orderDELETE /spot/price_orders/{order_id}Cancel single auto order
SpotApilist_spot_pov_ordersGET /spot/pov_ordersList Spot POV orders
SpotApicreate_spot_pov_orderPOST /spot/pov_ordersCreate a Spot POV order
SpotApicancel_spot_pov_ordersDELETE /spot/pov_ordersCancel Spot POV orders
SpotApiget_spot_pov_orderGET /spot/pov_orders/{order_id}Query Spot POV order details
SpotApicancel_spot_pov_orderDELETE /spot/pov_orders/{order_id}Cancel a Spot POV order
SquareApilist_square_ai_searchGET /social/message/searchAI MCP Dynamic Search
SquareApilist_live_replayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
WalletApilist_currency_chainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApiget_deposit_addressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilist_withdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilist_depositsGET /wallet/depositsGet deposit records
WalletApiget_transferGET /wallet/transfersGet trading account transfer
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilist_sub_account_transfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransfer_with_sub_accountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisub_account_to_sub_accountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApiget_transfer_order_statusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilist_withdraw_statusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilist_sub_account_balancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilist_sub_account_margin_balancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilist_sub_account_futures_balancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilist_sub_account_cross_margin_balancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilist_saved_addressGET /wallet/saved_addressQuery saved address
WalletApiget_trade_feeGET /wallet/feeQuery personal trading fees
WalletApiget_total_balanceGET /wallet/total_balanceQuery personal account totals
WalletApilist_small_balanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvert_small_balancePOST /wallet/small_balanceConvert small balance currency
WalletApilist_small_balance_historyGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilist_push_ordersGET /wallet/pushGet UID transfer history
WalletApiget_low_cap_exchange_listGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApiget_user_identityGET /rewards/getUserIdentityGet user identity
WelfareApiget_beginner_task_listGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaim_taskPOST /rewards/claimTaskGet the task
WelfareApiclaim_rewardPOST /rewards/claimRewardReceive mission rewards
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdraw_push_orderPOST /withdrawals/pushUID transfer
WithdrawalApicancel_withdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

apiv4

Authentication with APIv4 key and secret

For details, refer to: APIv4 signed request requirements

Author

support@mail.gate.com

About

No description, website, or topics provided.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - gate/gateapi-python · GitHub
Skip to content

Repository files navigation

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 Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.129
  • Package version: 7.2.129
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gate.com/page/contacts

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly using:

pip install --user gate-api

Then import the package:

importgate_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgate_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.ActivityApi(api_client)
try:
# My activity entryapi_response=api_instance.get_my_activity_entry()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling ActivityApi->get_my_activity_entry: %s\n"%e)

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ActivityApiget_my_activity_entryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilist_activitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilist_activity_typesGET /rewards/activity/activity-typeActivity type list
CFDApiquery_mt5_account_infoGET /tradfi/users/mt5-accountQuery MT5 account information
CFDApiquery_categoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
CFDApiquery_symbol_commissionsGET /tradfi/symbols/commissionsQuery symbol commission rates
CFDApiquery_symbolsGET /tradfi/symbolsQuery trading symbol list
CFDApiquery_symbol_detailGET /tradfi/symbols/detailQuery trading symbol details
CFDApiquery_symbol_klineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
CFDApiquery_symbol_tickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
CFDApicreate_trad_fi_userPOST /tradfi/usersCreate CFD user
CFDApiquery_user_assetsGET /tradfi/users/assetsQuery account assets
CFDApiquery_transactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
CFDApicreate_transactionPOST /tradfi/transactionsFund transfer
CFDApiquery_order_listGET /tradfi/ordersQuery active order list
CFDApicreate_trad_fi_orderPOST /tradfi/ordersCreate order
CFDApiupdate_orderPUT /tradfi/orders/{order_id}Modify order
CFDApidelete_orderDELETE /tradfi/orders/{order_id}Cancel order
CFDApiquery_order_history_listGET /tradfi/orders/historyQuery historical order list
CFDApiquery_order_logGET /tradfi/orders/log/{log_id}Get order details by log ID
CFDApiquery_position_listGET /tradfi/positionsQuery active position list
CFDApiupdate_positionPUT /tradfi/positions/{position_id}Modify position
CFDApiclose_positionPOST /tradfi/positions/{position_id}/closeClose position
CFDApiquery_position_history_listGET /tradfi/positions/historyQuery historical position list
CrossExApilist_crossex_rule_symbolsGET /crossex/rule/symbolsQuery symbol information
CrossExApilist_crossex_rule_risk_limitsGET /crossex/rule/risk_limitsQuery risk limit information
CrossExApilist_crossex_transfer_coinsGET /crossex/transfers/coinQuery supported transfer currencies
CrossExApilist_crossex_transfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreate_crossex_transferPOST /crossex/transfersFund Transfer
CrossExApicreate_crossex_orderPOST /crossex/ordersCreate order
CrossExApicancel_batch_crossex_ordersPOST /crossex/batch_cancel_ordersBatch cancel orders
CrossExApiget_crossex_orderGET /crossex/orders/{order_id}Query order details
CrossExApiupdate_crossex_orderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancel_crossex_orderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreate_crossex_convert_quotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreate_crossex_convert_orderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApiget_crossex_accountGET /crossex/accountsQuery Account Assets
CrossExApiupdate_crossex_accountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApiget_crossex_positions_leverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_positions_leveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApiget_crossex_margin_positions_leverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_margin_positions_leveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApiclose_crossex_positionPOST /crossex/positionFull Close Position
CrossExApiget_crossex_positions_margin_modeGET /crossex/positions/margin_modeGet futures position margin mode
CrossExApiupdate_crossex_positions_margin_modePOST /crossex/positions/margin_modeUpdate futures position margin mode
CrossExApiupdate_crossex_positions_marginPOST /crossex/positions/marginIncrease or decrease isolated margin
CrossExApiget_crossex_interest_rateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApiget_crossex_feeGET /crossex/feeQuery User Fee Rates
CrossExApilist_crossex_positionsGET /crossex/positionsQuery Contract Positions
CrossExApilist_crossex_margin_positionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilist_crossex_adl_rankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilist_crossex_open_ordersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilist_crossex_history_ordersGET /crossex/history_ordersQuery order history
CrossExApilist_crossex_history_positionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilist_crossex_history_margin_positionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilist_crossex_history_margin_interestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilist_crossex_history_tradesGET /crossex/history_tradesQuery filled history
CrossExApilist_crossex_account_bookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilist_crossex_coin_discount_rateGET /crossex/coin_discount_rateQuery Currency Discount Rate
CrossExApilist_crossex_market_tickersGET /crossex/market/tickersGet exchange tickers
CrossExApilist_crossex_market_funding_infoGET /crossex/market/funding_infoGet exchange futures funding rate information
EarnUniApilist_uni_currenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApiget_uni_currencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilist_user_uni_lendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreate_uni_lendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichange_uni_lendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilist_uni_lend_recordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApiget_uni_interestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilist_uni_interest_recordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApiget_uni_interest_statusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilist_uni_chartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilist_uni_rateGET /earn/uni/rateCurrency estimated annualized interest rate
MarginUniApilist_uni_currency_pairsGET /margin/uni/currency_pairsList lending markets
MarginUniApiget_uni_currency_pairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApiget_margin_uni_estimate_rateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilist_uni_loansGET /margin/uni/loansQuery loans
MarginUniApicreate_uni_loanPOST /margin/uni/loansBorrow or repay
MarginUniApilist_uni_loan_recordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilist_uni_loan_interest_recordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApiget_uni_borrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
OTCApicreate_otc_quotePOST /otc/quoteFiat and stablecoin quote
OTCApicreate_otc_orderPOST /otc/order/createCreate fiat order
OTCApicreate_stable_coin_orderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApiget_bank_list_inner_pathGET /otc/bank/listGet user bank card list
OTCApicreate_otc_bankPOST /otc/bank/createCreate bank card
OTCApidelete_otc_bankPOST /otc/bank/deleteDelete bank card
OTCApiset_default_otc_bankPOST /otc/bank/set_defaultSet default bank card
OTCApiget_otc_bank_supplement_checklistGET /otc/bank/bank_supplement_checklistQuery the checklist of materials to supplement for a bank card
OTCApisubmit_otc_bank_personal_supplementPOST /otc/bank/personal/bank_supplementSubmit Bank Card Supplement Materials (Personal)
OTCApisubmit_otc_bank_enterprise_supplementPOST /otc/bank/enterprise/bank_supplementSubmit Bank Card Supplement Materials (Enterprise)
OTCApimark_otc_order_paidPOST /otc/order/paidMark fiat order as paid (deposit confirmation)
OTCApicancel_otc_orderPOST /otc/order/cancelFiat order cancellation
OTCApilist_otc_ordersGET /otc/order/listFiat order list
OTCApilist_stable_coin_ordersGET /otc/stable_coin/order/listStablecoin order list
OTCApiget_otc_order_detailGET /otc/order/detailFiat order details
StockApiquery_stock_user_assetsGET /stock/users/assetsQuery user assets
StockApiquery_stock_symbolsGET /stock/symbolsQuery symbol list
StockApiquery_stock_symbol_detailGET /stock/symbols/detailQuery symbol details
StockApiquery_stock_order_bookGET /stock/market/{symbol}/orderbookQuery market order book
StockApiquery_stock_order_listGET /stock/ordersQuery open order list
StockApicreate_stock_orderPOST /stock/ordersCreate order
StockApidelete_all_stock_ordersDELETE /stock/ordersCancel all open orders
StockApiquery_stock_order_historyGET /stock/orders/historyQuery historical order list
StockApiupdate_stock_orderPUT /stock/orders/{order_id}Modify order
StockApidelete_stock_orderDELETE /stock/orders/{order_id}Cancel order
StockApiquery_stock_positionsGET /stock/positionsQuery current position list
StockApiclose_stock_positionPOST /stock/positions/closeClose position
StockApiquery_stock_transactionsGET /stock/transactionsQuery transaction records
StockApicreate_stock_transactionPOST /stock/transactionsFund transfer
StockApiquery_stock_exchangesGET /stock/exchangesQuery supported exchanges
StockApiquery_stock_fee_rateGET /stock/fee-rateQuery fee rates for Japanese and Korean stocks
SubAccountApilist_sub_accountsGET /sub_accountsList sub-accounts
SubAccountApicreate_sub_accountsPOST /sub_accountsCreate a new sub-account
SubAccountApiget_sub_accountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilist_sub_account_keysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreate_sub_account_keysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApiget_sub_account_keyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdate_sub_account_keysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApidelete_sub_account_keysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilock_sub_accountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlock_sub_accountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilist_unified_modeGET /sub_accounts/unified_modeGet sub-account mode
UnifiedApilist_unified_accountsGET /unified/accountsGet unified account information
UnifiedApiget_unified_borrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApiget_unified_transferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApiget_unified_transferablesGET /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
UnifiedApiget_unified_borrowable_listGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilist_unified_loansGET /unified/loansQuery loans
UnifiedApicreate_unified_loanPOST /unified/loansBorrow or repay
UnifiedApilist_unified_loan_recordsGET /unified/loan_recordsQuery loan records
UnifiedApilist_unified_loan_interest_recordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApiget_unified_risk_unitsGET /unified/risk_unitsGet user risk unit details
UnifiedApiget_unified_modeGET /unified/unified_modeQuery mode of the unified account
UnifiedApiset_unified_modePUT /unified/unified_modeSet unified account mode
UnifiedApiget_unified_estimate_rateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilist_currency_discount_tiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilist_loan_margin_tiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculate_portfolio_marginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApiset_user_leveragePOST /unified/leverage/user_settingSet leverage for all of the user's borrowed currencies
UnifiedApiget_user_leverage_currency_configGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApiget_user_leverage_currency_settingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApiset_user_leverage_currency_settingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilist_unified_currenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApiget_history_loan_rateGET /unified/history_loan_rateGet historical lending rates
UnifiedApiset_unified_collateralPOST /unified/collateral_currenciesSet collateral currency
UnifiedApiget_estimated_quick_repaymentGET /unified/estimated_quick_repaymentEstimated quick repayment details
UnifiedApicreate_quick_repaymentPOST /unified/quick_repaymentQuick repayment
UnifiedApiget_unified_delta_neutralGET /unified/delta_neutralQuery the account Delta-neutral strategy mode setting
UnifiedApiset_unified_delta_neutralPOST /unified/delta_neutralSet the account Delta-neutral strategy mode
AccountApiget_account_detailGET /account/detailRetrieve user account information
AccountApiget_account_main_keysGET /account/main_keysQuery All Main Account Key Information
AccountApiget_account_rate_limitGET /account/rate_limitGet user transaction rate limit information
AccountApilist_stp_groupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreate_stp_groupPOST /account/stp_groupsCreate STP user group
AccountApilist_stp_groups_usersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiadd_stp_group_usersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApidelete_stp_group_usersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApiget_debit_feeGET /account/debit_feeQuery GT fee deduction configuration
AccountApiset_debit_feePOST /account/debit_feeConfigure GT fee deduction
AlphaApilist_alpha_accountsGET /alpha/accountsAlpha Account API
AlphaApilist_alpha_account_bookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquote_alpha_orderPOST /alpha/quoteAlpha Quote API
AlphaApilist_alpha_orderGET /alpha/ordersAlpha Order List API
AlphaApiplace_alpha_orderPOST /alpha/ordersAlpha Order API
AlphaApiget_alpha_orderGET /alpha/orderAlpha Single Order Query API
AlphaApilist_alpha_currenciesGET /alpha/currenciesQuery currency information
AlphaApilist_alpha_tickersGET /alpha/tickersQuery currency ticker
AlphaApilist_alpha_tokensGET /alpha/tokensQuery Token Information
AssetswapApilist_asset_swap_assetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApiget_asset_swap_configGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluate_asset_swapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreate_asset_swap_order_v1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilist_asset_swap_orders_v1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreview_asset_swap_order_v1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApiget_asset_swap_order_v1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApiget_ai_hub_strategy_recommendGET /bot/strategy/recommendGet AIHub strategy recommendations
BotApipost_ai_hub_spot_grid_createPOST /bot/spot-grid/createCreate spot grid
BotApipost_ai_hub_margin_grid_createPOST /bot/margin-grid/createCreate a lever grid
BotApipost_ai_hub_infinite_grid_createPOST /bot/infinite-grid/createCreate infinite grid
BotApipost_ai_hub_futures_grid_createPOST /bot/futures-grid/createCreate a contract grid
BotApipost_ai_hub_spot_martingale_createPOST /bot/spot-martingale/createCreate Spot Martin
BotApipost_ai_hub_contract_martingale_createPOST /bot/contract-martingale/createCreate contract martin
BotApiget_ai_hub_portfolio_runningGET /bot/portfolio/runningQuery the list of running policies
BotApiget_ai_hub_portfolio_detailGET /bot/portfolio/detailQuery order policy details
BotApipost_ai_hub_portfolio_stopPOST /bot/portfolio/stopTerminate a single running policy
CouponApilist_user_couponsGET /coupon/user-coupon-listCoupon Center list
CouponApiget_user_coupon_detailGET /coupon/user-coupon-detailCoupon Center details
DeliveryApilist_delivery_contractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApiget_delivery_contractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilist_delivery_order_bookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilist_delivery_tradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilist_delivery_candlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilist_delivery_tickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilist_delivery_insurance_ledgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilist_delivery_accountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilist_delivery_account_bookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilist_delivery_positionsGET /delivery/{settle}/positionsGet user position list
DeliveryApiget_delivery_positionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdate_delivery_position_marginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdate_delivery_position_leveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdate_delivery_position_risk_limitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilist_delivery_ordersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreate_delivery_orderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancel_delivery_ordersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApiget_delivery_orderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancel_delivery_orderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApiget_my_delivery_tradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilist_delivery_position_closeGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilist_delivery_liquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilist_delivery_settlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilist_delivery_risk_limit_tiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilist_price_triggered_delivery_ordersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreate_price_triggered_delivery_orderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancel_price_triggered_delivery_order_listDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApiget_price_triggered_delivery_orderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancel_price_triggered_delivery_orderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilist_dual_investment_plansGET /earn/dual/investment_planDual Investment product list
EarnApilist_dual_ordersGET /earn/dual/ordersDual Investment order list
EarnApiplace_dual_orderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilist_dual_balanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApiget_dual_order_refund_previewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplace_dual_order_refundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodify_dual_order_reinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApiget_dual_project_recommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifind_coinGET /earn/staking/coinsStaking coins
EarnApiswap_staking_coinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorder_listGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiaward_listGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiasset_listGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreate_auto_invest_planPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdate_auto_invest_planPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistop_auto_invest_planPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiadd_position_auto_invest_planPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilist_auto_invest_coinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApiget_auto_invest_min_amountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilist_auto_invest_plan_recordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilist_auto_invest_ordersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilist_auto_invest_configGET /earn/autoinvest/configList investment currency configuration
EarnApiget_auto_invest_plan_detailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilist_auto_invest_plansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilist_earn_fixed_term_productsGET /earn/fixed-term/productGet product list
EarnApilist_earn_fixed_term_products_by_assetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilist_earn_fixed_term_lendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreate_earn_fixed_term_lendPOST /earn/fixed-term/user/lendSubscription
EarnApicreate_earn_fixed_term_pre_redeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilist_earn_fixed_term_historyGET /earn/fixed-term/user/historySubscription history
FlashSwapApilist_flash_swap_currency_pairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilist_flash_swap_ordersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreate_flash_swap_orderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApiget_flash_swap_orderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreview_flash_swap_orderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreate_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreview_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreate_flash_swap_order_v1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreate_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreview_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreview_flash_swap_order_v1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilist_futures_contractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApilist_futures_contracts_allGET /futures/{settle}/contracts_allQuery all contract information (including delisted)
FuturesApiget_futures_contractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilist_futures_adl_risk_statesGET /futures/{settle}/adl_risk_statesList market-level ADL risk states
FuturesApilist_futures_order_bookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilist_futures_tradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilist_futures_candlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilist_futures_premium_indexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilist_futures_tickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilist_futures_funding_rate_historyGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilist_batch_futures_funding_ratesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilist_futures_insurance_ledgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilist_contract_statsGET /futures/{settle}/contract_statsFutures statistics
FuturesApiget_index_constituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilist_liquidated_ordersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilist_futures_risk_limit_tiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilist_futures_accountsGET /futures/{settle}/accountsGet futures account
FuturesApilist_futures_account_bookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilist_positionsGET /futures/{settle}/positionsGet user position list
FuturesApilist_positions_timerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApiget_positionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApiget_leverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdate_position_marginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdate_position_leveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdate_contract_position_leveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdate_position_cross_modePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdate_dual_comp_position_cross_modePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdate_position_risk_limitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApiset_dual_modePOST /futures/{settle}/dual_modeSet position mode
FuturesApiset_position_modePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApiget_dual_mode_positionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdate_dual_mode_position_marginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdate_dual_mode_position_leveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdate_dual_mode_position_risk_limitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilist_futures_ordersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreate_futures_orderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancel_futures_ordersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApiget_orders_with_time_rangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreate_batch_futures_orderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApiget_futures_orderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamend_futures_orderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancel_futures_orderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApiget_my_tradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApiget_my_trades_with_time_rangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilist_position_closeGET /futures/{settle}/position_closeQuery position close history
FuturesApilist_liquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilist_auto_deleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdown_cancel_all_futuresPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApiget_futures_feeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancel_batch_future_ordersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamend_batch_future_ordersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApiget_futures_risk_limit_tableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreate_futures_bbo_orderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistop_trail_orderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistop_all_trail_ordersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApiget_trail_ordersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApiget_trail_order_detailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApiget_trail_order_change_logGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApicreate_chase_orderPOST /futures/{settle}/autoorder/v1/chase/createCreate a chase order
FuturesApistop_chase_orderPOST /futures/{settle}/autoorder/v1/chase/stopStop a chase order
FuturesApistop_all_chase_ordersPOST /futures/{settle}/autoorder/v1/chase/stop_allStop chase orders in batch
FuturesApiget_chase_ordersGET /futures/{settle}/autoorder/v1/chase/listList chase orders
FuturesApiget_chase_order_detailGET /futures/{settle}/autoorder/v1/chase/detailGet chase order detail
FuturesApilist_price_triggered_ordersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreate_price_triggered_orderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancel_price_triggered_order_listDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApiget_price_triggered_orderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancel_price_triggered_orderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdate_price_triggered_orderPUT /futures/{settle}/price_orders/amendModify a Single Auto Order
MarginApilist_margin_accountsGET /margin/accountsMargin account list
MarginApilist_margin_account_bookGET /margin/account_bookQuery margin account balance change history
MarginApilist_funding_accountsGET /margin/funding_accountsFunding account list
MarginApiget_auto_repay_statusGET /margin/auto_repayQuery user auto repayment settings
MarginApiset_auto_repayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApiget_margin_transferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApiget_user_margin_tierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApiget_market_margin_tierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApiset_user_market_leveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilist_margin_user_accountGET /margin/user/accountQuery user's isolated margin account list
MarginApilist_cross_margin_loansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilist_cross_margin_repaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MultiCollateralLoanApilist_multi_collateral_ordersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreate_multi_collateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApiget_multi_collateral_order_detailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilist_multi_repay_recordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepay_multi_collateral_loanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilist_multi_collateral_recordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperate_multi_collateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilist_user_currency_quotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilist_multi_collateral_currenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApiget_multi_collateral_ltvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApiget_multi_collateral_fix_rateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApiget_multi_collateral_current_rateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OptionsApilist_options_underlyingsGET /options/underlyingsList all underlying assets
OptionsApilist_options_expirationsGET /options/expirationsList all expiration dates
OptionsApilist_options_contractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApiget_options_contractGET /options/contracts/{contract}Query specified contract details
OptionsApilist_options_settlementsGET /options/settlementsList settlement history
OptionsApiget_options_settlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilist_my_options_settlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilist_options_order_bookGET /options/order_bookQuery options contract order book
OptionsApilist_options_tickersGET /options/tickersQuery options market ticker information
OptionsApilist_options_underlying_tickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilist_options_candlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilist_options_underlying_candlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilist_options_tradesGET /options/tradesMarket trade records
OptionsApilist_options_accountGET /options/accountsQuery account information
OptionsApilist_options_account_bookGET /options/account_bookQuery account change history
OptionsApilist_options_positionsGET /options/positionsList user's positions of specified underlying
OptionsApiget_options_positionGET /options/positions/{contract}Get specified contract position
OptionsApilist_options_position_closeGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilist_options_ordersGET /options/ordersList options orders
OptionsApicreate_options_orderPOST /options/ordersCreate an options order
OptionsApicancel_options_ordersDELETE /options/ordersCancel all orders with 'open' status
OptionsApiget_options_orderGET /options/orders/{order_id}Query single order details
OptionsApiamend_options_orderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancel_options_orderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdown_cancel_all_optionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilist_my_options_tradesGET /options/my_tradesQuery personal trading records
OptionsApiget_options_mmpGET /options/mmpMMP Query.
OptionsApiset_options_mmpPOST /options/mmpMMP Settings
OptionsApireset_options_mmpPOST /options/mmp/resetMMP Reset
P2pApip2p_merchant_account_get_user_infoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2p_merchant_account_get_counterparty_user_infoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2p_merchant_account_get_myself_paymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2p_merchant_account_set_merchant_work_hoursPOST /p2p/merchant/account/set_merchant_work_hoursSet merchant working status and custom working hours
P2pApip2p_merchant_transaction_get_pending_transaction_listPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2p_merchant_transaction_get_completed_transaction_listPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2p_merchant_transaction_get_transaction_detailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2p_merchant_transaction_confirm_paymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2p_merchant_transaction_confirm_receiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2p_merchant_transaction_cancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2p_merchant_books_place_biz_push_orderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2p_merchant_books_ads_update_statusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2p_merchant_books_ads_detailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2p_merchant_books_my_ads_listPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2p_merchant_books_ads_listPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2p_merchant_chat_get_chats_listPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2p_merchant_chat_send_chat_messagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2p_merchant_chat_upload_chat_filePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagency_transaction_historyGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagency_commissions_historyGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartner_transaction_historyGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartner_commissions_historyGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartner_sub_listGET /rebate/partner/sub_listPartner subordinate list
RebateApirebate_broker_commission_historyGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebate_broker_transaction_historyGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebate_user_infoGET /rebate/user/infoUser obtains rebate information
RebateApiuser_sub_relationGET /rebate/user/sub_relationUser subordinate relationship
RebateApiget_partner_application_recentGET /rebate/partner/applications/recentGet recent partner application records
RebateApiget_partner_eligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApiget_partner_agent_data_aggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilist_currenciesGET /spot/currenciesQuery all currency information
SpotApiget_currencyGET /spot/currencies/{currency}Query single currency information
SpotApilist_currency_pairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApiget_currency_pairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilist_tickersGET /spot/tickersGet currency pair ticker information
SpotApilist_order_bookGET /spot/order_bookGet market depth information
SpotApilist_tradesGET /spot/tradesQuery market transaction records
SpotApilist_candlesticksGET /spot/candlesticksMarket K-line chart
SpotApiget_feeGET /spot/feeQuery account fee rates
SpotApiget_batch_spot_feeGET /spot/batch_feeBatch query account fee rates
SpotApilist_spot_accountsGET /spot/accountsList spot trading accounts
SpotApilist_spot_account_bookGET /spot/account_bookQuery spot account transaction history
SpotApicreate_batch_ordersPOST /spot/batch_ordersBatch place orders
SpotApilist_all_open_ordersGET /spot/open_ordersList all open orders
SpotApicreate_cross_liquidate_orderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilist_ordersGET /spot/ordersList orders
SpotApicreate_orderPOST /spot/ordersCreate order
SpotApicancel_ordersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancel_batch_ordersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApiget_orderGET /spot/orders/{order_id}Query single order details
SpotApicancel_orderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamend_orderPATCH /spot/orders/{order_id}Amend single order
SpotApilist_my_tradesGET /spot/my_tradesQuery personal trading records
SpotApiget_system_timeGET /spot/timeGet server current time
SpotApicountdown_cancel_all_spotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamend_batch_ordersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApiget_spot_insurance_historyGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilist_spot_price_triggered_ordersGET /spot/price_ordersQuery running auto order list
SpotApicreate_spot_price_triggered_orderPOST /spot/price_ordersCreate price-triggered order
SpotApicancel_spot_price_triggered_order_listDELETE /spot/price_ordersCancel all auto orders
SpotApiget_spot_price_triggered_orderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancel_spot_price_triggered_orderDELETE /spot/price_orders/{order_id}Cancel single auto order
SpotApilist_spot_pov_ordersGET /spot/pov_ordersList Spot POV orders
SpotApicreate_spot_pov_orderPOST /spot/pov_ordersCreate a Spot POV order
SpotApicancel_spot_pov_ordersDELETE /spot/pov_ordersCancel Spot POV orders
SpotApiget_spot_pov_orderGET /spot/pov_orders/{order_id}Query Spot POV order details
SpotApicancel_spot_pov_orderDELETE /spot/pov_orders/{order_id}Cancel a Spot POV order
SquareApilist_square_ai_searchGET /social/message/searchAI MCP Dynamic Search
SquareApilist_live_replayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
WalletApilist_currency_chainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApiget_deposit_addressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilist_withdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilist_depositsGET /wallet/depositsGet deposit records
WalletApiget_transferGET /wallet/transfersGet trading account transfer
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilist_sub_account_transfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransfer_with_sub_accountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisub_account_to_sub_accountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApiget_transfer_order_statusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilist_withdraw_statusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilist_sub_account_balancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilist_sub_account_margin_balancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilist_sub_account_futures_balancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilist_sub_account_cross_margin_balancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilist_saved_addressGET /wallet/saved_addressQuery saved address
WalletApiget_trade_feeGET /wallet/feeQuery personal trading fees
WalletApiget_total_balanceGET /wallet/total_balanceQuery personal account totals
WalletApilist_small_balanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvert_small_balancePOST /wallet/small_balanceConvert small balance currency
WalletApilist_small_balance_historyGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilist_push_ordersGET /wallet/pushGet UID transfer history
WalletApiget_low_cap_exchange_listGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApiget_user_identityGET /rewards/getUserIdentityGet user identity
WelfareApiget_beginner_task_listGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaim_taskPOST /rewards/claimTaskGet the task
WelfareApiclaim_rewardPOST /rewards/claimRewardReceive mission rewards
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdraw_push_orderPOST /withdrawals/pushUID transfer
WithdrawalApicancel_withdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

apiv4

Authentication with APIv4 key and secret

For details, refer to: APIv4 signed request requirements

Author

support@mail.gate.com

About

No description, website, or topics provided.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - gate/gateapi-python · GitHub
Skip to content

Repository files navigation

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 Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.129
  • Package version: 7.2.129
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gate.com/page/contacts

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly using:

pip install --user gate-api

Then import the package:

importgate_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgate_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.ActivityApi(api_client)
try:
# My activity entryapi_response=api_instance.get_my_activity_entry()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling ActivityApi->get_my_activity_entry: %s\n"%e)

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ActivityApiget_my_activity_entryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilist_activitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilist_activity_typesGET /rewards/activity/activity-typeActivity type list
CFDApiquery_mt5_account_infoGET /tradfi/users/mt5-accountQuery MT5 account information
CFDApiquery_categoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
CFDApiquery_symbol_commissionsGET /tradfi/symbols/commissionsQuery symbol commission rates
CFDApiquery_symbolsGET /tradfi/symbolsQuery trading symbol list
CFDApiquery_symbol_detailGET /tradfi/symbols/detailQuery trading symbol details
CFDApiquery_symbol_klineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
CFDApiquery_symbol_tickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
CFDApicreate_trad_fi_userPOST /tradfi/usersCreate CFD user
CFDApiquery_user_assetsGET /tradfi/users/assetsQuery account assets
CFDApiquery_transactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
CFDApicreate_transactionPOST /tradfi/transactionsFund transfer
CFDApiquery_order_listGET /tradfi/ordersQuery active order list
CFDApicreate_trad_fi_orderPOST /tradfi/ordersCreate order
CFDApiupdate_orderPUT /tradfi/orders/{order_id}Modify order
CFDApidelete_orderDELETE /tradfi/orders/{order_id}Cancel order
CFDApiquery_order_history_listGET /tradfi/orders/historyQuery historical order list
CFDApiquery_order_logGET /tradfi/orders/log/{log_id}Get order details by log ID
CFDApiquery_position_listGET /tradfi/positionsQuery active position list
CFDApiupdate_positionPUT /tradfi/positions/{position_id}Modify position
CFDApiclose_positionPOST /tradfi/positions/{position_id}/closeClose position
CFDApiquery_position_history_listGET /tradfi/positions/historyQuery historical position list
CrossExApilist_crossex_rule_symbolsGET /crossex/rule/symbolsQuery symbol information
CrossExApilist_crossex_rule_risk_limitsGET /crossex/rule/risk_limitsQuery risk limit information
CrossExApilist_crossex_transfer_coinsGET /crossex/transfers/coinQuery supported transfer currencies
CrossExApilist_crossex_transfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreate_crossex_transferPOST /crossex/transfersFund Transfer
CrossExApicreate_crossex_orderPOST /crossex/ordersCreate order
CrossExApicancel_batch_crossex_ordersPOST /crossex/batch_cancel_ordersBatch cancel orders
CrossExApiget_crossex_orderGET /crossex/orders/{order_id}Query order details
CrossExApiupdate_crossex_orderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancel_crossex_orderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreate_crossex_convert_quotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreate_crossex_convert_orderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApiget_crossex_accountGET /crossex/accountsQuery Account Assets
CrossExApiupdate_crossex_accountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApiget_crossex_positions_leverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_positions_leveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApiget_crossex_margin_positions_leverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_margin_positions_leveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApiclose_crossex_positionPOST /crossex/positionFull Close Position
CrossExApiget_crossex_positions_margin_modeGET /crossex/positions/margin_modeGet futures position margin mode
CrossExApiupdate_crossex_positions_margin_modePOST /crossex/positions/margin_modeUpdate futures position margin mode
CrossExApiupdate_crossex_positions_marginPOST /crossex/positions/marginIncrease or decrease isolated margin
CrossExApiget_crossex_interest_rateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApiget_crossex_feeGET /crossex/feeQuery User Fee Rates
CrossExApilist_crossex_positionsGET /crossex/positionsQuery Contract Positions
CrossExApilist_crossex_margin_positionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilist_crossex_adl_rankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilist_crossex_open_ordersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilist_crossex_history_ordersGET /crossex/history_ordersQuery order history
CrossExApilist_crossex_history_positionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilist_crossex_history_margin_positionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilist_crossex_history_margin_interestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilist_crossex_history_tradesGET /crossex/history_tradesQuery filled history
CrossExApilist_crossex_account_bookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilist_crossex_coin_discount_rateGET /crossex/coin_discount_rateQuery Currency Discount Rate
CrossExApilist_crossex_market_tickersGET /crossex/market/tickersGet exchange tickers
CrossExApilist_crossex_market_funding_infoGET /crossex/market/funding_infoGet exchange futures funding rate information
EarnUniApilist_uni_currenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApiget_uni_currencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilist_user_uni_lendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreate_uni_lendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichange_uni_lendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilist_uni_lend_recordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApiget_uni_interestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilist_uni_interest_recordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApiget_uni_interest_statusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilist_uni_chartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilist_uni_rateGET /earn/uni/rateCurrency estimated annualized interest rate
MarginUniApilist_uni_currency_pairsGET /margin/uni/currency_pairsList lending markets
MarginUniApiget_uni_currency_pairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApiget_margin_uni_estimate_rateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilist_uni_loansGET /margin/uni/loansQuery loans
MarginUniApicreate_uni_loanPOST /margin/uni/loansBorrow or repay
MarginUniApilist_uni_loan_recordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilist_uni_loan_interest_recordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApiget_uni_borrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
OTCApicreate_otc_quotePOST /otc/quoteFiat and stablecoin quote
OTCApicreate_otc_orderPOST /otc/order/createCreate fiat order
OTCApicreate_stable_coin_orderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApiget_bank_list_inner_pathGET /otc/bank/listGet user bank card list
OTCApicreate_otc_bankPOST /otc/bank/createCreate bank card
OTCApidelete_otc_bankPOST /otc/bank/deleteDelete bank card
OTCApiset_default_otc_bankPOST /otc/bank/set_defaultSet default bank card
OTCApiget_otc_bank_supplement_checklistGET /otc/bank/bank_supplement_checklistQuery the checklist of materials to supplement for a bank card
OTCApisubmit_otc_bank_personal_supplementPOST /otc/bank/personal/bank_supplementSubmit Bank Card Supplement Materials (Personal)
OTCApisubmit_otc_bank_enterprise_supplementPOST /otc/bank/enterprise/bank_supplementSubmit Bank Card Supplement Materials (Enterprise)
OTCApimark_otc_order_paidPOST /otc/order/paidMark fiat order as paid (deposit confirmation)
OTCApicancel_otc_orderPOST /otc/order/cancelFiat order cancellation
OTCApilist_otc_ordersGET /otc/order/listFiat order list
OTCApilist_stable_coin_ordersGET /otc/stable_coin/order/listStablecoin order list
OTCApiget_otc_order_detailGET /otc/order/detailFiat order details
StockApiquery_stock_user_assetsGET /stock/users/assetsQuery user assets
StockApiquery_stock_symbolsGET /stock/symbolsQuery symbol list
StockApiquery_stock_symbol_detailGET /stock/symbols/detailQuery symbol details
StockApiquery_stock_order_bookGET /stock/market/{symbol}/orderbookQuery market order book
StockApiquery_stock_order_listGET /stock/ordersQuery open order list
StockApicreate_stock_orderPOST /stock/ordersCreate order
StockApidelete_all_stock_ordersDELETE /stock/ordersCancel all open orders
StockApiquery_stock_order_historyGET /stock/orders/historyQuery historical order list
StockApiupdate_stock_orderPUT /stock/orders/{order_id}Modify order
StockApidelete_stock_orderDELETE /stock/orders/{order_id}Cancel order
StockApiquery_stock_positionsGET /stock/positionsQuery current position list
StockApiclose_stock_positionPOST /stock/positions/closeClose position
StockApiquery_stock_transactionsGET /stock/transactionsQuery transaction records
StockApicreate_stock_transactionPOST /stock/transactionsFund transfer
StockApiquery_stock_exchangesGET /stock/exchangesQuery supported exchanges
StockApiquery_stock_fee_rateGET /stock/fee-rateQuery fee rates for Japanese and Korean stocks
SubAccountApilist_sub_accountsGET /sub_accountsList sub-accounts
SubAccountApicreate_sub_accountsPOST /sub_accountsCreate a new sub-account
SubAccountApiget_sub_accountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilist_sub_account_keysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreate_sub_account_keysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApiget_sub_account_keyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdate_sub_account_keysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApidelete_sub_account_keysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilock_sub_accountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlock_sub_accountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilist_unified_modeGET /sub_accounts/unified_modeGet sub-account mode
UnifiedApilist_unified_accountsGET /unified/accountsGet unified account information
UnifiedApiget_unified_borrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApiget_unified_transferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApiget_unified_transferablesGET /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
UnifiedApiget_unified_borrowable_listGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilist_unified_loansGET /unified/loansQuery loans
UnifiedApicreate_unified_loanPOST /unified/loansBorrow or repay
UnifiedApilist_unified_loan_recordsGET /unified/loan_recordsQuery loan records
UnifiedApilist_unified_loan_interest_recordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApiget_unified_risk_unitsGET /unified/risk_unitsGet user risk unit details
UnifiedApiget_unified_modeGET /unified/unified_modeQuery mode of the unified account
UnifiedApiset_unified_modePUT /unified/unified_modeSet unified account mode
UnifiedApiget_unified_estimate_rateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilist_currency_discount_tiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilist_loan_margin_tiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculate_portfolio_marginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApiset_user_leveragePOST /unified/leverage/user_settingSet leverage for all of the user's borrowed currencies
UnifiedApiget_user_leverage_currency_configGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApiget_user_leverage_currency_settingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApiset_user_leverage_currency_settingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilist_unified_currenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApiget_history_loan_rateGET /unified/history_loan_rateGet historical lending rates
UnifiedApiset_unified_collateralPOST /unified/collateral_currenciesSet collateral currency
UnifiedApiget_estimated_quick_repaymentGET /unified/estimated_quick_repaymentEstimated quick repayment details
UnifiedApicreate_quick_repaymentPOST /unified/quick_repaymentQuick repayment
UnifiedApiget_unified_delta_neutralGET /unified/delta_neutralQuery the account Delta-neutral strategy mode setting
UnifiedApiset_unified_delta_neutralPOST /unified/delta_neutralSet the account Delta-neutral strategy mode
AccountApiget_account_detailGET /account/detailRetrieve user account information
AccountApiget_account_main_keysGET /account/main_keysQuery All Main Account Key Information
AccountApiget_account_rate_limitGET /account/rate_limitGet user transaction rate limit information
AccountApilist_stp_groupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreate_stp_groupPOST /account/stp_groupsCreate STP user group
AccountApilist_stp_groups_usersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiadd_stp_group_usersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApidelete_stp_group_usersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApiget_debit_feeGET /account/debit_feeQuery GT fee deduction configuration
AccountApiset_debit_feePOST /account/debit_feeConfigure GT fee deduction
AlphaApilist_alpha_accountsGET /alpha/accountsAlpha Account API
AlphaApilist_alpha_account_bookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquote_alpha_orderPOST /alpha/quoteAlpha Quote API
AlphaApilist_alpha_orderGET /alpha/ordersAlpha Order List API
AlphaApiplace_alpha_orderPOST /alpha/ordersAlpha Order API
AlphaApiget_alpha_orderGET /alpha/orderAlpha Single Order Query API
AlphaApilist_alpha_currenciesGET /alpha/currenciesQuery currency information
AlphaApilist_alpha_tickersGET /alpha/tickersQuery currency ticker
AlphaApilist_alpha_tokensGET /alpha/tokensQuery Token Information
AssetswapApilist_asset_swap_assetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApiget_asset_swap_configGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluate_asset_swapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreate_asset_swap_order_v1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilist_asset_swap_orders_v1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreview_asset_swap_order_v1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApiget_asset_swap_order_v1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApiget_ai_hub_strategy_recommendGET /bot/strategy/recommendGet AIHub strategy recommendations
BotApipost_ai_hub_spot_grid_createPOST /bot/spot-grid/createCreate spot grid
BotApipost_ai_hub_margin_grid_createPOST /bot/margin-grid/createCreate a lever grid
BotApipost_ai_hub_infinite_grid_createPOST /bot/infinite-grid/createCreate infinite grid
BotApipost_ai_hub_futures_grid_createPOST /bot/futures-grid/createCreate a contract grid
BotApipost_ai_hub_spot_martingale_createPOST /bot/spot-martingale/createCreate Spot Martin
BotApipost_ai_hub_contract_martingale_createPOST /bot/contract-martingale/createCreate contract martin
BotApiget_ai_hub_portfolio_runningGET /bot/portfolio/runningQuery the list of running policies
BotApiget_ai_hub_portfolio_detailGET /bot/portfolio/detailQuery order policy details
BotApipost_ai_hub_portfolio_stopPOST /bot/portfolio/stopTerminate a single running policy
CouponApilist_user_couponsGET /coupon/user-coupon-listCoupon Center list
CouponApiget_user_coupon_detailGET /coupon/user-coupon-detailCoupon Center details
DeliveryApilist_delivery_contractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApiget_delivery_contractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilist_delivery_order_bookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilist_delivery_tradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilist_delivery_candlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilist_delivery_tickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilist_delivery_insurance_ledgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilist_delivery_accountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilist_delivery_account_bookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilist_delivery_positionsGET /delivery/{settle}/positionsGet user position list
DeliveryApiget_delivery_positionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdate_delivery_position_marginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdate_delivery_position_leveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdate_delivery_position_risk_limitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilist_delivery_ordersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreate_delivery_orderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancel_delivery_ordersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApiget_delivery_orderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancel_delivery_orderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApiget_my_delivery_tradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilist_delivery_position_closeGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilist_delivery_liquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilist_delivery_settlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilist_delivery_risk_limit_tiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilist_price_triggered_delivery_ordersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreate_price_triggered_delivery_orderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancel_price_triggered_delivery_order_listDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApiget_price_triggered_delivery_orderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancel_price_triggered_delivery_orderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilist_dual_investment_plansGET /earn/dual/investment_planDual Investment product list
EarnApilist_dual_ordersGET /earn/dual/ordersDual Investment order list
EarnApiplace_dual_orderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilist_dual_balanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApiget_dual_order_refund_previewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplace_dual_order_refundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodify_dual_order_reinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApiget_dual_project_recommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifind_coinGET /earn/staking/coinsStaking coins
EarnApiswap_staking_coinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorder_listGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiaward_listGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiasset_listGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreate_auto_invest_planPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdate_auto_invest_planPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistop_auto_invest_planPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiadd_position_auto_invest_planPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilist_auto_invest_coinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApiget_auto_invest_min_amountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilist_auto_invest_plan_recordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilist_auto_invest_ordersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilist_auto_invest_configGET /earn/autoinvest/configList investment currency configuration
EarnApiget_auto_invest_plan_detailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilist_auto_invest_plansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilist_earn_fixed_term_productsGET /earn/fixed-term/productGet product list
EarnApilist_earn_fixed_term_products_by_assetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilist_earn_fixed_term_lendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreate_earn_fixed_term_lendPOST /earn/fixed-term/user/lendSubscription
EarnApicreate_earn_fixed_term_pre_redeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilist_earn_fixed_term_historyGET /earn/fixed-term/user/historySubscription history
FlashSwapApilist_flash_swap_currency_pairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilist_flash_swap_ordersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreate_flash_swap_orderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApiget_flash_swap_orderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreview_flash_swap_orderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreate_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreview_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreate_flash_swap_order_v1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreate_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreview_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreview_flash_swap_order_v1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilist_futures_contractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApilist_futures_contracts_allGET /futures/{settle}/contracts_allQuery all contract information (including delisted)
FuturesApiget_futures_contractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilist_futures_adl_risk_statesGET /futures/{settle}/adl_risk_statesList market-level ADL risk states
FuturesApilist_futures_order_bookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilist_futures_tradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilist_futures_candlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilist_futures_premium_indexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilist_futures_tickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilist_futures_funding_rate_historyGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilist_batch_futures_funding_ratesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilist_futures_insurance_ledgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilist_contract_statsGET /futures/{settle}/contract_statsFutures statistics
FuturesApiget_index_constituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilist_liquidated_ordersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilist_futures_risk_limit_tiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilist_futures_accountsGET /futures/{settle}/accountsGet futures account
FuturesApilist_futures_account_bookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilist_positionsGET /futures/{settle}/positionsGet user position list
FuturesApilist_positions_timerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApiget_positionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApiget_leverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdate_position_marginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdate_position_leveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdate_contract_position_leveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdate_position_cross_modePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdate_dual_comp_position_cross_modePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdate_position_risk_limitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApiset_dual_modePOST /futures/{settle}/dual_modeSet position mode
FuturesApiset_position_modePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApiget_dual_mode_positionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdate_dual_mode_position_marginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdate_dual_mode_position_leveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdate_dual_mode_position_risk_limitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilist_futures_ordersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreate_futures_orderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancel_futures_ordersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApiget_orders_with_time_rangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreate_batch_futures_orderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApiget_futures_orderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamend_futures_orderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancel_futures_orderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApiget_my_tradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApiget_my_trades_with_time_rangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilist_position_closeGET /futures/{settle}/position_closeQuery position close history
FuturesApilist_liquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilist_auto_deleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdown_cancel_all_futuresPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApiget_futures_feeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancel_batch_future_ordersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamend_batch_future_ordersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApiget_futures_risk_limit_tableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreate_futures_bbo_orderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistop_trail_orderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistop_all_trail_ordersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApiget_trail_ordersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApiget_trail_order_detailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApiget_trail_order_change_logGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApicreate_chase_orderPOST /futures/{settle}/autoorder/v1/chase/createCreate a chase order
FuturesApistop_chase_orderPOST /futures/{settle}/autoorder/v1/chase/stopStop a chase order
FuturesApistop_all_chase_ordersPOST /futures/{settle}/autoorder/v1/chase/stop_allStop chase orders in batch
FuturesApiget_chase_ordersGET /futures/{settle}/autoorder/v1/chase/listList chase orders
FuturesApiget_chase_order_detailGET /futures/{settle}/autoorder/v1/chase/detailGet chase order detail
FuturesApilist_price_triggered_ordersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreate_price_triggered_orderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancel_price_triggered_order_listDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApiget_price_triggered_orderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancel_price_triggered_orderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdate_price_triggered_orderPUT /futures/{settle}/price_orders/amendModify a Single Auto Order
MarginApilist_margin_accountsGET /margin/accountsMargin account list
MarginApilist_margin_account_bookGET /margin/account_bookQuery margin account balance change history
MarginApilist_funding_accountsGET /margin/funding_accountsFunding account list
MarginApiget_auto_repay_statusGET /margin/auto_repayQuery user auto repayment settings
MarginApiset_auto_repayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApiget_margin_transferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApiget_user_margin_tierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApiget_market_margin_tierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApiset_user_market_leveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilist_margin_user_accountGET /margin/user/accountQuery user's isolated margin account list
MarginApilist_cross_margin_loansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilist_cross_margin_repaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MultiCollateralLoanApilist_multi_collateral_ordersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreate_multi_collateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApiget_multi_collateral_order_detailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilist_multi_repay_recordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepay_multi_collateral_loanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilist_multi_collateral_recordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperate_multi_collateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilist_user_currency_quotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilist_multi_collateral_currenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApiget_multi_collateral_ltvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApiget_multi_collateral_fix_rateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApiget_multi_collateral_current_rateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OptionsApilist_options_underlyingsGET /options/underlyingsList all underlying assets
OptionsApilist_options_expirationsGET /options/expirationsList all expiration dates
OptionsApilist_options_contractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApiget_options_contractGET /options/contracts/{contract}Query specified contract details
OptionsApilist_options_settlementsGET /options/settlementsList settlement history
OptionsApiget_options_settlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilist_my_options_settlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilist_options_order_bookGET /options/order_bookQuery options contract order book
OptionsApilist_options_tickersGET /options/tickersQuery options market ticker information
OptionsApilist_options_underlying_tickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilist_options_candlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilist_options_underlying_candlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilist_options_tradesGET /options/tradesMarket trade records
OptionsApilist_options_accountGET /options/accountsQuery account information
OptionsApilist_options_account_bookGET /options/account_bookQuery account change history
OptionsApilist_options_positionsGET /options/positionsList user's positions of specified underlying
OptionsApiget_options_positionGET /options/positions/{contract}Get specified contract position
OptionsApilist_options_position_closeGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilist_options_ordersGET /options/ordersList options orders
OptionsApicreate_options_orderPOST /options/ordersCreate an options order
OptionsApicancel_options_ordersDELETE /options/ordersCancel all orders with 'open' status
OptionsApiget_options_orderGET /options/orders/{order_id}Query single order details
OptionsApiamend_options_orderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancel_options_orderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdown_cancel_all_optionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilist_my_options_tradesGET /options/my_tradesQuery personal trading records
OptionsApiget_options_mmpGET /options/mmpMMP Query.
OptionsApiset_options_mmpPOST /options/mmpMMP Settings
OptionsApireset_options_mmpPOST /options/mmp/resetMMP Reset
P2pApip2p_merchant_account_get_user_infoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2p_merchant_account_get_counterparty_user_infoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2p_merchant_account_get_myself_paymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2p_merchant_account_set_merchant_work_hoursPOST /p2p/merchant/account/set_merchant_work_hoursSet merchant working status and custom working hours
P2pApip2p_merchant_transaction_get_pending_transaction_listPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2p_merchant_transaction_get_completed_transaction_listPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2p_merchant_transaction_get_transaction_detailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2p_merchant_transaction_confirm_paymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2p_merchant_transaction_confirm_receiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2p_merchant_transaction_cancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2p_merchant_books_place_biz_push_orderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2p_merchant_books_ads_update_statusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2p_merchant_books_ads_detailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2p_merchant_books_my_ads_listPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2p_merchant_books_ads_listPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2p_merchant_chat_get_chats_listPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2p_merchant_chat_send_chat_messagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2p_merchant_chat_upload_chat_filePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagency_transaction_historyGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagency_commissions_historyGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartner_transaction_historyGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartner_commissions_historyGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartner_sub_listGET /rebate/partner/sub_listPartner subordinate list
RebateApirebate_broker_commission_historyGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebate_broker_transaction_historyGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebate_user_infoGET /rebate/user/infoUser obtains rebate information
RebateApiuser_sub_relationGET /rebate/user/sub_relationUser subordinate relationship
RebateApiget_partner_application_recentGET /rebate/partner/applications/recentGet recent partner application records
RebateApiget_partner_eligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApiget_partner_agent_data_aggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilist_currenciesGET /spot/currenciesQuery all currency information
SpotApiget_currencyGET /spot/currencies/{currency}Query single currency information
SpotApilist_currency_pairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApiget_currency_pairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilist_tickersGET /spot/tickersGet currency pair ticker information
SpotApilist_order_bookGET /spot/order_bookGet market depth information
SpotApilist_tradesGET /spot/tradesQuery market transaction records
SpotApilist_candlesticksGET /spot/candlesticksMarket K-line chart
SpotApiget_feeGET /spot/feeQuery account fee rates
SpotApiget_batch_spot_feeGET /spot/batch_feeBatch query account fee rates
SpotApilist_spot_accountsGET /spot/accountsList spot trading accounts
SpotApilist_spot_account_bookGET /spot/account_bookQuery spot account transaction history
SpotApicreate_batch_ordersPOST /spot/batch_ordersBatch place orders
SpotApilist_all_open_ordersGET /spot/open_ordersList all open orders
SpotApicreate_cross_liquidate_orderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilist_ordersGET /spot/ordersList orders
SpotApicreate_orderPOST /spot/ordersCreate order
SpotApicancel_ordersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancel_batch_ordersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApiget_orderGET /spot/orders/{order_id}Query single order details
SpotApicancel_orderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamend_orderPATCH /spot/orders/{order_id}Amend single order
SpotApilist_my_tradesGET /spot/my_tradesQuery personal trading records
SpotApiget_system_timeGET /spot/timeGet server current time
SpotApicountdown_cancel_all_spotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamend_batch_ordersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApiget_spot_insurance_historyGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilist_spot_price_triggered_ordersGET /spot/price_ordersQuery running auto order list
SpotApicreate_spot_price_triggered_orderPOST /spot/price_ordersCreate price-triggered order
SpotApicancel_spot_price_triggered_order_listDELETE /spot/price_ordersCancel all auto orders
SpotApiget_spot_price_triggered_orderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancel_spot_price_triggered_orderDELETE /spot/price_orders/{order_id}Cancel single auto order
SpotApilist_spot_pov_ordersGET /spot/pov_ordersList Spot POV orders
SpotApicreate_spot_pov_orderPOST /spot/pov_ordersCreate a Spot POV order
SpotApicancel_spot_pov_ordersDELETE /spot/pov_ordersCancel Spot POV orders
SpotApiget_spot_pov_orderGET /spot/pov_orders/{order_id}Query Spot POV order details
SpotApicancel_spot_pov_orderDELETE /spot/pov_orders/{order_id}Cancel a Spot POV order
SquareApilist_square_ai_searchGET /social/message/searchAI MCP Dynamic Search
SquareApilist_live_replayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
WalletApilist_currency_chainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApiget_deposit_addressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilist_withdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilist_depositsGET /wallet/depositsGet deposit records
WalletApiget_transferGET /wallet/transfersGet trading account transfer
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilist_sub_account_transfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransfer_with_sub_accountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisub_account_to_sub_accountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApiget_transfer_order_statusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilist_withdraw_statusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilist_sub_account_balancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilist_sub_account_margin_balancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilist_sub_account_futures_balancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilist_sub_account_cross_margin_balancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilist_saved_addressGET /wallet/saved_addressQuery saved address
WalletApiget_trade_feeGET /wallet/feeQuery personal trading fees
WalletApiget_total_balanceGET /wallet/total_balanceQuery personal account totals
WalletApilist_small_balanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvert_small_balancePOST /wallet/small_balanceConvert small balance currency
WalletApilist_small_balance_historyGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilist_push_ordersGET /wallet/pushGet UID transfer history
WalletApiget_low_cap_exchange_listGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApiget_user_identityGET /rewards/getUserIdentityGet user identity
WelfareApiget_beginner_task_listGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaim_taskPOST /rewards/claimTaskGet the task
WelfareApiclaim_rewardPOST /rewards/claimRewardReceive mission rewards
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdraw_push_orderPOST /withdrawals/pushUID transfer
WithdrawalApicancel_withdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

apiv4

Authentication with APIv4 key and secret

For details, refer to: APIv4 signed request requirements

Author

support@mail.gate.com

About

No description, website, or topics provided.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - gate/gateapi-python · GitHub
Skip to content

Repository files navigation

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 Python package is automatically generated by the OpenAPI Generator project:

  • API version: v4.106.129
  • Package version: 7.2.129
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gate.com/page/contacts

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly using:

pip install --user gate-api

Then import the package:

importgate_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgate_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.ActivityApi(api_client)
try:
# My activity entryapi_response=api_instance.get_my_activity_entry()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling ActivityApi->get_my_activity_entry: %s\n"%e)

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ActivityApiget_my_activity_entryGET /rewards/activity/my-activity-entryMy activity entry
ActivityApilist_activitiesGET /rewards/activity/activity-listRecommended activity list
ActivityApilist_activity_typesGET /rewards/activity/activity-typeActivity type list
CFDApiquery_mt5_account_infoGET /tradfi/users/mt5-accountQuery MT5 account information
CFDApiquery_categoriesGET /tradfi/symbols/categoriesQuery trading symbol categories
CFDApiquery_symbol_commissionsGET /tradfi/symbols/commissionsQuery symbol commission rates
CFDApiquery_symbolsGET /tradfi/symbolsQuery trading symbol list
CFDApiquery_symbol_detailGET /tradfi/symbols/detailQuery trading symbol details
CFDApiquery_symbol_klineGET /tradfi/symbols/{symbol}/klinesQuery trading symbol klines
CFDApiquery_symbol_tickerGET /tradfi/symbols/{symbol}/tickersQuery trading symbol ticker
CFDApicreate_trad_fi_userPOST /tradfi/usersCreate CFD user
CFDApiquery_user_assetsGET /tradfi/users/assetsQuery account assets
CFDApiquery_transactionGET /tradfi/transactionsQuery Fund Transfer In/Out Records
CFDApicreate_transactionPOST /tradfi/transactionsFund transfer
CFDApiquery_order_listGET /tradfi/ordersQuery active order list
CFDApicreate_trad_fi_orderPOST /tradfi/ordersCreate order
CFDApiupdate_orderPUT /tradfi/orders/{order_id}Modify order
CFDApidelete_orderDELETE /tradfi/orders/{order_id}Cancel order
CFDApiquery_order_history_listGET /tradfi/orders/historyQuery historical order list
CFDApiquery_order_logGET /tradfi/orders/log/{log_id}Get order details by log ID
CFDApiquery_position_listGET /tradfi/positionsQuery active position list
CFDApiupdate_positionPUT /tradfi/positions/{position_id}Modify position
CFDApiclose_positionPOST /tradfi/positions/{position_id}/closeClose position
CFDApiquery_position_history_listGET /tradfi/positions/historyQuery historical position list
CrossExApilist_crossex_rule_symbolsGET /crossex/rule/symbolsQuery symbol information
CrossExApilist_crossex_rule_risk_limitsGET /crossex/rule/risk_limitsQuery risk limit information
CrossExApilist_crossex_transfer_coinsGET /crossex/transfers/coinQuery supported transfer currencies
CrossExApilist_crossex_transfersGET /crossex/transfersQuery Fund Transfer History
CrossExApicreate_crossex_transferPOST /crossex/transfersFund Transfer
CrossExApicreate_crossex_orderPOST /crossex/ordersCreate order
CrossExApicancel_batch_crossex_ordersPOST /crossex/batch_cancel_ordersBatch cancel orders
CrossExApiget_crossex_orderGET /crossex/orders/{order_id}Query order details
CrossExApiupdate_crossex_orderPUT /crossex/orders/{order_id}Modify Order
CrossExApicancel_crossex_orderDELETE /crossex/orders/{order_id}Cancel Order
CrossExApicreate_crossex_convert_quotePOST /crossex/convert/quoteFlash Swap Inquiry
CrossExApicreate_crossex_convert_orderPOST /crossex/convert/ordersFlash Swap Transaction
CrossExApiget_crossex_accountGET /crossex/accountsQuery Account Assets
CrossExApiupdate_crossex_accountPUT /crossex/accountsModify Account Contract Position Mode and Account Mode
CrossExApiget_crossex_positions_leverageGET /crossex/positions/leverageQuery Contract Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_positions_leveragePOST /crossex/positions/leverageModify Contract Trading Pair Leverage Multiplier
CrossExApiget_crossex_margin_positions_leverageGET /crossex/margin_positions/leverageQuery Leveraged Trading Pair Leverage Multiplier
CrossExApiupdate_crossex_margin_positions_leveragePOST /crossex/margin_positions/leverageModify Leveraged Trading Pair Leverage Multiplier
CrossExApiclose_crossex_positionPOST /crossex/positionFull Close Position
CrossExApiget_crossex_positions_margin_modeGET /crossex/positions/margin_modeGet futures position margin mode
CrossExApiupdate_crossex_positions_margin_modePOST /crossex/positions/margin_modeUpdate futures position margin mode
CrossExApiupdate_crossex_positions_marginPOST /crossex/positions/marginIncrease or decrease isolated margin
CrossExApiget_crossex_interest_rateGET /crossex/interest_rateQuery margin asset interest rates
CrossExApiget_crossex_feeGET /crossex/feeQuery User Fee Rates
CrossExApilist_crossex_positionsGET /crossex/positionsQuery Contract Positions
CrossExApilist_crossex_margin_positionsGET /crossex/margin_positionsQuery Leveraged Positions
CrossExApilist_crossex_adl_rankGET /crossex/adl_rankQuery ADL Position Reduction Ranking
CrossExApilist_crossex_open_ordersGET /crossex/open_ordersQuery All Current Open Orders
CrossExApilist_crossex_history_ordersGET /crossex/history_ordersQuery order history
CrossExApilist_crossex_history_positionsGET /crossex/history_positionsQuery Contract Position History
CrossExApilist_crossex_history_margin_positionsGET /crossex/history_margin_positionsQuery Leveraged Position History
CrossExApilist_crossex_history_margin_interestsGET /crossex/history_margin_interestsQuery Leveraged Interest Deduction History
CrossExApilist_crossex_history_tradesGET /crossex/history_tradesQuery filled history
CrossExApilist_crossex_account_bookGET /crossex/account_bookQuery Account Asset Change History
CrossExApilist_crossex_coin_discount_rateGET /crossex/coin_discount_rateQuery Currency Discount Rate
CrossExApilist_crossex_market_tickersGET /crossex/market/tickersGet exchange tickers
CrossExApilist_crossex_market_funding_infoGET /crossex/market/funding_infoGet exchange futures funding rate information
EarnUniApilist_uni_currenciesGET /earn/uni/currenciesQuery lending currency list
EarnUniApiget_uni_currencyGET /earn/uni/currencies/{currency}Query single lending currency details
EarnUniApilist_user_uni_lendsGET /earn/uni/lendsQuery user's lending order list
EarnUniApicreate_uni_lendPOST /earn/uni/lendsCreate lending or redemption
EarnUniApichange_uni_lendPATCH /earn/uni/lendsAmend user lending information
EarnUniApilist_uni_lend_recordsGET /earn/uni/lend_recordsQuery lending transaction records
EarnUniApiget_uni_interestGET /earn/uni/interests/{currency}Query user's total interest income for specified currency
EarnUniApilist_uni_interest_recordsGET /earn/uni/interest_recordsQuery user dividend records
EarnUniApiget_uni_interest_statusGET /earn/uni/interest_status/{currency}Query currency interest compounding status
EarnUniApilist_uni_chartGET /earn/uni/chartUniLoan currency annualized trend chart
EarnUniApilist_uni_rateGET /earn/uni/rateCurrency estimated annualized interest rate
MarginUniApilist_uni_currency_pairsGET /margin/uni/currency_pairsList lending markets
MarginUniApiget_uni_currency_pairGET /margin/uni/currency_pairs/{currency_pair}Get lending market details
MarginUniApiget_margin_uni_estimate_rateGET /margin/uni/estimate_rateEstimate interest rate for isolated margin currencies
MarginUniApilist_uni_loansGET /margin/uni/loansQuery loans
MarginUniApicreate_uni_loanPOST /margin/uni/loansBorrow or repay
MarginUniApilist_uni_loan_recordsGET /margin/uni/loan_recordsQuery loan records
MarginUniApilist_uni_loan_interest_recordsGET /margin/uni/interest_recordsQuery interest deduction records
MarginUniApiget_uni_borrowableGET /margin/uni/borrowableQuery maximum borrowable amount by currency
OTCApicreate_otc_quotePOST /otc/quoteFiat and stablecoin quote
OTCApicreate_otc_orderPOST /otc/order/createCreate fiat order
OTCApicreate_stable_coin_orderPOST /otc/stable_coin/order/createCreate stablecoin order
OTCApiget_bank_list_inner_pathGET /otc/bank/listGet user bank card list
OTCApicreate_otc_bankPOST /otc/bank/createCreate bank card
OTCApidelete_otc_bankPOST /otc/bank/deleteDelete bank card
OTCApiset_default_otc_bankPOST /otc/bank/set_defaultSet default bank card
OTCApiget_otc_bank_supplement_checklistGET /otc/bank/bank_supplement_checklistQuery the checklist of materials to supplement for a bank card
OTCApisubmit_otc_bank_personal_supplementPOST /otc/bank/personal/bank_supplementSubmit Bank Card Supplement Materials (Personal)
OTCApisubmit_otc_bank_enterprise_supplementPOST /otc/bank/enterprise/bank_supplementSubmit Bank Card Supplement Materials (Enterprise)
OTCApimark_otc_order_paidPOST /otc/order/paidMark fiat order as paid (deposit confirmation)
OTCApicancel_otc_orderPOST /otc/order/cancelFiat order cancellation
OTCApilist_otc_ordersGET /otc/order/listFiat order list
OTCApilist_stable_coin_ordersGET /otc/stable_coin/order/listStablecoin order list
OTCApiget_otc_order_detailGET /otc/order/detailFiat order details
StockApiquery_stock_user_assetsGET /stock/users/assetsQuery user assets
StockApiquery_stock_symbolsGET /stock/symbolsQuery symbol list
StockApiquery_stock_symbol_detailGET /stock/symbols/detailQuery symbol details
StockApiquery_stock_order_bookGET /stock/market/{symbol}/orderbookQuery market order book
StockApiquery_stock_order_listGET /stock/ordersQuery open order list
StockApicreate_stock_orderPOST /stock/ordersCreate order
StockApidelete_all_stock_ordersDELETE /stock/ordersCancel all open orders
StockApiquery_stock_order_historyGET /stock/orders/historyQuery historical order list
StockApiupdate_stock_orderPUT /stock/orders/{order_id}Modify order
StockApidelete_stock_orderDELETE /stock/orders/{order_id}Cancel order
StockApiquery_stock_positionsGET /stock/positionsQuery current position list
StockApiclose_stock_positionPOST /stock/positions/closeClose position
StockApiquery_stock_transactionsGET /stock/transactionsQuery transaction records
StockApicreate_stock_transactionPOST /stock/transactionsFund transfer
StockApiquery_stock_exchangesGET /stock/exchangesQuery supported exchanges
StockApiquery_stock_fee_rateGET /stock/fee-rateQuery fee rates for Japanese and Korean stocks
SubAccountApilist_sub_accountsGET /sub_accountsList sub-accounts
SubAccountApicreate_sub_accountsPOST /sub_accountsCreate a new sub-account
SubAccountApiget_sub_accountGET /sub_accounts/{user_id}Get sub-account
SubAccountApilist_sub_account_keysGET /sub_accounts/{user_id}/keysList all API key pairs of the sub-account
SubAccountApicreate_sub_account_keysPOST /sub_accounts/{user_id}/keysCreate new sub-account API key pair
SubAccountApiget_sub_account_keyGET /sub_accounts/{user_id}/keys/{key}Get specific API key pair of the sub-account
SubAccountApiupdate_sub_account_keysPUT /sub_accounts/{user_id}/keys/{key}Update sub-account API key pair
SubAccountApidelete_sub_account_keysDELETE /sub_accounts/{user_id}/keys/{key}Delete sub-account API key pair
SubAccountApilock_sub_accountPOST /sub_accounts/{user_id}/lockLock sub-account
SubAccountApiunlock_sub_accountPOST /sub_accounts/{user_id}/unlockUnlock sub-account
SubAccountApilist_unified_modeGET /sub_accounts/unified_modeGet sub-account mode
UnifiedApilist_unified_accountsGET /unified/accountsGet unified account information
UnifiedApiget_unified_borrowableGET /unified/borrowableQuery maximum borrowable amount for unified account
UnifiedApiget_unified_transferableGET /unified/transferableQuery maximum transferable amount for unified account
UnifiedApiget_unified_transferablesGET /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
UnifiedApiget_unified_borrowable_listGET /unified/batch_borrowableBatch query unified account maximum borrowable amount
UnifiedApilist_unified_loansGET /unified/loansQuery loans
UnifiedApicreate_unified_loanPOST /unified/loansBorrow or repay
UnifiedApilist_unified_loan_recordsGET /unified/loan_recordsQuery loan records
UnifiedApilist_unified_loan_interest_recordsGET /unified/interest_recordsQuery interest deduction records
UnifiedApiget_unified_risk_unitsGET /unified/risk_unitsGet user risk unit details
UnifiedApiget_unified_modeGET /unified/unified_modeQuery mode of the unified account
UnifiedApiset_unified_modePUT /unified/unified_modeSet unified account mode
UnifiedApiget_unified_estimate_rateGET /unified/estimate_rateQuery unified account estimated interest rate
UnifiedApilist_currency_discount_tiersGET /unified/currency_discount_tiersQuery unified account tiered
UnifiedApilist_loan_margin_tiersGET /unified/loan_margin_tiersQuery unified account tiered loan margin
UnifiedApicalculate_portfolio_marginPOST /unified/portfolio_calculatorPortfolio margin calculator
UnifiedApiset_user_leveragePOST /unified/leverage/user_settingSet leverage for all of the user's borrowed currencies
UnifiedApiget_user_leverage_currency_configGET /unified/leverage/user_currency_configMaximum and minimum currency leverage that can be set
UnifiedApiget_user_leverage_currency_settingGET /unified/leverage/user_currency_settingGet user currency leverage
UnifiedApiset_user_leverage_currency_settingPOST /unified/leverage/user_currency_settingSet loan currency leverage
UnifiedApilist_unified_currenciesGET /unified/currenciesList of loan currencies supported by unified account
UnifiedApiget_history_loan_rateGET /unified/history_loan_rateGet historical lending rates
UnifiedApiset_unified_collateralPOST /unified/collateral_currenciesSet collateral currency
UnifiedApiget_estimated_quick_repaymentGET /unified/estimated_quick_repaymentEstimated quick repayment details
UnifiedApicreate_quick_repaymentPOST /unified/quick_repaymentQuick repayment
UnifiedApiget_unified_delta_neutralGET /unified/delta_neutralQuery the account Delta-neutral strategy mode setting
UnifiedApiset_unified_delta_neutralPOST /unified/delta_neutralSet the account Delta-neutral strategy mode
AccountApiget_account_detailGET /account/detailRetrieve user account information
AccountApiget_account_main_keysGET /account/main_keysQuery All Main Account Key Information
AccountApiget_account_rate_limitGET /account/rate_limitGet user transaction rate limit information
AccountApilist_stp_groupsGET /account/stp_groupsQuery STP user groups created by the user
AccountApicreate_stp_groupPOST /account/stp_groupsCreate STP user group
AccountApilist_stp_groups_usersGET /account/stp_groups/{stp_id}/usersQuery users in the STP user group
AccountApiadd_stp_group_usersPOST /account/stp_groups/{stp_id}/usersAdd users to the STP user group
AccountApidelete_stp_group_usersDELETE /account/stp_groups/{stp_id}/usersDelete users from the STP user group
AccountApiget_debit_feeGET /account/debit_feeQuery GT fee deduction configuration
AccountApiset_debit_feePOST /account/debit_feeConfigure GT fee deduction
AlphaApilist_alpha_accountsGET /alpha/accountsAlpha Account API
AlphaApilist_alpha_account_bookGET /alpha/account_bookAlpha Account Transaction History API
AlphaApiquote_alpha_orderPOST /alpha/quoteAlpha Quote API
AlphaApilist_alpha_orderGET /alpha/ordersAlpha Order List API
AlphaApiplace_alpha_orderPOST /alpha/ordersAlpha Order API
AlphaApiget_alpha_orderGET /alpha/orderAlpha Single Order Query API
AlphaApilist_alpha_currenciesGET /alpha/currenciesQuery currency information
AlphaApilist_alpha_tickersGET /alpha/tickersQuery currency ticker
AlphaApilist_alpha_tokensGET /alpha/tokensQuery Token Information
AssetswapApilist_asset_swap_assetsGET /asset-swap/asset/listPortfolio optimization — currency list
AssetswapApiget_asset_swap_configGET /asset-swap/configPortfolio optimization — configuration
AssetswapApievaluate_asset_swapGET /asset-swap/evaluatePortfolio optimization — valuation
AssetswapApicreate_asset_swap_order_v1POST /asset-swap/order/createPortfolio optimization — place order
AssetswapApilist_asset_swap_orders_v1GET /asset-swap/order/listPortfolio optimization — order list
AssetswapApipreview_asset_swap_order_v1POST /asset-swap/order/previewPortfolio optimization — preview
AssetswapApiget_asset_swap_order_v1GET /asset-swap/order/{order_id}Portfolio optimization — query order
BotApiget_ai_hub_strategy_recommendGET /bot/strategy/recommendGet AIHub strategy recommendations
BotApipost_ai_hub_spot_grid_createPOST /bot/spot-grid/createCreate spot grid
BotApipost_ai_hub_margin_grid_createPOST /bot/margin-grid/createCreate a lever grid
BotApipost_ai_hub_infinite_grid_createPOST /bot/infinite-grid/createCreate infinite grid
BotApipost_ai_hub_futures_grid_createPOST /bot/futures-grid/createCreate a contract grid
BotApipost_ai_hub_spot_martingale_createPOST /bot/spot-martingale/createCreate Spot Martin
BotApipost_ai_hub_contract_martingale_createPOST /bot/contract-martingale/createCreate contract martin
BotApiget_ai_hub_portfolio_runningGET /bot/portfolio/runningQuery the list of running policies
BotApiget_ai_hub_portfolio_detailGET /bot/portfolio/detailQuery order policy details
BotApipost_ai_hub_portfolio_stopPOST /bot/portfolio/stopTerminate a single running policy
CouponApilist_user_couponsGET /coupon/user-coupon-listCoupon Center list
CouponApiget_user_coupon_detailGET /coupon/user-coupon-detailCoupon Center details
DeliveryApilist_delivery_contractsGET /delivery/{settle}/contractsQuery all futures contracts
DeliveryApiget_delivery_contractGET /delivery/{settle}/contracts/{contract}Query single contract information
DeliveryApilist_delivery_order_bookGET /delivery/{settle}/order_bookQuery futures market depth information
DeliveryApilist_delivery_tradesGET /delivery/{settle}/tradesFutures market transaction records
DeliveryApilist_delivery_candlesticksGET /delivery/{settle}/candlesticksFutures market K-line chart
DeliveryApilist_delivery_tickersGET /delivery/{settle}/tickersGet all futures trading statistics
DeliveryApilist_delivery_insurance_ledgerGET /delivery/{settle}/insuranceFutures market insurance fund history
DeliveryApilist_delivery_accountsGET /delivery/{settle}/accountsGet futures account
DeliveryApilist_delivery_account_bookGET /delivery/{settle}/account_bookQuery futures account change history
DeliveryApilist_delivery_positionsGET /delivery/{settle}/positionsGet user position list
DeliveryApiget_delivery_positionGET /delivery/{settle}/positions/{contract}Get single position information
DeliveryApiupdate_delivery_position_marginPOST /delivery/{settle}/positions/{contract}/marginUpdate position margin
DeliveryApiupdate_delivery_position_leveragePOST /delivery/{settle}/positions/{contract}/leverageUpdate position leverage
DeliveryApiupdate_delivery_position_risk_limitPOST /delivery/{settle}/positions/{contract}/risk_limitUpdate position risk limit
DeliveryApilist_delivery_ordersGET /delivery/{settle}/ordersQuery futures order list
DeliveryApicreate_delivery_orderPOST /delivery/{settle}/ordersPlace futures order
DeliveryApicancel_delivery_ordersDELETE /delivery/{settle}/ordersCancel all orders with 'open' status
DeliveryApiget_delivery_orderGET /delivery/{settle}/orders/{order_id}Query single order details
DeliveryApicancel_delivery_orderDELETE /delivery/{settle}/orders/{order_id}Cancel single order
DeliveryApiget_my_delivery_tradesGET /delivery/{settle}/my_tradesQuery personal trading records
DeliveryApilist_delivery_position_closeGET /delivery/{settle}/position_closeQuery position close history
DeliveryApilist_delivery_liquidatesGET /delivery/{settle}/liquidatesQuery liquidation history
DeliveryApilist_delivery_settlementsGET /delivery/{settle}/settlementsQuery settlement records
DeliveryApilist_delivery_risk_limit_tiersGET /delivery/{settle}/risk_limit_tiersQuery risk limit tiers
DeliveryApilist_price_triggered_delivery_ordersGET /delivery/{settle}/price_ordersQuery auto order list
DeliveryApicreate_price_triggered_delivery_orderPOST /delivery/{settle}/price_ordersCreate price-triggered order
DeliveryApicancel_price_triggered_delivery_order_listDELETE /delivery/{settle}/price_ordersCancel all auto orders
DeliveryApiget_price_triggered_delivery_orderGET /delivery/{settle}/price_orders/{order_id}Query single auto order details
DeliveryApicancel_price_triggered_delivery_orderDELETE /delivery/{settle}/price_orders/{order_id}Cancel single auto order
EarnApilist_dual_investment_plansGET /earn/dual/investment_planDual Investment product list
EarnApilist_dual_ordersGET /earn/dual/ordersDual Investment order list
EarnApiplace_dual_orderPOST /earn/dual/ordersPlace Dual Investment order
EarnApilist_dual_balanceGET /earn/dual/balanceDual-Currency Earning Assets
EarnApiget_dual_order_refund_previewGET /earn/dual/order-refund-previewDual-currency early redemption preview
EarnApiplace_dual_order_refundPOST /earn/dual/order-refundDual-currency order early redemption
EarnApimodify_dual_order_reinvestPOST /earn/dual/modify-order-reinvestModify dual-currency order reinvest
EarnApiget_dual_project_recommendGET /earn/dual/project-recommendDual-currency recommended projects
EarnApifind_coinGET /earn/staking/coinsStaking coins
EarnApiswap_staking_coinPOST /earn/staking/swapOn-chain token swap for earned coins
EarnApiorder_listGET /earn/staking/order_listList of on-chain coin-earning orders
EarnApiaward_listGET /earn/staking/award_listOn-chain coin-earning dividend records
EarnApiasset_listGET /earn/staking/assetsOn-chain coin-earning assets
EarnApicreate_auto_invest_planPOST /earn/autoinvest/plans/createCreate auto invest plan
EarnApiupdate_auto_invest_planPOST /earn/autoinvest/plans/updateUpdateAuto invest plan
EarnApistop_auto_invest_planPOST /earn/autoinvest/plans/stopStopAuto invest plan
EarnApiadd_position_auto_invest_planPOST /earn/autoinvest/plans/add_positionAdd position immediately
EarnApilist_auto_invest_coinsGET /earn/autoinvest/coinsQueryCurrencies supporting auto invest
EarnApiget_auto_invest_min_amountPOST /earn/autoinvest/min_invest_amountGet minimum investment amount
EarnApilist_auto_invest_plan_recordsGET /earn/autoinvest/plans/recordsList plan execution records
EarnApilist_auto_invest_ordersGET /earn/autoinvest/ordersList plan execution recordsDetails(OrderDetails)
EarnApilist_auto_invest_configGET /earn/autoinvest/configList investment currency configuration
EarnApiget_auto_invest_plan_detailGET /earn/autoinvest/plans/detailQueryAuto invest planDetails
EarnApilist_auto_invest_plansGET /earn/autoinvest/plans/list_infoQueryAuto invest planList
EarnApilist_earn_fixed_term_productsGET /earn/fixed-term/productGet product list
EarnApilist_earn_fixed_term_products_by_assetGET /earn/fixed-term/product/{asset}/listGet product list by single currency
EarnApilist_earn_fixed_term_lendsGET /earn/fixed-term/user/lendSubscription list
EarnApicreate_earn_fixed_term_lendPOST /earn/fixed-term/user/lendSubscription
EarnApicreate_earn_fixed_term_pre_redeemPOST /earn/fixed-term/user/pre-redeemRedeem
EarnApilist_earn_fixed_term_historyGET /earn/fixed-term/user/historySubscription history
FlashSwapApilist_flash_swap_currency_pairGET /flash_swap/currency_pairsList All Supported Currency Pairs In Flash Swap
FlashSwapApilist_flash_swap_ordersGET /flash_swap/ordersQuery flash swap order list
FlashSwapApicreate_flash_swap_orderPOST /flash_swap/ordersCreate a flash swap order
FlashSwapApiget_flash_swap_orderGET /flash_swap/orders/{order_id}Query single flash swap order
FlashSwapApipreview_flash_swap_orderPOST /flash_swap/orders/previewFlash swap order preview
FlashSwapApicreate_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/createFlash Swap - Multi-currency exchange - Place order (many-to-one)
FlashSwapApipreview_flash_swap_multi_currency_many_to_one_orderPOST /flash_swap/multi-currency/many-to-one/order/previewFlash Swap - Multi-currency exchange - Preview (many-to-one)
FlashSwapApicreate_flash_swap_order_v1POST /flash_swap/order/createFlash Swap - Place order (one-to-one)
FlashSwapApicreate_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/createFlash Swap - Multi-currency exchange - Place order (one-to-many)
FlashSwapApipreview_flash_swap_multi_currency_one_to_many_orderPOST /flash_swap/multi-currency/one-to-many/order/previewFlash Swap - Multi-currency exchange - Preview (one-to-many)
FlashSwapApipreview_flash_swap_order_v1GET /flash_swap/order/previewFlash Swap - Preview (one-to-one)
FuturesApilist_futures_contractsGET /futures/{settle}/contractsQuery all futures contracts
FuturesApilist_futures_contracts_allGET /futures/{settle}/contracts_allQuery all contract information (including delisted)
FuturesApiget_futures_contractGET /futures/{settle}/contracts/{contract}Query single contract information
FuturesApilist_futures_adl_risk_statesGET /futures/{settle}/adl_risk_statesList market-level ADL risk states
FuturesApilist_futures_order_bookGET /futures/{settle}/order_bookQuery futures market depth information
FuturesApilist_futures_tradesGET /futures/{settle}/tradesFutures market transaction records
FuturesApilist_futures_candlesticksGET /futures/{settle}/candlesticksFutures market K-line chart
FuturesApilist_futures_premium_indexGET /futures/{settle}/premium_indexPremium Index K-line chart
FuturesApilist_futures_tickersGET /futures/{settle}/tickersGet all futures trading statistics
FuturesApilist_futures_funding_rate_historyGET /futures/{settle}/funding_rateFutures market historical funding rate
FuturesApilist_batch_futures_funding_ratesPOST /futures/{settle}/funding_ratesBatch Query Historical Funding Rate Data for Perpetual Contracts
FuturesApilist_futures_insurance_ledgerGET /futures/{settle}/insuranceFutures market insurance fund history
FuturesApilist_contract_statsGET /futures/{settle}/contract_statsFutures statistics
FuturesApiget_index_constituentsGET /futures/{settle}/index_constituents/{index}Query index constituents
FuturesApilist_liquidated_ordersGET /futures/{settle}/liq_ordersQuery liquidation order history
FuturesApilist_futures_risk_limit_tiersGET /futures/{settle}/risk_limit_tiersQuery risk limit tiers
FuturesApilist_futures_accountsGET /futures/{settle}/accountsGet futures account
FuturesApilist_futures_account_bookGET /futures/{settle}/account_bookQuery futures account change history
FuturesApilist_positionsGET /futures/{settle}/positionsGet user position list
FuturesApilist_positions_timerangeGET /futures/{settle}/positions_timerangeGet user's historical position information list by time
FuturesApiget_positionGET /futures/{settle}/positions/{contract}Get single position information
FuturesApiget_leverageGET /futures/{settle}/get_leverage/{contract}Get Leverage Information for Specified Mode
FuturesApiupdate_position_marginPOST /futures/{settle}/positions/{contract}/marginUpdate position margin
FuturesApiupdate_position_leveragePOST /futures/{settle}/positions/{contract}/leverageUpdate position leverage
FuturesApiupdate_contract_position_leveragePOST /futures/{settle}/positions/{contract}/set_leverageUpdate Leverage for Specified Mode
FuturesApiupdate_position_cross_modePOST /futures/{settle}/positions/cross_modeSwitch Position Margin Mode
FuturesApiupdate_dual_comp_position_cross_modePOST /futures/{settle}/dual_comp/positions/cross_modeSwitch Between Cross and Isolated Margin Modes Under Hedge Mode
FuturesApiupdate_position_risk_limitPOST /futures/{settle}/positions/{contract}/risk_limitUpdate position risk limit
FuturesApiset_dual_modePOST /futures/{settle}/dual_modeSet position mode
FuturesApiset_position_modePOST /futures/{settle}/set_position_modeSet Position Holding Mode, replacing the dual_mode interface
FuturesApiget_dual_mode_positionGET /futures/{settle}/dual_comp/positions/{contract}Get position information in Hedge Mode
FuturesApiupdate_dual_mode_position_marginPOST /futures/{settle}/dual_comp/positions/{contract}/marginUpdate position margin in Hedge Mode
FuturesApiupdate_dual_mode_position_leveragePOST /futures/{settle}/dual_comp/positions/{contract}/leverageUpdate position leverage in Hedge Mode
FuturesApiupdate_dual_mode_position_risk_limitPOST /futures/{settle}/dual_comp/positions/{contract}/risk_limitUpdate position risk limit in Hedge Mode
FuturesApilist_futures_ordersGET /futures/{settle}/ordersQuery futures order list
FuturesApicreate_futures_orderPOST /futures/{settle}/ordersPlace futures order
FuturesApicancel_futures_ordersDELETE /futures/{settle}/ordersCancel all orders with 'open' status
FuturesApiget_orders_with_time_rangeGET /futures/{settle}/orders_timerangeQuery futures order list by time range
FuturesApicreate_batch_futures_orderPOST /futures/{settle}/batch_ordersPlace batch futures orders
FuturesApiget_futures_orderGET /futures/{settle}/orders/{order_id}Query single order details
FuturesApiamend_futures_orderPUT /futures/{settle}/orders/{order_id}Amend single order
FuturesApicancel_futures_orderDELETE /futures/{settle}/orders/{order_id}Cancel single order
FuturesApiget_my_tradesGET /futures/{settle}/my_tradesQuery personal trading records
FuturesApiget_my_trades_with_time_rangeGET /futures/{settle}/my_trades_timerangeQuery personal trading records by time range
FuturesApilist_position_closeGET /futures/{settle}/position_closeQuery position close history
FuturesApilist_liquidatesGET /futures/{settle}/liquidatesQuery liquidation history
FuturesApilist_auto_deleveragesGET /futures/{settle}/auto_deleveragesQuery ADL auto-deleveraging order information
FuturesApicountdown_cancel_all_futuresPOST /futures/{settle}/countdown_cancel_allCountdown cancel orders
FuturesApiget_futures_feeGET /futures/{settle}/feeQuery futures market trading fee rates
FuturesApicancel_batch_future_ordersPOST /futures/{settle}/batch_cancel_ordersCancel batch orders by specified ID list
FuturesApiamend_batch_future_ordersPOST /futures/{settle}/batch_amend_ordersBatch modify orders by specified IDs
FuturesApiget_futures_risk_limit_tableGET /futures/{settle}/risk_limit_tableQuery risk limit table by table_id
FuturesApicreate_futures_bbo_orderPOST /futures/{settle}/bbo_ordersLevel-based BBO Contract Order Placement
FuturesApicreate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/createCreate trail order
FuturesApistop_trail_orderPOST /futures/{settle}/autoorder/v1/trail/stopTerminate trail order
FuturesApistop_all_trail_ordersPOST /futures/{settle}/autoorder/v1/trail/stop_allBatch terminate trail orders
FuturesApiget_trail_ordersGET /futures/{settle}/autoorder/v1/trail/listGet trail order list
FuturesApiget_trail_order_detailGET /futures/{settle}/autoorder/v1/trail/detailGet trail order details
FuturesApiupdate_trail_orderPOST /futures/{settle}/autoorder/v1/trail/updateUpdate trail order
FuturesApiget_trail_order_change_logGET /futures/{settle}/autoorder/v1/trail/change_logGet trail order user modification records
FuturesApicreate_chase_orderPOST /futures/{settle}/autoorder/v1/chase/createCreate a chase order
FuturesApistop_chase_orderPOST /futures/{settle}/autoorder/v1/chase/stopStop a chase order
FuturesApistop_all_chase_ordersPOST /futures/{settle}/autoorder/v1/chase/stop_allStop chase orders in batch
FuturesApiget_chase_ordersGET /futures/{settle}/autoorder/v1/chase/listList chase orders
FuturesApiget_chase_order_detailGET /futures/{settle}/autoorder/v1/chase/detailGet chase order detail
FuturesApilist_price_triggered_ordersGET /futures/{settle}/price_ordersQuery auto order list
FuturesApicreate_price_triggered_orderPOST /futures/{settle}/price_ordersCreate price-triggered order
FuturesApicancel_price_triggered_order_listDELETE /futures/{settle}/price_ordersCancel all auto orders
FuturesApiget_price_triggered_orderGET /futures/{settle}/price_orders/{order_id}Query single auto order details
FuturesApicancel_price_triggered_orderDELETE /futures/{settle}/price_orders/{order_id}Cancel single auto order
FuturesApiupdate_price_triggered_orderPUT /futures/{settle}/price_orders/amendModify a Single Auto Order
MarginApilist_margin_accountsGET /margin/accountsMargin account list
MarginApilist_margin_account_bookGET /margin/account_bookQuery margin account balance change history
MarginApilist_funding_accountsGET /margin/funding_accountsFunding account list
MarginApiget_auto_repay_statusGET /margin/auto_repayQuery user auto repayment settings
MarginApiset_auto_repayPOST /margin/auto_repayUpdate user auto repayment settings
MarginApiget_margin_transferableGET /margin/transferableGet maximum transferable amount for isolated margin
MarginApiget_user_margin_tierGET /margin/user/loan_margin_tiersQuery user's own leverage lending tiers in current market
MarginApiget_market_margin_tierGET /margin/loan_margin_tiersQuery current market leverage lending tiers
MarginApiset_user_market_leveragePOST /margin/leverage/user_market_settingSet user market leverage multiplier
MarginApilist_margin_user_accountGET /margin/user/accountQuery user's isolated margin account list
MarginApilist_cross_margin_loansGET /margin/cross/loansQuery cross margin borrow history (deprecated)
MarginApilist_cross_margin_repaymentsGET /margin/cross/repaymentsRetrieve cross margin repayments. (deprecated)
MultiCollateralLoanApilist_multi_collateral_ordersGET /loan/multi_collateral/ordersQuery multi-currency collateral order list
MultiCollateralLoanApicreate_multi_collateralPOST /loan/multi_collateral/ordersPlace multi-currency collateral order
MultiCollateralLoanApiget_multi_collateral_order_detailGET /loan/multi_collateral/orders/{order_id}Query order details
MultiCollateralLoanApilist_multi_repay_recordsGET /loan/multi_collateral/repayQuery multi-currency collateral repayment records
MultiCollateralLoanApirepay_multi_collateral_loanPOST /loan/multi_collateral/repayMulti-currency collateral repayment
MultiCollateralLoanApilist_multi_collateral_recordsGET /loan/multi_collateral/mortgageQuery collateral adjustment records
MultiCollateralLoanApioperate_multi_collateralPOST /loan/multi_collateral/mortgageAdd or withdraw collateral
MultiCollateralLoanApilist_user_currency_quotaGET /loan/multi_collateral/currency_quotaQuery user's collateral and borrowing currency quota information
MultiCollateralLoanApilist_multi_collateral_currenciesGET /loan/multi_collateral/currenciesQuery borrow currencies and collateral currencies supported by multi-currency collateral
MultiCollateralLoanApiget_multi_collateral_ltvGET /loan/multi_collateral/ltvQuery collateralization ratio information
MultiCollateralLoanApiget_multi_collateral_fix_rateGET /loan/multi_collateral/fixed_rateQuery currency's 7-day and 30-day fixed interest rates
MultiCollateralLoanApiget_multi_collateral_current_rateGET /loan/multi_collateral/current_rateQuery currency's current interest rate
OptionsApilist_options_underlyingsGET /options/underlyingsList all underlying assets
OptionsApilist_options_expirationsGET /options/expirationsList all expiration dates
OptionsApilist_options_contractsGET /options/contractsList all contracts for specified underlying and expiration date
OptionsApiget_options_contractGET /options/contracts/{contract}Query specified contract details
OptionsApilist_options_settlementsGET /options/settlementsList settlement history
OptionsApiget_options_settlementGET /options/settlements/{contract}Get specified contract settlement information
OptionsApilist_my_options_settlementsGET /options/my_settlementsQuery personal settlement records
OptionsApilist_options_order_bookGET /options/order_bookQuery options contract order book
OptionsApilist_options_tickersGET /options/tickersQuery options market ticker information
OptionsApilist_options_underlying_tickersGET /options/underlying/tickers/{underlying}Query underlying ticker information
OptionsApilist_options_candlesticksGET /options/candlesticksOptions contract market candlestick chart
OptionsApilist_options_underlying_candlesticksGET /options/underlying/candlesticksUnderlying index price candlestick chart
OptionsApilist_options_tradesGET /options/tradesMarket trade records
OptionsApilist_options_accountGET /options/accountsQuery account information
OptionsApilist_options_account_bookGET /options/account_bookQuery account change history
OptionsApilist_options_positionsGET /options/positionsList user's positions of specified underlying
OptionsApiget_options_positionGET /options/positions/{contract}Get specified contract position
OptionsApilist_options_position_closeGET /options/position_closeList user's liquidation history of specified underlying
OptionsApilist_options_ordersGET /options/ordersList options orders
OptionsApicreate_options_orderPOST /options/ordersCreate an options order
OptionsApicancel_options_ordersDELETE /options/ordersCancel all orders with 'open' status
OptionsApiget_options_orderGET /options/orders/{order_id}Query single order details
OptionsApiamend_options_orderPUT /options/orders/{order_id}Option Order Modification
OptionsApicancel_options_orderDELETE /options/orders/{order_id}Cancel single order
OptionsApicountdown_cancel_all_optionsPOST /options/countdown_cancel_allCountdown cancel orders
OptionsApilist_my_options_tradesGET /options/my_tradesQuery personal trading records
OptionsApiget_options_mmpGET /options/mmpMMP Query.
OptionsApiset_options_mmpPOST /options/mmpMMP Settings
OptionsApireset_options_mmpPOST /options/mmp/resetMMP Reset
P2pApip2p_merchant_account_get_user_infoPOST /p2p/merchant/account/get_user_infoGet account information
P2pApip2p_merchant_account_get_counterparty_user_infoPOST /p2p/merchant/account/get_counterparty_user_infoGet counterparty information
P2pApip2p_merchant_account_get_myself_paymentPOST /p2p/merchant/account/get_myself_paymentGet payment method list
P2pApip2p_merchant_account_set_merchant_work_hoursPOST /p2p/merchant/account/set_merchant_work_hoursSet merchant working status and custom working hours
P2pApip2p_merchant_transaction_get_pending_transaction_listPOST /p2p/merchant/transaction/get_pending_transaction_listGet pending orders
P2pApip2p_merchant_transaction_get_completed_transaction_listPOST /p2p/merchant/transaction/get_completed_transaction_listGet all/historical orders
P2pApip2p_merchant_transaction_get_transaction_detailsPOST /p2p/merchant/transaction/get_transaction_detailsQuery order details
P2pApip2p_merchant_transaction_confirm_paymentPOST /p2p/merchant/transaction/confirm-paymentConfirm payment
P2pApip2p_merchant_transaction_confirm_receiptPOST /p2p/merchant/transaction/confirm-receiptConfirm receipt
P2pApip2p_merchant_transaction_cancelPOST /p2p/merchant/transaction/cancelCancel order
P2pApip2p_merchant_books_place_biz_push_orderPOST /p2p/merchant/books/place_biz_push_orderPublish ad order
P2pApip2p_merchant_books_ads_update_statusPOST /p2p/merchant/books/ads_update_statusUpdate ad status
P2pApip2p_merchant_books_ads_detailPOST /p2p/merchant/books/ads_detailQuery ad details
P2pApip2p_merchant_books_my_ads_listPOST /p2p/merchant/books/my_ads_listGet my ad list
P2pApip2p_merchant_books_ads_listPOST /p2p/merchant/books/ads_listGet Advertisement List
P2pApip2p_merchant_chat_get_chats_listPOST /p2p/merchant/chat/get_chats_listGet chat history
P2pApip2p_merchant_chat_send_chat_messagePOST /p2p/merchant/chat/send_chat_messageSend text message
P2pApip2p_merchant_chat_upload_chat_filePOST /p2p/merchant/chat/upload_chat_fileUpload chat file
RebateApiagency_transaction_historyGET /rebate/agency/transaction_historyBroker obtains transaction history of recommended users
RebateApiagency_commissions_historyGET /rebate/agency/commission_historyBroker obtains rebate history of recommended users
RebateApipartner_transaction_historyGET /rebate/partner/transaction_historyPartner obtains transaction history of recommended users
RebateApipartner_commissions_historyGET /rebate/partner/commission_historyPartner obtains rebate records of recommended users
RebateApipartner_sub_listGET /rebate/partner/sub_listPartner subordinate list
RebateApirebate_broker_commission_historyGET /rebate/broker/commission_historyBroker obtains user's rebate records
RebateApirebate_broker_transaction_historyGET /rebate/broker/transaction_historyBroker obtains user's trading history
RebateApirebate_user_infoGET /rebate/user/infoUser obtains rebate information
RebateApiuser_sub_relationGET /rebate/user/sub_relationUser subordinate relationship
RebateApiget_partner_application_recentGET /rebate/partner/applications/recentGet recent partner application records
RebateApiget_partner_eligibilityGET /rebate/partner/eligibilityCheck partner application eligibility
RebateApiget_partner_agent_data_aggregatedGET /rebate/partner/data/aggregatedAggregated partner agent statistics
SpotApilist_currenciesGET /spot/currenciesQuery all currency information
SpotApiget_currencyGET /spot/currencies/{currency}Query single currency information
SpotApilist_currency_pairsGET /spot/currency_pairsQuery all supported currency pairs
SpotApiget_currency_pairGET /spot/currency_pairs/{currency_pair}Query single currency pair details
SpotApilist_tickersGET /spot/tickersGet currency pair ticker information
SpotApilist_order_bookGET /spot/order_bookGet market depth information
SpotApilist_tradesGET /spot/tradesQuery market transaction records
SpotApilist_candlesticksGET /spot/candlesticksMarket K-line chart
SpotApiget_feeGET /spot/feeQuery account fee rates
SpotApiget_batch_spot_feeGET /spot/batch_feeBatch query account fee rates
SpotApilist_spot_accountsGET /spot/accountsList spot trading accounts
SpotApilist_spot_account_bookGET /spot/account_bookQuery spot account transaction history
SpotApicreate_batch_ordersPOST /spot/batch_ordersBatch place orders
SpotApilist_all_open_ordersGET /spot/open_ordersList all open orders
SpotApicreate_cross_liquidate_orderPOST /spot/cross_liquidate_ordersClose position when cross-currency is disabled
SpotApilist_ordersGET /spot/ordersList orders
SpotApicreate_orderPOST /spot/ordersCreate order
SpotApicancel_ordersDELETE /spot/ordersCancel all `open` orders in specified currency pair
SpotApicancel_batch_ordersPOST /spot/cancel_batch_ordersCancel batch orders by specified ID list
SpotApiget_orderGET /spot/orders/{order_id}Query single order details
SpotApicancel_orderDELETE /spot/orders/{order_id}Cancel single order
SpotApiamend_orderPATCH /spot/orders/{order_id}Amend single order
SpotApilist_my_tradesGET /spot/my_tradesQuery personal trading records
SpotApiget_system_timeGET /spot/timeGet server current time
SpotApicountdown_cancel_all_spotPOST /spot/countdown_cancel_allCountdown cancel orders
SpotApiamend_batch_ordersPOST /spot/amend_batch_ordersBatch modification of orders
SpotApiget_spot_insurance_historyGET /spot/insurance_historyQuery spot insurance fund historical data
SpotApilist_spot_price_triggered_ordersGET /spot/price_ordersQuery running auto order list
SpotApicreate_spot_price_triggered_orderPOST /spot/price_ordersCreate price-triggered order
SpotApicancel_spot_price_triggered_order_listDELETE /spot/price_ordersCancel all auto orders
SpotApiget_spot_price_triggered_orderGET /spot/price_orders/{order_id}Query single auto order details
SpotApicancel_spot_price_triggered_orderDELETE /spot/price_orders/{order_id}Cancel single auto order
SpotApilist_spot_pov_ordersGET /spot/pov_ordersList Spot POV orders
SpotApicreate_spot_pov_orderPOST /spot/pov_ordersCreate a Spot POV order
SpotApicancel_spot_pov_ordersDELETE /spot/pov_ordersCancel Spot POV orders
SpotApiget_spot_pov_orderGET /spot/pov_orders/{order_id}Query Spot POV order details
SpotApicancel_spot_pov_orderDELETE /spot/pov_orders/{order_id}Cancel a Spot POV order
SquareApilist_square_ai_searchGET /social/message/searchAI MCP Dynamic Search
SquareApilist_live_replayGET /social/live/tag_coin_live_replayGate AI Assistant live stream data retrieval
WalletApilist_currency_chainsGET /wallet/currency_chainsQuery chains supported for specified currency
WalletApiget_deposit_addressGET /wallet/deposit_addressGenerate currency deposit address
WalletApilist_withdrawalsGET /wallet/withdrawalsGet withdrawal records
WalletApilist_depositsGET /wallet/depositsGet deposit records
WalletApiget_transferGET /wallet/transfersGet trading account transfer
WalletApitransferPOST /wallet/transfersTransfer between trading accounts
WalletApilist_sub_account_transfersGET /wallet/sub_account_transfersGet transfer records between main and sub accounts
WalletApitransfer_with_sub_accountPOST /wallet/sub_account_transfersTransfer between main and sub accounts
WalletApisub_account_to_sub_accountPOST /wallet/sub_account_to_sub_accountTransfer between sub-accounts
WalletApiget_transfer_order_statusGET /wallet/order_statusMain-Sub Account Transfer Status Query
WalletApilist_withdraw_statusGET /wallet/withdraw_statusQuery withdrawal status
WalletApilist_sub_account_balancesGET /wallet/sub_account_balancesQuery sub-account balance information
WalletApilist_sub_account_margin_balancesGET /wallet/sub_account_margin_balancesQuery sub-account isolated margin account balance information
WalletApilist_sub_account_futures_balancesGET /wallet/sub_account_futures_balancesQuery sub-account perpetual futures account balance information
WalletApilist_sub_account_cross_margin_balancesGET /wallet/sub_account_cross_margin_balancesQuery sub-account cross margin account balance information
WalletApilist_saved_addressGET /wallet/saved_addressQuery saved address
WalletApiget_trade_feeGET /wallet/feeQuery personal trading fees
WalletApiget_total_balanceGET /wallet/total_balanceQuery personal account totals
WalletApilist_small_balanceGET /wallet/small_balanceGet list of convertible small balance currencies
WalletApiconvert_small_balancePOST /wallet/small_balanceConvert small balance currency
WalletApilist_small_balance_historyGET /wallet/small_balance_historyGet convertible small balance currency history
WalletApilist_push_ordersGET /wallet/pushGet UID transfer history
WalletApiget_low_cap_exchange_listGET /wallet/getLowCapExchangeListRetrieve the list of low-liquidity or low-cap tokens
WelfareApiget_user_identityGET /rewards/getUserIdentityGet user identity
WelfareApiget_beginner_task_listGET /rewards/getBeginnerTaskListGet beginner task list
WelfareApiclaim_taskPOST /rewards/claimTaskGet the task
WelfareApiclaim_rewardPOST /rewards/claimRewardReceive mission rewards
WithdrawalApiwithdrawPOST /withdrawalsWithdraw
WithdrawalApiwithdraw_push_orderPOST /withdrawals/pushUID transfer
WithdrawalApicancel_withdrawalDELETE /withdrawals/{withdrawal_id}Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

apiv4

Authentication with APIv4 key and secret

For details, refer to: APIv4 signed request requirements

Author

support@mail.gate.com

About

No description, website, or topics provided.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages