add settle input in futures API

gateio · Nov 7, 2019 · 6f1d06d · 6f1d06d
1 parent 5df412b
commit 6f1d06d
Show file tree

Hide file tree

Showing 52 changed files with 770 additions and 272 deletions.
diff --git a/README.md b/README.md
@@ -2,11 +2,25 @@
 
 APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf.
 
+## Specific note for 4.8.0
+
+**BREAKING** change:
+
+4.8.0 add new support with different settle currency for futures API(BTC is the only one allowed before), which makes ALL methods in FuturesApi REQUIRE an additional `settle` parameter.
+
+But previous `/futures/xxx` APIs are still preserved for compatibility usage(will be treated as BTC), so if one of the following condition is met:
+
+- Changing all your futures method call to include `settle` is not a big issue for you
+- You need to use futures settled in non-BTC currency
+
+then you'd better move to 4.8.0 and changes all your futures method call to pass in `settle` parameter. Otherwise, you can stick to version<=4.7.3,
+but will not receive any future API upgrade support
+
 ## Overview
 This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
 
-- API version: 4.7.3
-- Package version: 4.7.3
+- API version: 4.8.0
+- Package version: 4.8.0
 - Build package: org.openapitools.codegen.languages.GoClientCodegen
 For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
 
@@ -43,8 +57,10 @@ func main() {
     client.SetKeySecret("YOUR API KEY", "YOUR API SECRET")
     api := client.FuturesApi
 
+    settle := "btc"; // string - Settle currency
+
     orderId := "12345"; // string - ID returned on order successfully being created
-    result, _, err := api.CancelFuturesOrder(nil, orderId)
+    result, _, err := api.CancelFuturesOrder(nil, settle, orderId)
     if err != nil {
         fmt.Println(err.Error())
     } else {
@@ -60,34 +76,34 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*FuturesApi* | [**CancelFuturesOrder**](docs/FuturesApi.md#cancelfuturesorder) | **Delete** /futures/orders/{order_id} | Cancel a single order
-*FuturesApi* | [**CancelFuturesOrders**](docs/FuturesApi.md#cancelfuturesorders) | **Delete** /futures/orders | Cancel all &#x60;open&#x60; orders matched
-*FuturesApi* | [**CancelPriceTriggeredOrder**](docs/FuturesApi.md#cancelpricetriggeredorder) | **Delete** /futures/price_orders/{order_id} | Cancel a single order
-*FuturesApi* | [**CancelPriceTriggeredOrderList**](docs/FuturesApi.md#cancelpricetriggeredorderlist) | **Delete** /futures/price_orders | Cancel all open orders
-*FuturesApi* | [**CreateFuturesOrder**](docs/FuturesApi.md#createfuturesorder) | **Post** /futures/orders | Create a futures order
-*FuturesApi* | [**CreatePriceTriggeredOrder**](docs/FuturesApi.md#createpricetriggeredorder) | **Post** /futures/price_orders | Create a price-triggered order
-*FuturesApi* | [**GetFuturesContract**](docs/FuturesApi.md#getfuturescontract) | **Get** /futures/contracts/{contract} | Get a single contract
-*FuturesApi* | [**GetFuturesOrder**](docs/FuturesApi.md#getfuturesorder) | **Get** /futures/orders/{order_id} | Get a single order
-*FuturesApi* | [**GetMyTrades**](docs/FuturesApi.md#getmytrades) | **Get** /futures/my_trades | List personal trading history
-*FuturesApi* | [**GetPosition**](docs/FuturesApi.md#getposition) | **Get** /futures/positions/{contract} | Get single position
-*FuturesApi* | [**GetPriceTriggeredOrder**](docs/FuturesApi.md#getpricetriggeredorder) | **Get** /futures/price_orders/{order_id} | Get a single order
-*FuturesApi* | [**ListFuturesAccountBook**](docs/FuturesApi.md#listfuturesaccountbook) | **Get** /futures/account_book | Query account book
-*FuturesApi* | [**ListFuturesAccounts**](docs/FuturesApi.md#listfuturesaccounts) | **Get** /futures/accounts | Query futures account
-*FuturesApi* | [**ListFuturesCandlesticks**](docs/FuturesApi.md#listfuturescandlesticks) | **Get** /futures/candlesticks | Get futures candlesticks
-*FuturesApi* | [**ListFuturesContracts**](docs/FuturesApi.md#listfuturescontracts) | **Get** /futures/contracts | List all futures contracts
-*FuturesApi* | [**ListFuturesFundingRateHistory**](docs/FuturesApi.md#listfuturesfundingratehistory) | **Get** /futures/funding_rate | Funding rate history
-*FuturesApi* | [**ListFuturesInsuranceLedger**](docs/FuturesApi.md#listfuturesinsuranceledger) | **Get** /futures/insurance | Futures insurance balance history
-*FuturesApi* | [**ListFuturesOrderBook**](docs/FuturesApi.md#listfuturesorderbook) | **Get** /futures/order_book | Futures order book
-*FuturesApi* | [**ListFuturesOrders**](docs/FuturesApi.md#listfuturesorders) | **Get** /futures/orders | List futures orders
-*FuturesApi* | [**ListFuturesTickers**](docs/FuturesApi.md#listfuturestickers) | **Get** /futures/tickers | List futures tickers
-*FuturesApi* | [**ListFuturesTrades**](docs/FuturesApi.md#listfuturestrades) | **Get** /futures/trades | Futures trading history
-*FuturesApi* | [**ListLiquidates**](docs/FuturesApi.md#listliquidates) | **Get** /futures/liquidates | List liquidation history
-*FuturesApi* | [**ListPositionClose**](docs/FuturesApi.md#listpositionclose) | **Get** /futures/position_close | List position close history
-*FuturesApi* | [**ListPositions**](docs/FuturesApi.md#listpositions) | **Get** /futures/positions | List all positions of a user
-*FuturesApi* | [**ListPriceTriggeredOrders**](docs/FuturesApi.md#listpricetriggeredorders) | **Get** /futures/price_orders | List all auto orders
-*FuturesApi* | [**UpdatePositionLeverage**](docs/FuturesApi.md#updatepositionleverage) | **Post** /futures/positions/{contract}/leverage | Update position leverage
-*FuturesApi* | [**UpdatePositionMargin**](docs/FuturesApi.md#updatepositionmargin) | **Post** /futures/positions/{contract}/margin | Update position margin
-*FuturesApi* | [**UpdatePositionRiskLimit**](docs/FuturesApi.md#updatepositionrisklimit) | **Post** /futures/positions/{contract}/risk_limit | Update position risk limit
+*FuturesApi* | [**CancelFuturesOrder**](docs/FuturesApi.md#cancelfuturesorder) | **Delete** /futures/{settle}/orders/{order_id} | Cancel a single order
+*FuturesApi* | [**CancelFuturesOrders**](docs/FuturesApi.md#cancelfuturesorders) | **Delete** /futures/{settle}/orders | Cancel all &#x60;open&#x60; orders matched
+*FuturesApi* | [**CancelPriceTriggeredOrder**](docs/FuturesApi.md#cancelpricetriggeredorder) | **Delete** /futures/{settle}/price_orders/{order_id} | Cancel a single order
+*FuturesApi* | [**CancelPriceTriggeredOrderList**](docs/FuturesApi.md#cancelpricetriggeredorderlist) | **Delete** /futures/{settle}/price_orders | Cancel all open orders
+*FuturesApi* | [**CreateFuturesOrder**](docs/FuturesApi.md#createfuturesorder) | **Post** /futures/{settle}/orders | Create a futures order
+*FuturesApi* | [**CreatePriceTriggeredOrder**](docs/FuturesApi.md#createpricetriggeredorder) | **Post** /futures/{settle}/price_orders | Create a price-triggered order
+*FuturesApi* | [**GetFuturesContract**](docs/FuturesApi.md#getfuturescontract) | **Get** /futures/{settle}/contracts/{contract} | Get a single contract
+*FuturesApi* | [**GetFuturesOrder**](docs/FuturesApi.md#getfuturesorder) | **Get** /futures/{settle}/orders/{order_id} | Get a single order
+*FuturesApi* | [**GetMyTrades**](docs/FuturesApi.md#getmytrades) | **Get** /futures/{settle}/my_trades | List personal trading history
+*FuturesApi* | [**GetPosition**](docs/FuturesApi.md#getposition) | **Get** /futures/{settle}/positions/{contract} | Get single position
+*FuturesApi* | [**GetPriceTriggeredOrder**](docs/FuturesApi.md#getpricetriggeredorder) | **Get** /futures/{settle}/price_orders/{order_id} | Get a single order
+*FuturesApi* | [**ListFuturesAccountBook**](docs/FuturesApi.md#listfuturesaccountbook) | **Get** /futures/{settle}/account_book | Query account book
+*FuturesApi* | [**ListFuturesAccounts**](docs/FuturesApi.md#listfuturesaccounts) | **Get** /futures/{settle}/accounts | Query futures account
+*FuturesApi* | [**ListFuturesCandlesticks**](docs/FuturesApi.md#listfuturescandlesticks) | **Get** /futures/{settle}/candlesticks | Get futures candlesticks
+*FuturesApi* | [**ListFuturesContracts**](docs/FuturesApi.md#listfuturescontracts) | **Get** /futures/{settle}/contracts | List all futures contracts
+*FuturesApi* | [**ListFuturesFundingRateHistory**](docs/FuturesApi.md#listfuturesfundingratehistory) | **Get** /futures/{settle}/funding_rate | Funding rate history
+*FuturesApi* | [**ListFuturesInsuranceLedger**](docs/FuturesApi.md#listfuturesinsuranceledger) | **Get** /futures/{settle}/insurance | Futures insurance balance history
+*FuturesApi* | [**ListFuturesOrderBook**](docs/FuturesApi.md#listfuturesorderbook) | **Get** /futures/{settle}/order_book | Futures order book
+*FuturesApi* | [**ListFuturesOrders**](docs/FuturesApi.md#listfuturesorders) | **Get** /futures/{settle}/orders | List futures orders
+*FuturesApi* | [**ListFuturesTickers**](docs/FuturesApi.md#listfuturestickers) | **Get** /futures/{settle}/tickers | List futures tickers
+*FuturesApi* | [**ListFuturesTrades**](docs/FuturesApi.md#listfuturestrades) | **Get** /futures/{settle}/trades | Futures trading history
+*FuturesApi* | [**ListLiquidates**](docs/FuturesApi.md#listliquidates) | **Get** /futures/{settle}/liquidates | List liquidation history
+*FuturesApi* | [**ListPositionClose**](docs/FuturesApi.md#listpositionclose) | **Get** /futures/{settle}/position_close | List position close history
+*FuturesApi* | [**ListPositions**](docs/FuturesApi.md#listpositions) | **Get** /futures/{settle}/positions | List all positions of a user
+*FuturesApi* | [**ListPriceTriggeredOrders**](docs/FuturesApi.md#listpricetriggeredorders) | **Get** /futures/{settle}/price_orders | List all auto orders
+*FuturesApi* | [**UpdatePositionLeverage**](docs/FuturesApi.md#updatepositionleverage) | **Post** /futures/{settle}/positions/{contract}/leverage | Update position leverage
+*FuturesApi* | [**UpdatePositionMargin**](docs/FuturesApi.md#updatepositionmargin) | **Post** /futures/{settle}/positions/{contract}/margin | Update position margin
+*FuturesApi* | [**UpdatePositionRiskLimit**](docs/FuturesApi.md#updatepositionrisklimit) | **Post** /futures/{settle}/positions/{contract}/risk_limit | Update position risk limit
 *MarginApi* | [**CancelLoan**](docs/MarginApi.md#cancelloan) | **Delete** /margin/loans/{loan_id} | Cancel lending loan
 *MarginApi* | [**CreateLoan**](docs/MarginApi.md#createloan) | **Post** /margin/loans | Lend or borrow
 *MarginApi* | [**GetLoan**](docs/MarginApi.md#getloan) | **Get** /margin/loans/{loan_id} | Retrieve one single loan detail