Skip to content

Commit ea0d2bd

Browse files
revilwangrevilwang
committed
add options API and currency chains API
1 parent 42ffaca commit ea0d2bd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+9315
-61
lines changed

‎README.md‎

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ APIv4 provides spot, margin and futures trading operations. There are public API
55

66
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
77

8-
- API version: 4.22.4
9-
- Package version: 4.22.4
8+
- API version: 4.23.0
9+
- Package version: 4.23.0
1010
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1111
For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
1212

@@ -202,6 +202,29 @@ Class | Method | HTTP request | Description
202202
*MarginApi* | [**repay_cross_margin_loan**](docs/MarginApi.md#repay_cross_margin_loan) | **POST** /margin/cross/repayments | Repay cross margin loan
203203
*MarginApi* | [**get_cross_margin_transferable**](docs/MarginApi.md#get_cross_margin_transferable) | **GET** /margin/cross/transferable | Get the max transferable amount for a specific cross margin currency
204204
*MarginApi* | [**get_cross_margin_borrowable**](docs/MarginApi.md#get_cross_margin_borrowable) | **GET** /margin/cross/borrowable | Get the max borrowable amount for a specific cross margin currency
205+
*OptionsApi* | [**list_options_underlyings**](docs/OptionsApi.md#list_options_underlyings) | **GET** /options/underlyings | List all underlyings
206+
*OptionsApi* | [**list_options_expirations**](docs/OptionsApi.md#list_options_expirations) | **GET** /options/expirations | List all expiration times
207+
*OptionsApi* | [**list_options_contracts**](docs/OptionsApi.md#list_options_contracts) | **GET** /options/contracts | List all the contracts with specified underlying and expiration time
208+
*OptionsApi* | [**get_options_contract**](docs/OptionsApi.md#get_options_contract) | **GET** /options/contracts/{contract} | Query specified contract detail
209+
*OptionsApi* | [**list_options_settlements**](docs/OptionsApi.md#list_options_settlements) | **GET** /options/settlements | List settlement history
210+
*OptionsApi* | [**get_options_settlement**](docs/OptionsApi.md#get_options_settlement) | **GET** /options/settlements/{contract} | Get specified contract's settlement
211+
*OptionsApi* | [**list_options_order_book**](docs/OptionsApi.md#list_options_order_book) | **GET** /options/order_book | Futures order book
212+
*OptionsApi* | [**list_options_tickers**](docs/OptionsApi.md#list_options_tickers) | **GET** /options/tickers | List tickers of options contracts
213+
*OptionsApi* | [**list_options_underlying_tickers**](docs/OptionsApi.md#list_options_underlying_tickers) | **GET** /options/underlying/tickers/{underlying} | Get underlying ticker
214+
*OptionsApi* | [**list_options_candlesticks**](docs/OptionsApi.md#list_options_candlesticks) | **GET** /options/candlesticks | Get futures candlesticks
215+
*OptionsApi* | [**list_options_underlying_candlesticks**](docs/OptionsApi.md#list_options_underlying_candlesticks) | **GET** /options/underlying/candlesticks | Mark price candlesticks of an underlying
216+
*OptionsApi* | [**list_options_trades**](docs/OptionsApi.md#list_options_trades) | **GET** /options/trades | Options trade history
217+
*OptionsApi* | [**list_options_account**](docs/OptionsApi.md#list_options_account) | **GET** /options/accounts | List options account
218+
*OptionsApi* | [**list_options_account_book**](docs/OptionsApi.md#list_options_account_book) | **GET** /options/account_book | List account changing history
219+
*OptionsApi* | [**list_options_positions**](docs/OptionsApi.md#list_options_positions) | **GET** /options/positions | List user's positions of specified underlying
220+
*OptionsApi* | [**get_options_position**](docs/OptionsApi.md#get_options_position) | **GET** /options/positions/{contract} | Get specified contract position
221+
*OptionsApi* | [**list_options_position_close**](docs/OptionsApi.md#list_options_position_close) | **GET** /options/position_close | List user's liquidation history of specified underlying
222+
*OptionsApi* | [**list_options_orders**](docs/OptionsApi.md#list_options_orders) | **GET** /options/orders | List futures orders
223+
*OptionsApi* | [**create_options_order**](docs/OptionsApi.md#create_options_order) | **POST** /options/orders | Create an options order
224+
*OptionsApi* | [**cancel_options_orders**](docs/OptionsApi.md#cancel_options_orders) | **DELETE** /options/orders | Cancel all `open` orders matched
225+
*OptionsApi* | [**get_options_order**](docs/OptionsApi.md#get_options_order) | **GET** /options/orders/{order_id} | Get a single order
226+
*OptionsApi* | [**cancel_options_order**](docs/OptionsApi.md#cancel_options_order) | **DELETE** /options/orders/{order_id} | Cancel a single order
227+
*OptionsApi* | [**list_my_options_trades**](docs/OptionsApi.md#list_my_options_trades) | **GET** /options/my_trades | List personal trading history
205228
*SpotApi* | [**list_currencies**](docs/SpotApi.md#list_currencies) | **GET** /spot/currencies | List all currencies' details
206229
*SpotApi* | [**get_currency**](docs/SpotApi.md#get_currency) | **GET** /spot/currencies/{currency} | Get details of a specific currency
207230
*SpotApi* | [**list_currency_pairs**](docs/SpotApi.md#list_currency_pairs) | **GET** /spot/currency_pairs | List all currency pairs supported
@@ -226,6 +249,7 @@ Class | Method | HTTP request | Description
226249
*SpotApi* | [**cancel_spot_price_triggered_order_list**](docs/SpotApi.md#cancel_spot_price_triggered_order_list) | **DELETE** /spot/price_orders | Cancel all open orders
227250
*SpotApi* | [**get_spot_price_triggered_order**](docs/SpotApi.md#get_spot_price_triggered_order) | **GET** /spot/price_orders/{order_id} | Get a single order
228251
*SpotApi* | [**cancel_spot_price_triggered_order**](docs/SpotApi.md#cancel_spot_price_triggered_order) | **DELETE** /spot/price_orders/{order_id} | Cancel a single order
252+
*WalletApi* | [**list_currency_chains**](docs/WalletApi.md#list_currency_chains) | **GET** /wallet/currency_chains | List chains supported for specified currency
229253
*WalletApi* | [**get_deposit_address**](docs/WalletApi.md#get_deposit_address) | **GET** /wallet/deposit_address | Generate currency deposit address
230254
*WalletApi* | [**list_withdrawals**](docs/WalletApi.md#list_withdrawals) | **GET** /wallet/withdrawals | Retrieve withdrawal records
231255
*WalletApi* | [**list_deposits**](docs/WalletApi.md#list_deposits) | **GET** /wallet/deposits | Retrieve deposit records
@@ -259,6 +283,7 @@ Class | Method | HTTP request | Description
259283
- [CrossMarginRepayment](docs/CrossMarginRepayment.md)
260284
- [CrossMarginTransferable](docs/CrossMarginTransferable.md)
261285
- [Currency](docs/Currency.md)
286+
- [CurrencyChain](docs/CurrencyChain.md)
262287
- [CurrencyPair](docs/CurrencyPair.md)
263288
- [DeliveryContract](docs/DeliveryContract.md)
264289
- [DeliverySettlement](docs/DeliverySettlement.md)
@@ -292,6 +317,17 @@ Class | Method | HTTP request | Description
292317
- [MultiChainAddressItem](docs/MultiChainAddressItem.md)
293318
- [MyFuturesTrade](docs/MyFuturesTrade.md)
294319
- [OpenOrders](docs/OpenOrders.md)
320+
- [OptionsAccount](docs/OptionsAccount.md)
321+
- [OptionsAccountBook](docs/OptionsAccountBook.md)
322+
- [OptionsContract](docs/OptionsContract.md)
323+
- [OptionsMyTrade](docs/OptionsMyTrade.md)
324+
- [OptionsOrder](docs/OptionsOrder.md)
325+
- [OptionsPosition](docs/OptionsPosition.md)
326+
- [OptionsPositionClose](docs/OptionsPositionClose.md)
327+
- [OptionsSettlement](docs/OptionsSettlement.md)
328+
- [OptionsTicker](docs/OptionsTicker.md)
329+
- [OptionsUnderlying](docs/OptionsUnderlying.md)
330+
- [OptionsUnderlyingTicker](docs/OptionsUnderlyingTicker.md)
295331
- [Order](docs/Order.md)
296332
- [OrderBook](docs/OrderBook.md)
297333
- [Position](docs/Position.md)

‎docs/CurrencyChain.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CurrencyChain
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**chain** | **str** | Chain name | [optional]
7+
**name_cn** | **str** | Chain name in Chinese | [optional]
8+
**name_en** | **str** | Chain name in English | [optional]
9+
**is_disabled** | **int** | If it is disabled. 0 means NOT being disabled | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/LedgerRecord.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**currency** | **str** | Currency name |
1111
**address** | **str** | Withdrawal address. Required for withdrawals | [optional]
1212
**memo** | **str** | Additional remarks with regards to the withdrawal | [optional]
13-
**status** | **str** | Record status. - DONE: done - CANCEL: cancelled - REQUEST: requesting - MANUAL: pending manual approval - BCODE: GateCode operation - EXTPEND: pending confirm after sending - FAIL: pending confirm when fail | [optional] [readonly]
13+
**status** | **str** | Record status. - DONE: done - CANCEL: cancelled - REQUEST: requesting - MANUAL: pending manual approval - BCODE: GateCode operation - EXTPEND: pending confirm after sending - FAIL: pending confirm when fail - INVALID: invalid order - VERIFY: verifying - PROCES: processing - PEND: pending | [optional] [readonly]
1414
**chain** | **str** | Name of the chain used in withdrawals | [optional]
1515

1616
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/OptionsAccount.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# OptionsAccount
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**user** | **int** | User ID | [optional]
7+
**total** | **str** | Total account balance | [optional]
8+
**short_enabled** | **bool** | If the account is allowed to short | [optional]
9+
**unrealised_pnl** | **str** | Unrealized PNL | [optional]
10+
**init_margin** | **str** | Initial position margin | [optional]
11+
**maint_margin** | **str** | Position maintenance margin | [optional]
12+
**order_margin** | **str** | Order margin of unfinished orders | [optional]
13+
**available** | **str** | Available balance to transfer out or trade | [optional]
14+
**point** | **str** | POINT amount | [optional]
15+
**currency** | **str** | Settle currency | [optional]
16+
17+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18+
19+

‎docs/OptionsAccountBook.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# OptionsAccountBook
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**time** | **float** | Change time | [optional]
7+
**change** | **str** | Amount changed | [optional]
8+
**balance** | **str** | Account total balance after change | [optional]
9+
**type** | **str** | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional]
10+
**text** | **str** | custom text | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

0 commit comments

Comments
 (0)