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 C# SDK is automatically generated by the OpenAPI Generator project:
- API version: v4.105.8
- SDK version: 7.105.8
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit https://www.gate.com/page/contacts
- .NET Core >=1.0
- .NET Framework >=4.6
- Mono/Xamarin >=vNext
- RestSharp - 106.10.1 or later
- Json.NET - 12.0.1 or later
- JsonSubTypes - 1.5.2 or later
- System.ComponentModel.Annotations - 4.5.0 or later
The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:
Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742
Install-Package Io.Gate.GateApi
Use the namespaces like this:
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;using System.Collections.Generic;
using System.Diagnostics;
using Io.Gate.GateApi.Api;
using Io.Gate.GateApi.Client;
using Io.Gate.GateApi.Model;
namespace Example
{
public class Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.gateio.ws/api/v4";
config.SetGateApiV4KeyPair("YOUR_API_KEY", "YOUR_API_SECRET");
var apiInstance = new AccountApi(config);
try
{
// Retrieve user account information
AccountDetail result = apiInstance.GetAccountDetail();
Debug.WriteLine(result);
}
catch (GateApiException e)
{
Debug.Print("Exception when calling AccountApi.GetAccountDetail: " + e.Message);
Debug.Print("Exception label: {0}, message: {1}", e.ErrorLabel, e.ErrorMessage);
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}For a more complete API usage example, refer to the demo application in example directory
All URIs are relative to https://api.gateio.ws/api/v4
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountApi | GetAccountDetail | GET /account/detail | Retrieve user account information |
| AccountApi | GetAccountRateLimit | GET /account/rate_limit | Get user transaction rate limit information |
| AccountApi | ListSTPGroups | GET /account/stp_groups | Query STP user groups created by the user |
| AccountApi | CreateSTPGroup | POST /account/stp_groups | Create STP user group |
| AccountApi | ListSTPGroupsUsers | GET /account/stp_groups/{stp_id}/users | Query users in the STP user group |
| AccountApi | AddSTPGroupUsers | POST /account/stp_groups/{stp_id}/users | Add users to the STP user group |
| AccountApi | DeleteSTPGroupUsers | DELETE /account/stp_groups/{stp_id}/users | Delete users from the STP user group |
| AccountApi | GetDebitFee | GET /account/debit_fee | Query GT fee deduction configuration |
| AccountApi | SetDebitFee | POST /account/debit_fee | Configure GT fee deduction |
| CollateralLoanApi | ListCollateralLoanOrders | GET /loan/collateral/orders | Query collateral loan order list |
| CollateralLoanApi | CreateCollateralLoan | POST /loan/collateral/orders | Place collateral loan order |
| CollateralLoanApi | GetCollateralLoanOrderDetail | GET /loan/collateral/orders/{order_id} | Query single order details |
| CollateralLoanApi | RepayCollateralLoan | POST /loan/collateral/repay | Collateral loan repayment |
| CollateralLoanApi | ListRepayRecords | GET /loan/collateral/repay_records | Query collateral loan repayment records |
| CollateralLoanApi | ListCollateralRecords | GET /loan/collateral/collaterals | Query collateral adjustment records |
| CollateralLoanApi | OperateCollateral | POST /loan/collateral/collaterals | Increase or redeem collateral |
| CollateralLoanApi | GetUserTotalAmount | GET /loan/collateral/total_amount | Query user's total borrowing and collateral amount |
| CollateralLoanApi | GetUserLtvInfo | GET /loan/collateral/ltv | Query user's collateralization ratio and remaining borrowable currencies |
| CollateralLoanApi | ListCollateralCurrencies | GET /loan/collateral/currencies | Query supported borrowing and collateral currencies |
| DeliveryApi | ListDeliveryContracts | GET /delivery/{settle}/contracts | Query all futures contracts |
| DeliveryApi | GetDeliveryContract | GET /delivery/{settle}/contracts/{contract} | Query single contract information |
| DeliveryApi | ListDeliveryOrderBook | GET /delivery/{settle}/order_book | Query futures market depth information |
| DeliveryApi | ListDeliveryTrades | GET /delivery/{settle}/trades | Futures market transaction records |
| DeliveryApi | ListDeliveryCandlesticks | GET /delivery/{settle}/candlesticks | Futures market K-line chart |
| DeliveryApi | ListDeliveryTickers | GET /delivery/{settle}/tickers | Get all futures trading statistics |
| DeliveryApi | ListDeliveryInsuranceLedger | GET /delivery/{settle}/insurance | Futures market insurance fund history |
| DeliveryApi | ListDeliveryAccounts | GET /delivery/{settle}/accounts | Get futures account |
| DeliveryApi | ListDeliveryAccountBook | GET /delivery/{settle}/account_book | Query futures account change history |
| DeliveryApi | ListDeliveryPositions | GET /delivery/{settle}/positions | Get user position list |
| DeliveryApi | GetDeliveryPosition | GET /delivery/{settle}/positions/{contract} | Get single position information |
| DeliveryApi | UpdateDeliveryPositionMargin | POST /delivery/{settle}/positions/{contract}/margin | Update position margin |
| DeliveryApi | UpdateDeliveryPositionLeverage | POST /delivery/{settle}/positions/{contract}/leverage | Update position leverage |
| DeliveryApi | UpdateDeliveryPositionRiskLimit | POST /delivery/{settle}/positions/{contract}/risk_limit | Update position risk limit |
| DeliveryApi | ListDeliveryOrders | GET /delivery/{settle}/orders | Query futures order list |
| DeliveryApi | CreateDeliveryOrder | POST /delivery/{settle}/orders | Place futures order |
| DeliveryApi | CancelDeliveryOrders | DELETE /delivery/{settle}/orders | Cancel all orders with 'open' status |
| DeliveryApi | GetDeliveryOrder | GET /delivery/{settle}/orders/{order_id} | Query single order details |
| DeliveryApi | CancelDeliveryOrder | DELETE /delivery/{settle}/orders/{order_id} | Cancel single order |
| DeliveryApi | GetMyDeliveryTrades | GET /delivery/{settle}/my_trades | Query personal trading records |
| DeliveryApi | ListDeliveryPositionClose | GET /delivery/{settle}/position_close | Query position close history |
| DeliveryApi | ListDeliveryLiquidates | GET /delivery/{settle}/liquidates | Query liquidation history |
| DeliveryApi | ListDeliverySettlements | GET /delivery/{settle}/settlements | Query settlement records |
| DeliveryApi | ListDeliveryRiskLimitTiers | GET /delivery/{settle}/risk_limit_tiers | Query risk limit tiers |
| DeliveryApi | ListPriceTriggeredDeliveryOrders | GET /delivery/{settle}/price_orders | Query auto order list |
| DeliveryApi | CreatePriceTriggeredDeliveryOrder | POST /delivery/{settle}/price_orders | Create price-triggered order |
| DeliveryApi | CancelPriceTriggeredDeliveryOrderList | DELETE /delivery/{settle}/price_orders | Cancel all auto orders |
| DeliveryApi | GetPriceTriggeredDeliveryOrder | GET /delivery/{settle}/price_orders/{order_id} | Query single auto order details |
| DeliveryApi | CancelPriceTriggeredDeliveryOrder | DELETE /delivery/{settle}/price_orders/{order_id} | Cancel single auto order |
| EarnApi | SwapETH2 | POST /earn/staking/eth2/swap | ETH2 swap |
| EarnApi | RateListETH2 | GET /earn/staking/eth2/rate_records | ETH2 historical return rate query |
| EarnApi | ListDualInvestmentPlans | GET /earn/dual/investment_plan | Dual Investment product list |
| EarnApi | ListDualOrders | GET /earn/dual/orders | Dual Investment order list |
| EarnApi | PlaceDualOrder | POST /earn/dual/orders | Place Dual Investment order |
| EarnApi | ListStructuredProducts | GET /earn/structured/products | Structured Product List |
| EarnApi | ListStructuredOrders | GET /earn/structured/orders | Structured Product Order List |
| EarnApi | PlaceStructuredOrder | POST /earn/structured/orders | Place Structured Product Order |
| EarnApi | FindCoin | GET /earn/staking/coins | Staking coins |
| EarnApi | SwapStakingCoin | POST /earn/staking/swap | On-chain token swap for earned coins |
| EarnUniApi | ListUniCurrencies | GET /earn/uni/currencies | Query lending currency list |
| EarnUniApi | GetUniCurrency | GET /earn/uni/currencies/{currency} | Query single lending currency details |
| EarnUniApi | ListUserUniLends | GET /earn/uni/lends | Query user's lending order list |
| EarnUniApi | CreateUniLend | POST /earn/uni/lends | Create lending or redemption |
| EarnUniApi | ChangeUniLend | PATCH /earn/uni/lends | Amend user lending information |
| EarnUniApi | ListUniLendRecords | GET /earn/uni/lend_records | Query lending transaction records |
| EarnUniApi | GetUniInterest | GET /earn/uni/interests/{currency} | Query user's total interest income for specified currency |
| EarnUniApi | ListUniInterestRecords | GET /earn/uni/interest_records | Query user dividend records |
| EarnUniApi | GetUniInterestStatus | GET /earn/uni/interest_status/{currency} | Query currency interest compounding status |
| EarnUniApi | ListUniChart | GET /earn/uni/chart | UniLoan currency annualized trend chart |
| EarnUniApi | ListUniRate | GET /earn/uni/rate | Currency estimated annualized interest rate |
| FlashSwapApi | ListFlashSwapCurrencyPair | GET /flash_swap/currency_pairs | List All Supported Currency Pairs In Flash Swap |
| FlashSwapApi | ListFlashSwapOrders | GET /flash_swap/orders | Query flash swap order list |
| FlashSwapApi | CreateFlashSwapOrder | POST /flash_swap/orders | Create a flash swap order |
| FlashSwapApi | GetFlashSwapOrder | GET /flash_swap/orders/{order_id} | Query single flash swap order |
| FlashSwapApi | PreviewFlashSwapOrder | POST /flash_swap/orders/preview | Flash swap order preview |
| FuturesApi | ListFuturesContracts | GET /futures/{settle}/contracts | Query all futures contracts |
| FuturesApi | GetFuturesContract | GET /futures/{settle}/contracts/{contract} | Query single contract information |
| FuturesApi | ListFuturesOrderBook | GET /futures/{settle}/order_book | Query futures market depth information |
| FuturesApi | ListFuturesTrades | GET /futures/{settle}/trades | Futures market transaction records |
| FuturesApi | ListFuturesCandlesticks | GET /futures/{settle}/candlesticks | Futures market K-line chart |
| FuturesApi | ListFuturesPremiumIndex | GET /futures/{settle}/premium_index | Premium Index K-line chart |
| FuturesApi | ListFuturesTickers | GET /futures/{settle}/tickers | Get all futures trading statistics |
| FuturesApi | ListFuturesFundingRateHistory | GET /futures/{settle}/funding_rate | Futures market historical funding rate |
| FuturesApi | ListFuturesInsuranceLedger | GET /futures/{settle}/insurance | Futures market insurance fund history |
| FuturesApi | ListContractStats | GET /futures/{settle}/contract_stats | Futures statistics |
| FuturesApi | GetIndexConstituents | GET /futures/{settle}/index_constituents/{index} | Query index constituents |
| FuturesApi | ListLiquidatedOrders | GET /futures/{settle}/liq_orders | Query liquidation order history |
| FuturesApi | ListFuturesRiskLimitTiers | GET /futures/{settle}/risk_limit_tiers | Query risk limit tiers |
| FuturesApi | ListFuturesAccounts | GET /futures/{settle}/accounts | Get futures account |
| FuturesApi | ListFuturesAccountBook | GET /futures/{settle}/account_book | Query futures account change history |
| FuturesApi | ListPositions | GET /futures/{settle}/positions | Get user position list |
| FuturesApi | GetPosition | GET /futures/{settle}/positions/{contract} | Get single position information |
| FuturesApi | UpdatePositionMargin | POST /futures/{settle}/positions/{contract}/margin | Update position margin |
| FuturesApi | UpdatePositionLeverage | POST /futures/{settle}/positions/{contract}/leverage | Update position leverage |
| FuturesApi | UpdatePositionCrossMode | POST /futures/{settle}/positions/cross_mode | Switch Position Margin Mode |
| FuturesApi | UpdateDualCompPositionCrossMode | POST /futures/{settle}/dual_comp/positions/cross_mode | Switch Between Cross and Isolated Margin Modes Under Hedge Mode |
| FuturesApi | UpdatePositionRiskLimit | POST /futures/{settle}/positions/{contract}/risk_limit | Update position risk limit |
| FuturesApi | SetDualMode | POST /futures/{settle}/dual_mode | Set position mode |
| FuturesApi | GetDualModePosition | GET /futures/{settle}/dual_comp/positions/{contract} | Get position information in dual mode |
| FuturesApi | UpdateDualModePositionMargin | POST /futures/{settle}/dual_comp/positions/{contract}/margin | Update position margin in dual mode |
| FuturesApi | UpdateDualModePositionLeverage | POST /futures/{settle}/dual_comp/positions/{contract}/leverage | Update position leverage in dual mode |
| FuturesApi | UpdateDualModePositionRiskLimit | POST /futures/{settle}/dual_comp/positions/{contract}/risk_limit | Update position risk limit in dual mode |
| FuturesApi | ListFuturesOrders | GET /futures/{settle}/orders | Query futures order list |
| FuturesApi | CreateFuturesOrder | POST /futures/{settle}/orders | Place futures order |
| FuturesApi | CancelFuturesOrders | DELETE /futures/{settle}/orders | Cancel all orders with 'open' status |
| FuturesApi | GetOrdersWithTimeRange | GET /futures/{settle}/orders_timerange | Query futures order list by time range |
| FuturesApi | CreateBatchFuturesOrder | POST /futures/{settle}/batch_orders | Place batch futures orders |
| FuturesApi | GetFuturesOrder | GET /futures/{settle}/orders/{order_id} | Query single order details |
| FuturesApi | AmendFuturesOrder | PUT /futures/{settle}/orders/{order_id} | Amend single order |
| FuturesApi | CancelFuturesOrder | DELETE /futures/{settle}/orders/{order_id} | Cancel single order |
| FuturesApi | GetMyTrades | GET /futures/{settle}/my_trades | Query personal trading records |
| FuturesApi | GetMyTradesWithTimeRange | GET /futures/{settle}/my_trades_timerange | Query personal trading records by time range |
| FuturesApi | ListPositionClose | GET /futures/{settle}/position_close | Query position close history |
| FuturesApi | ListLiquidates | GET /futures/{settle}/liquidates | Query liquidation history |
| FuturesApi | ListAutoDeleverages | GET /futures/{settle}/auto_deleverages | Query ADL auto-deleveraging order information |
| FuturesApi | CountdownCancelAllFutures | POST /futures/{settle}/countdown_cancel_all | Countdown cancel orders |
| FuturesApi | GetFuturesFee | GET /futures/{settle}/fee | Query futures market trading fee rates |
| FuturesApi | CancelBatchFutureOrders | POST /futures/{settle}/batch_cancel_orders | Cancel batch orders by specified ID list |
| FuturesApi | AmendBatchFutureOrders | POST /futures/{settle}/batch_amend_orders | Batch modify orders by specified IDs |
| FuturesApi | GetFuturesRiskLimitTable | GET /futures/{settle}/risk_limit_table | Query risk limit table by table_id |
| FuturesApi | ListPriceTriggeredOrders | GET /futures/{settle}/price_orders | Query auto order list |
| FuturesApi | CreatePriceTriggeredOrder | POST /futures/{settle}/price_orders | Create price-triggered order |
| FuturesApi | CancelPriceTriggeredOrderList | DELETE /futures/{settle}/price_orders | Cancel all auto orders |
| FuturesApi | GetPriceTriggeredOrder | GET /futures/{settle}/price_orders/{order_id} | Query single auto order details |
| FuturesApi | CancelPriceTriggeredOrder | DELETE /futures/{settle}/price_orders/{order_id} | Cancel single auto order |
| MarginApi | ListMarginAccounts | GET /margin/accounts | Margin account list |
| MarginApi | ListMarginAccountBook | GET /margin/account_book | Query margin account balance change history |
| MarginApi | ListFundingAccounts | GET /margin/funding_accounts | Funding account list |
| MarginApi | GetAutoRepayStatus | GET /margin/auto_repay | Query user auto repayment settings |
| MarginApi | SetAutoRepay | POST /margin/auto_repay | Update user auto repayment settings |
| MarginApi | GetMarginTransferable | GET /margin/transferable | Get maximum transferable amount for isolated margin |
| MarginApi | GetUserMarginTier | GET /margin/user/loan_margin_tiers | Query user's own leverage lending tiers in current market |
| MarginApi | GetMarketMarginTier | GET /margin/loan_margin_tiers | Query current market leverage lending tiers |
| MarginApi | SetUserMarketLeverage | POST /margin/leverage/user_market_setting | Set user market leverage multiplier |
| MarginApi | ListMarginUserAccount | GET /margin/user/account | Query user's isolated margin account list |
| MarginApi | ListCrossMarginLoans | GET /margin/cross/loans | Query cross margin borrow history (deprecated) |
| MarginApi | ListCrossMarginRepayments | GET /margin/cross/repayments | Retrieve cross margin repayments. (deprecated) |
| MarginUniApi | ListUniCurrencyPairs | GET /margin/uni/currency_pairs | List lending markets |
| MarginUniApi | GetUniCurrencyPair | GET /margin/uni/currency_pairs/{currency_pair} | Get lending market details |
| MarginUniApi | GetMarginUniEstimateRate | GET /margin/uni/estimate_rate | Estimate interest rate for isolated margin currencies |
| MarginUniApi | ListUniLoans | GET /margin/uni/loans | Query loans |
| MarginUniApi | CreateUniLoan | POST /margin/uni/loans | Borrow or repay |
| MarginUniApi | ListUniLoanRecords | GET /margin/uni/loan_records | Query loan records |
| MarginUniApi | ListUniLoanInterestRecords | GET /margin/uni/interest_records | Query interest deduction records |
| MarginUniApi | GetUniBorrowable | GET /margin/uni/borrowable | Query maximum borrowable amount by currency |
| MultiCollateralLoanApi | ListMultiCollateralOrders | GET /loan/multi_collateral/orders | Query multi-currency collateral order list |
| MultiCollateralLoanApi | CreateMultiCollateral | POST /loan/multi_collateral/orders | Place multi-currency collateral order |
| MultiCollateralLoanApi | GetMultiCollateralOrderDetail | GET /loan/multi_collateral/orders/{order_id} | Query order details |
| MultiCollateralLoanApi | ListMultiRepayRecords | GET /loan/multi_collateral/repay | Query multi-currency collateral repayment records |
| MultiCollateralLoanApi | RepayMultiCollateralLoan | POST /loan/multi_collateral/repay | Multi-currency collateral repayment |
| MultiCollateralLoanApi | ListMultiCollateralRecords | GET /loan/multi_collateral/mortgage | Query collateral adjustment records |
| MultiCollateralLoanApi | OperateMultiCollateral | POST /loan/multi_collateral/mortgage | Add or withdraw collateral |
| MultiCollateralLoanApi | ListUserCurrencyQuota | GET /loan/multi_collateral/currency_quota | Query user's collateral and borrowing currency quota information |
| MultiCollateralLoanApi | ListMultiCollateralCurrencies | GET /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies for multi-currency collateral |
| MultiCollateralLoanApi | GetMultiCollateralLtv | GET /loan/multi_collateral/ltv | Query collateralization ratio information |
| MultiCollateralLoanApi | GetMultiCollateralFixRate | GET /loan/multi_collateral/fixed_rate | Query currency's 7-day and 30-day fixed interest rates |
| MultiCollateralLoanApi | GetMultiCollateralCurrentRate | GET /loan/multi_collateral/current_rate | Query currency's current interest rate |
| OptionsApi | ListOptionsUnderlyings | GET /options/underlyings | List all underlying assets |
| OptionsApi | ListOptionsExpirations | GET /options/expirations | List all expiration dates |
| OptionsApi | ListOptionsContracts | GET /options/contracts | List all contracts for specified underlying and expiration date |
| OptionsApi | GetOptionsContract | GET /options/contracts/{contract} | Query specified contract details |
| OptionsApi | ListOptionsSettlements | GET /options/settlements | List settlement history |
| OptionsApi | GetOptionsSettlement | GET /options/settlements/{contract} | Get specified contract settlement information |
| OptionsApi | ListMyOptionsSettlements | GET /options/my_settlements | Query personal settlement records |
| OptionsApi | ListOptionsOrderBook | GET /options/order_book | Query options contract order book |
| OptionsApi | ListOptionsTickers | GET /options/tickers | Query options market ticker information |
| OptionsApi | ListOptionsUnderlyingTickers | GET /options/underlying/tickers/{underlying} | Query underlying ticker information |
| OptionsApi | ListOptionsCandlesticks | GET /options/candlesticks | Options contract market candlestick chart |
| OptionsApi | ListOptionsUnderlyingCandlesticks | GET /options/underlying/candlesticks | Underlying index price candlestick chart |
| OptionsApi | ListOptionsTrades | GET /options/trades | Market trade records |
| OptionsApi | ListOptionsAccount | GET /options/accounts | Query account information |
| OptionsApi | ListOptionsAccountBook | GET /options/account_book | Query account change history |
| OptionsApi | ListOptionsPositions | GET /options/positions | List user's positions of specified underlying |
| OptionsApi | GetOptionsPosition | GET /options/positions/{contract} | Get specified contract position |
| OptionsApi | ListOptionsPositionClose | GET /options/position_close | List user's liquidation history of specified underlying |
| OptionsApi | ListOptionsOrders | GET /options/orders | List options orders |
| OptionsApi | CreateOptionsOrder | POST /options/orders | Create an options order |
| OptionsApi | CancelOptionsOrders | DELETE /options/orders | Cancel all orders with 'open' status |
| OptionsApi | GetOptionsOrder | GET /options/orders/{order_id} | Query single order details |
| OptionsApi | CancelOptionsOrder | DELETE /options/orders/{order_id} | Cancel single order |
| OptionsApi | CountdownCancelAllOptions | POST /options/countdown_cancel_all | Countdown cancel orders |
| OptionsApi | ListMyOptionsTrades | GET /options/my_trades | Query personal trading records |
| OptionsApi | GetOptionsMMP | GET /options/mmp | MMP Query. |
| OptionsApi | SetOptionsMMP | POST /options/mmp | MMP Settings |
| OptionsApi | ResetOptionsMMP | POST /options/mmp/reset | MMP Reset |
| RebateApi | AgencyTransactionHistory | GET /rebate/agency/transaction_history | Broker obtains transaction history of recommended users |
| RebateApi | AgencyCommissionsHistory | GET /rebate/agency/commission_history | Broker obtains rebate history of recommended users |
| RebateApi | PartnerTransactionHistory | GET /rebate/partner/transaction_history | Partner obtains transaction history of recommended users |
| RebateApi | PartnerCommissionsHistory | GET /rebate/partner/commission_history | Partner obtains rebate records of recommended users |
| RebateApi | PartnerSubList | GET /rebate/partner/sub_list | Partner subordinate list |
| RebateApi | RebateBrokerCommissionHistory | GET /rebate/broker/commission_history | Broker obtains user's rebate records |
| RebateApi | RebateBrokerTransactionHistory | GET /rebate/broker/transaction_history | Broker obtains user's trading history |
| RebateApi | RebateUserInfo | GET /rebate/user/info | User obtains rebate information |
| RebateApi | UserSubRelation | GET /rebate/user/sub_relation | User subordinate relationship |
| SpotApi | ListCurrencies | GET /spot/currencies | Query all currency information |
| SpotApi | GetCurrency | GET /spot/currencies/{currency} | Query single currency information |
| SpotApi | ListCurrencyPairs | GET /spot/currency_pairs | Query all supported currency pairs |
| SpotApi | GetCurrencyPair | GET /spot/currency_pairs/{currency_pair} | Query single currency pair details |
| SpotApi | ListTickers | GET /spot/tickers | Get currency pair ticker information |
| SpotApi | ListOrderBook | GET /spot/order_book | Get market depth information |
| SpotApi | ListTrades | GET /spot/trades | Query market transaction records |
| SpotApi | ListCandlesticks | GET /spot/candlesticks | Market K-line chart |
| SpotApi | GetFee | GET /spot/fee | Query account fee rates |
| SpotApi | GetBatchSpotFee | GET /spot/batch_fee | Batch query account fee rates |
| SpotApi | ListSpotAccounts | GET /spot/accounts | List spot trading accounts |
| SpotApi | ListSpotAccountBook | GET /spot/account_book | Query spot account transaction history |
| SpotApi | CreateBatchOrders | POST /spot/batch_orders | Batch place orders |
| SpotApi | ListAllOpenOrders | GET /spot/open_orders | List all open orders |
| SpotApi | CreateCrossLiquidateOrder | POST /spot/cross_liquidate_orders | Close position when cross-currency is disabled |
| SpotApi | ListOrders | GET /spot/orders | List orders |
| SpotApi | CreateOrder | POST /spot/orders | Create an order |
| SpotApi | CancelOrders | DELETE /spot/orders | Cancel all open orders in specified currency pair |
| SpotApi | CancelBatchOrders | POST /spot/cancel_batch_orders | Cancel batch orders by specified ID list |
| SpotApi | GetOrder | GET /spot/orders/{order_id} | Query single order details |
| SpotApi | CancelOrder | DELETE /spot/orders/{order_id} | Cancel single order |
| SpotApi | AmendOrder | PATCH /spot/orders/{order_id} | Amend single order |
| SpotApi | ListMyTrades | GET /spot/my_trades | Query personal trading records |
| SpotApi | GetSystemTime | GET /spot/time | Get server current time |
| SpotApi | CountdownCancelAllSpot | POST /spot/countdown_cancel_all | Countdown cancel orders |
| SpotApi | AmendBatchOrders | POST /spot/amend_batch_orders | Batch modification of orders |
| SpotApi | GetSpotInsuranceHistory | GET /spot/insurance_history | Query spot insurance fund historical data |
| SpotApi | ListSpotPriceTriggeredOrders | GET /spot/price_orders | Query running auto order list |
| SpotApi | CreateSpotPriceTriggeredOrder | POST /spot/price_orders | Create price-triggered order |
| SpotApi | CancelSpotPriceTriggeredOrderList | DELETE /spot/price_orders | Cancel all auto orders |
| SpotApi | GetSpotPriceTriggeredOrder | GET /spot/price_orders/{order_id} | Query single auto order details |
| SpotApi | CancelSpotPriceTriggeredOrder | DELETE /spot/price_orders/{order_id} | Cancel single auto order |
| SubAccountApi | ListSubAccounts | GET /sub_accounts | List sub-accounts |
| SubAccountApi | CreateSubAccounts | POST /sub_accounts | Create a new sub-account |
| SubAccountApi | GetSubAccount | GET /sub_accounts/{user_id} | Get sub-account |
| SubAccountApi | ListSubAccountKeys | GET /sub_accounts/{user_id}/keys | List all API key pairs of the sub-account |
| SubAccountApi | CreateSubAccountKeys | POST /sub_accounts/{user_id}/keys | Create new sub-account API key pair |
| SubAccountApi | GetSubAccountKey | GET /sub_accounts/{user_id}/keys/{key} | Get specific API key pair of the sub-account |
| SubAccountApi | UpdateSubAccountKeys | PUT /sub_accounts/{user_id}/keys/{key} | Update sub-account API key pair |
| SubAccountApi | DeleteSubAccountKeys | DELETE /sub_accounts/{user_id}/keys/{key} | Delete sub-account API key pair |
| SubAccountApi | LockSubAccount | POST /sub_accounts/{user_id}/lock | Lock sub-account |
| SubAccountApi | UnlockSubAccount | POST /sub_accounts/{user_id}/unlock | Unlock sub-account |
| SubAccountApi | ListUnifiedMode | GET /sub_accounts/unified_mode | Get sub-account mode |
| UnifiedApi | ListUnifiedAccounts | GET /unified/accounts | Get unified account information |
| UnifiedApi | GetUnifiedBorrowable | GET /unified/borrowable | Query maximum borrowable amount for unified account |
| UnifiedApi | GetUnifiedTransferable | GET /unified/transferable | Query maximum transferable amount for unified account |
| UnifiedApi | GetUnifiedTransferables | GET /unified/transferables | Batch query maximum transferable amount for unified accounts. Each currency shows the maximum value. After user withdrawal, the transferable amount for all currencies will change |
| UnifiedApi | GetUnifiedBorrowableList | GET /unified/batch_borrowable | Batch query unified account maximum borrowable amount |
| UnifiedApi | ListUnifiedLoans | GET /unified/loans | Query loans |
| UnifiedApi | CreateUnifiedLoan | POST /unified/loans | Borrow or repay |
| UnifiedApi | ListUnifiedLoanRecords | GET /unified/loan_records | Query loan records |
| UnifiedApi | ListUnifiedLoanInterestRecords | GET /unified/interest_records | Query interest deduction records |
| UnifiedApi | GetUnifiedRiskUnits | GET /unified/risk_units | Get user risk unit details |
| UnifiedApi | GetUnifiedMode | GET /unified/unified_mode | Query mode of the unified account |
| UnifiedApi | SetUnifiedMode | PUT /unified/unified_mode | Set unified account mode |
| UnifiedApi | GetUnifiedEstimateRate | GET /unified/estimate_rate | Query unified account estimated interest rate |
| UnifiedApi | ListCurrencyDiscountTiers | GET /unified/currency_discount_tiers | Query unified account tiered |
| UnifiedApi | ListLoanMarginTiers | GET /unified/loan_margin_tiers | Query unified account tiered loan margin |
| UnifiedApi | CalculatePortfolioMargin | POST /unified/portfolio_calculator | Portfolio margin calculator |
| UnifiedApi | GetUserLeverageCurrencyConfig | GET /unified/leverage/user_currency_config | Maximum and minimum currency leverage that can be set |
| UnifiedApi | GetUserLeverageCurrencySetting | GET /unified/leverage/user_currency_setting | Get user currency leverage |
| UnifiedApi | SetUserLeverageCurrencySetting | POST /unified/leverage/user_currency_setting | Set loan currency leverage |
| UnifiedApi | ListUnifiedCurrencies | GET /unified/currencies | List of loan currencies supported by unified account |
| UnifiedApi | GetHistoryLoanRate | GET /unified/history_loan_rate | Get historical lending rates |
| UnifiedApi | SetUnifiedCollateral | POST /unified/collateral_currencies | Set collateral currency |
| WalletApi | ListCurrencyChains | GET /wallet/currency_chains | Query chains supported for specified currency |
| WalletApi | GetDepositAddress | GET /wallet/deposit_address | Generate currency deposit address |
| WalletApi | ListWithdrawals | GET /wallet/withdrawals | Get withdrawal records |
| WalletApi | ListDeposits | GET /wallet/deposits | Get deposit records |
| WalletApi | Transfer | POST /wallet/transfers | Transfer between trading accounts |
| WalletApi | ListSubAccountTransfers | GET /wallet/sub_account_transfers | Get transfer records between main and sub accounts |
| WalletApi | TransferWithSubAccount | POST /wallet/sub_account_transfers | Transfer between main and sub accounts |
| WalletApi | SubAccountToSubAccount | POST /wallet/sub_account_to_sub_account | Transfer between sub-accounts |
| WalletApi | GetTransferOrderStatus | GET /wallet/order_status | Transfer status query |
| WalletApi | ListWithdrawStatus | GET /wallet/withdraw_status | Query withdrawal status |
| WalletApi | ListSubAccountBalances | GET /wallet/sub_account_balances | Query sub-account balance information |
| WalletApi | ListSubAccountMarginBalances | GET /wallet/sub_account_margin_balances | Query sub-account isolated margin account balance information |
| WalletApi | ListSubAccountFuturesBalances | GET /wallet/sub_account_futures_balances | Query sub-account perpetual futures account balance information |
| WalletApi | ListSubAccountCrossMarginBalances | GET /wallet/sub_account_cross_margin_balances | Query sub-account cross margin account balance information |
| WalletApi | ListSavedAddress | GET /wallet/saved_address | Query withdrawal address whitelist |
| WalletApi | GetTradeFee | GET /wallet/fee | Query personal trading fees |
| WalletApi | GetTotalBalance | GET /wallet/total_balance | Query personal account totals |
| WalletApi | ListSmallBalance | GET /wallet/small_balance | Get list of convertible small balance currencies |
| WalletApi | ConvertSmallBalance | POST /wallet/small_balance | Convert small balance currency |
| WalletApi | ListSmallBalanceHistory | GET /wallet/small_balance_history | Get convertible small balance currency history |
| WalletApi | ListPushOrders | GET /wallet/push | Get UID transfer history |
| WithdrawalApi | Withdraw | POST /withdrawals | Withdraw |
| WithdrawalApi | WithdrawPushOrder | POST /withdrawals/push | UID transfer |
| WithdrawalApi | CancelWithdrawal | DELETE /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID |
- Model.AccountBalance
- Model.AccountDetail
- Model.AccountDetailKey
- Model.AccountRateLimit
- Model.AgencyCommission
- Model.AgencyCommissionHistory
- Model.AgencyTransaction
- Model.AgencyTransactionHistory
- Model.AutoRepaySetting
- Model.BatchAmendItem
- Model.BatchAmendOrderReq
- Model.BatchFuturesOrder
- Model.BatchOrder
- Model.BorrowCurrencyInfo
- Model.BrokerCommission
- Model.BrokerCommission1
- Model.BrokerCommissionSubBrokerInfo
- Model.BrokerTransaction
- Model.BrokerTransaction1
- Model.CancelBatchOrder
- Model.CancelOrderResult
- Model.CollateralAdjust
- Model.CollateralAdjustRes
- Model.CollateralAlign
- Model.CollateralCurrency
- Model.CollateralCurrencyInfo
- Model.CollateralCurrencyRes
- Model.CollateralCurrentRate
- Model.CollateralFixRate
- Model.CollateralLoanCurrency
- Model.CollateralLtv
- Model.CollateralOrder
- Model.CollateralRecord
- Model.Contract
- Model.ContractStat
- Model.ConvertSmallBalance
- Model.CountdownCancelAllFuturesTask
- Model.CountdownCancelAllOptionsTask
- Model.CountdownCancelAllSpotTask
- Model.CreateCollateralOrder
- Model.CreateMultiCollateralOrder
- Model.CreateUniLend
- Model.CreateUniLoan
- Model.CrossMarginBalance
- Model.CrossMarginLoan
- Model.CrossMarginRepayment
- Model.Currency
- Model.CurrencyChain
- Model.CurrencyPair
- Model.CurrencyQuota
- Model.DebitFee
- Model.DeliveryCandlestick
- Model.DeliveryContract
- Model.DeliverySettlement
- Model.DeliveryTicker
- Model.DepositAddress
- Model.DepositRecord
- Model.DualGetOrders
- Model.DualGetPlans
- Model.Eth2RateList
- Model.Eth2Swap
- Model.FindCoin
- Model.FlashSwapCurrencyPair
- Model.FlashSwapOrder
- Model.FlashSwapOrderPreview
- Model.FlashSwapOrderRequest
- Model.FlashSwapPreviewRequest
- Model.FundingAccount
- Model.FundingRateRecord
- Model.FutureCancelOrderResult
- Model.FuturesAccount
- Model.FuturesAccountBook
- Model.FuturesAccountHistory
- Model.FuturesAutoDeleverage
- Model.FuturesBatchAmendOrderRequest
- Model.FuturesCandlestick
- Model.FuturesFee
- Model.FuturesIndexConstituents
- Model.FuturesInitialOrder
- Model.FuturesLimitRiskTiers
- Model.FuturesLiqOrder
- Model.FuturesLiquidate
- Model.FuturesOrder
- Model.FuturesOrderAmendment
- Model.FuturesOrderBook
- Model.FuturesOrderBookItem
- Model.FuturesPositionCrossMode
- Model.FuturesPremiumIndex
- Model.FuturesPriceTrigger
- Model.FuturesPriceTriggeredOrder
- Model.FuturesRiskLimitTier
- Model.FuturesTicker
- Model.FuturesTrade
- Model.IndexConstituent
- Model.InlineObject
- Model.InlineResponse200
- Model.InlineResponse2001
- Model.InsuranceRecord
- Model.LedgerRecord
- Model.LiquidateOrder
- Model.MarginAccount
- Model.MarginAccountBook
- Model.MarginAccountCurrency
- Model.MarginLeverageTier
- Model.MarginMarketLeverage
- Model.MarginTiers
- Model.MarginTransferable
- Model.MaxUniBorrowable
- Model.MockFuturesOrder
- Model.MockFuturesPosition
- Model.MockMarginResult
- Model.MockOptionsOrder
- Model.MockOptionsPosition
- Model.MockRiskUnit
- Model.MockSpotBalance
- Model.MockSpotOrder
- Model.MultiChainAddressItem
- Model.MultiCollateralCurrency
- Model.MultiCollateralItem
- Model.MultiCollateralOrder
- Model.MultiCollateralRecord
- Model.MultiCollateralRecordCurrency
- Model.MultiLoanItem
- Model.MultiLoanRepayItem
- Model.MultiRepayRecord
- Model.MultiRepayResp
- Model.MyFuturesTrade
- Model.MyFuturesTradeTimeRange
- Model.OpenOrders
- Model.OptionsAccount
- Model.OptionsAccountBook
- Model.OptionsCandlestick
- Model.OptionsContract
- Model.OptionsMMP
- Model.OptionsMMPReset
- Model.OptionsMySettlements
- Model.OptionsMyTrade
- Model.OptionsOrder
- Model.OptionsPosition
- Model.OptionsPositionClose
- Model.OptionsPositionCloseOrder
- Model.OptionsSettlement
- Model.OptionsTicker
- Model.OptionsUnderlying
- Model.OptionsUnderlyingTicker
- Model.Order
- Model.OrderBook
- Model.OrderCancel
- Model.OrderPatch
- Model.OrderResp
- Model.PartnerCommissionHistory
- Model.PartnerSub
- Model.PartnerSubList
- Model.PartnerTransactionHistory
- Model.PatchUniLend
- Model.PlaceDualInvestmentOrder
- Model.Position
- Model.PositionClose
- Model.PositionCloseOrder
- Model.ProfitLossRange
- Model.RebateUserInfo
- Model.RepayCurrencyRes
- Model.RepayLoan
- Model.RepayMultiLoan
- Model.RepayRecord
- Model.RepayRecordCurrency
- Model.RepayRecordLeftInterest
- Model.RepayRecordRepaidCurrency
- Model.RepayRecordTotalInterest
- Model.RepayResp
- Model.RiskUnits
- Model.SavedAddress
- Model.SmallBalance
- Model.SmallBalanceHistory
- Model.SpotAccount
- Model.SpotAccountBook
- Model.SpotCurrencyChain
- Model.SpotFee
- Model.SpotInsuranceHistory
- Model.SpotPricePutOrder
- Model.SpotPriceTrigger
- Model.SpotPriceTriggeredOrder
- Model.StpGroup
- Model.StpGroupUser
- Model.StructuredBuy
- Model.StructuredGetProjectList
- Model.StructuredOrderList
- Model.SubAccount
- Model.SubAccountBalance
- Model.SubAccountCrossMarginBalance
- Model.SubAccountFuturesBalance
- Model.SubAccountKey
- Model.SubAccountKeyPerms
- Model.SubAccountMarginBalance
- Model.SubAccountToSubAccount
- Model.SubAccountTransfer
- Model.SubAccountTransferRecordItem
- Model.SubCrossMarginAccount
- Model.SubUserMode
- Model.SwapCoin
- Model.SwapCoinStruct
- Model.SystemTime
- Model.Ticker
- Model.TotalBalance
- Model.Trade
- Model.TradeFee
- Model.TransactionID
- Model.Transfer
- Model.TransferOrderStatus
- Model.TransferablesResult
- Model.TriggerOrderResponse
- Model.TriggerTime
- Model.UidPushOrder
- Model.UidPushWithdrawal
- Model.UidPushWithdrawalResp
- Model.UniCurrency
- Model.UniCurrencyInterest
- Model.UniCurrencyPair
- Model.UniInterestRecord
- Model.UniLend
- Model.UniLendInterest
- Model.UniLendRecord
- Model.UniLoan
- Model.UniLoanInterestRecord
- Model.UniLoanRecord
- Model.UnifiedAccount
- Model.UnifiedBalance
- Model.UnifiedBorrowable
- Model.UnifiedBorrowable1
- Model.UnifiedCollateralReq
- Model.UnifiedCollateralRes
- Model.UnifiedCurrency
- Model.UnifiedDiscount
- Model.UnifiedDiscountTiers
- Model.UnifiedHistoryLoanRate
- Model.UnifiedHistoryLoanRateRates
- Model.UnifiedLeverageConfig
- Model.UnifiedLeverageSetting
- Model.UnifiedLoan
- Model.UnifiedLoanRecord
- Model.UnifiedLoanResult
- Model.UnifiedMarginTiers
- Model.UnifiedModeSet
- Model.UnifiedPortfolioInput
- Model.UnifiedPortfolioOutput
- Model.UnifiedRiskUnits
- Model.UnifiedSettings
- Model.UnifiedTransferable
- Model.UserLtvInfo
- Model.UserSub
- Model.UserSubRelation
- Model.UserTotalAmount
- Model.WithdrawStatus
- Model.WithdrawalRecord
- Type: Gate APIv4 authentication
For details, refer to: APIv4 signed request requirements