**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']

**portfolio_margin_total** | **str** | Total amount of the portfolio margin account | [optional]

**text** | **str** | User defined information. If not empty, must follow the rules below: 1. prefixed with `t-` 2. no longer than 28 bytes without `t-` prefix 3. can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - 101: from android - 102: from IOS - 103: from IPAD - 104: from webapp - 3: from web - 2: from apiv2 - apiv4: from apiv4 | [optional]

**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']

**avg_deal_price** | **str** | Average fill price | [optional] [readonly]

Spot order details

Name | Type | Description | Notes

------------ | ------------- | ------------- | -------------

**amount** | **str** | New order amount. `amount` and `price` must specify one of them | [optional]

**price** | **str** | New order price. `amount` and `Price` must specify one of them\" | [optional]

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

[**get_currency_pair**](SpotApi.md#get_currency_pair) | **GET** /spot/currency_pairs/{currency_pair} | Get details of a specifc currency pair

[**amend_order**](SpotApi.md#amend_order) | **PATCH** /spot/orders/{order_id} | Amend an order

Get details of a specifc currency pair

# Get details of a specifc currency pair

Amend an order

By default, the orders of spot and margin account are updated. If you need to modify orders of the `cross-margin` account, you must specify account as `cross_margin`. For portfolio margin account, only `cross_margin` account is supported. Currently, only supports modification of `price` or `amount` fields. Regarding rate limiting: modify order and create order sharing rate limiting rules. Regarding matching priority: only modifying the amount does not affect the priority. If the price is modified, the priority will be adjusted to the last of the new price. Note: If the modified amount is less than the fill amount, the order will be cancelled.

* Api Key Authentication (apiv4):

from __future__ import print_function

import gate_api

from gate_api.exceptions import ApiException, GateApiException

configuration = gate_api.Configuration(

host = "https://api.gateio.ws/api/v4",

key = "YOU_API_KEY",

secret = "YOUR_API_SECRET"

)

api_client = gate_api.ApiClient(configuration)

api_instance = gate_api.SpotApi(api_client)

order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted.

currency_pair = 'BTC_USDT' # str | Currency pair

order_patch = gate_api.OrderPatch() # OrderPatch |

account = 'cross_margin' # str | Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only (optional)

try:

# Amend an order

api_response = api_instance.amend_order(order_id, currency_pair, order_patch, account=account)

print(api_response)

except GateApiException as ex:

print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))

except ApiException as e:

print("Exception when calling SpotApi->amend_order: %s\n" % e)

Name | Type | Description | Notes

------------- | ------------- | ------------- | -------------

**order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. |

**currency_pair** | **str**| Currency pair |

**order_patch** | [**OrderPatch**](OrderPatch.md)| |

**account** | **str**| Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only | [optional]

[**Order**](Order.md)

[apiv4](../README.md#apiv4)

- **Content-Type**: application/json

- **Accept**: application/json

| Status code | Description | Response headers |

|-------------|-------------|------------------|

**200** | Updated | - |

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

api_instance.lock_sub_account(user_id)

- **Content-Type**: Not defined

api_instance.unlock_sub_account(user_id)

- **Content-Type**: Not defined

__version__ = "4.35.0"

from gate_api.models.order_patch import OrderPatch