Skip to content
This repository was archived by the owner on Jul 16, 2026. It is now read-only.

Latest commit

History

History
47 lines (43 loc) · 5.32 KB

File metadata and controls

47 lines (43 loc) · 5.32 KB

BatchOrder

Batch order details

Properties

NameTypeDescriptionNotes
order_idstrOrder ID[optional]
amend_textstrThe custom data that the user remarked when amending the order[optional]
textstrOrder custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.)[optional]
succeededboolRequest execution result[optional]
labelstrError label, if any, otherwise an empty string[optional]
messagestrDetailed error message, if any, otherwise an empty string[optional]
idstrOrder ID[optional] [readonly]
create_timestrCreation time of order[optional] [readonly]
update_timestrLast modification time of order[optional] [readonly]
create_time_msintCreation time of order (in milliseconds)[optional] [readonly]
update_time_msintLast modification time of order (in milliseconds)[optional] [readonly]
statusstrOrder status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled[optional] [readonly]
currency_pairstrCurrency pair[optional]
typestrOrder Type - limit : Limit Order - market : Market Order[optional] [default to 'limit']
accountstrAccount type, spot - spot account, margin - leveraged account, unified - unified account[optional] [default to 'spot']
sidestrBuy or sell order[optional]
amountstrTrade amount[optional]
pricestrOrder price[optional]
time_in_forcestrTime in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none[optional] [default to 'gtc']
icebergstrAmount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported[optional]
auto_borrowboolUsed in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough[optional]
auto_repayboolEnable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order[optional]
leftstrAmount left to fill[optional] [readonly]
filled_amountstrAmount filled[optional] [readonly]
fill_pricestrTotal filled in quote currency. Deprecated in favor of `filled_total`[optional] [readonly]
filled_totalstrTotal filled in quote currency[optional] [readonly]
avg_deal_pricestrAverage fill price[optional] [readonly]
feestrFee deducted[optional] [readonly]
fee_currencystrFee currency unit[optional] [readonly]
point_feestrPoints used to deduct fee[optional] [readonly]
gt_feestrGT used to deduct fee[optional] [readonly]
gt_discountboolWhether GT fee deduction is enabled[optional] [readonly]
rebated_feestrRebated fee[optional] [readonly]
rebated_fee_currencystrRebated fee currency unit[optional] [readonly]
stp_idintOrders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`[optional] [readonly]
stp_actstrSelf-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled[optional]
finish_asstrHow the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention[optional] [readonly]

[Back to Model list][Back to API list][Back to README]

, '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" + '
gateapi-python/docs/BatchOrder.md at master · gateio/gateapi-python · GitHub
Skip to content
This repository was archived by the owner on Jul 16, 2026. It is now read-only.

Latest commit

History

History
47 lines (43 loc) · 5.32 KB

File metadata and controls

47 lines (43 loc) · 5.32 KB

BatchOrder

Batch order details

Properties

NameTypeDescriptionNotes
order_idstrOrder ID[optional]
amend_textstrThe custom data that the user remarked when amending the order[optional]
textstrOrder custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.)[optional]
succeededboolRequest execution result[optional]
labelstrError label, if any, otherwise an empty string[optional]
messagestrDetailed error message, if any, otherwise an empty string[optional]
idstrOrder ID[optional] [readonly]
create_timestrCreation time of order[optional] [readonly]
update_timestrLast modification time of order[optional] [readonly]
create_time_msintCreation time of order (in milliseconds)[optional] [readonly]
update_time_msintLast modification time of order (in milliseconds)[optional] [readonly]
statusstrOrder status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled[optional] [readonly]
currency_pairstrCurrency pair[optional]
typestrOrder Type - limit : Limit Order - market : Market Order[optional] [default to 'limit']
accountstrAccount type, spot - spot account, margin - leveraged account, unified - unified account[optional] [default to 'spot']
sidestrBuy or sell order[optional]
amountstrTrade amount[optional]
pricestrOrder price[optional]
time_in_forcestrTime in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none[optional] [default to 'gtc']
icebergstrAmount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported[optional]
auto_borrowboolUsed in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough[optional]
auto_repayboolEnable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order[optional]
leftstrAmount left to fill[optional] [readonly]
filled_amountstrAmount filled[optional] [readonly]
fill_pricestrTotal filled in quote currency. Deprecated in favor of `filled_total`[optional] [readonly]
filled_totalstrTotal filled in quote currency[optional] [readonly]
avg_deal_pricestrAverage fill price[optional] [readonly]
feestrFee deducted[optional] [readonly]
fee_currencystrFee currency unit[optional] [readonly]
point_feestrPoints used to deduct fee[optional] [readonly]
gt_feestrGT used to deduct fee[optional] [readonly]
gt_discountboolWhether GT fee deduction is enabled[optional] [readonly]
rebated_feestrRebated fee[optional] [readonly]
rebated_fee_currencystrRebated fee currency unit[optional] [readonly]
stp_idintOrders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`[optional] [readonly]
stp_actstrSelf-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled[optional]
finish_asstrHow the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention[optional] [readonly]

[Back to Model list][Back to API list][Back to README]

, '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('^' + ".*" + ' gateapi-python/docs/BatchOrder.md at master · gateio/gateapi-python · GitHub
Skip to content
This repository was archived by the owner on Jul 16, 2026. It is now read-only.

Latest commit

History

History
47 lines (43 loc) · 5.32 KB

File metadata and controls

47 lines (43 loc) · 5.32 KB

BatchOrder

Batch order details

Properties

NameTypeDescriptionNotes
order_idstrOrder ID[optional]
amend_textstrThe custom data that the user remarked when amending the order[optional]
textstrOrder custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.)[optional]
succeededboolRequest execution result[optional]
labelstrError label, if any, otherwise an empty string[optional]
messagestrDetailed error message, if any, otherwise an empty string[optional]
idstrOrder ID[optional] [readonly]
create_timestrCreation time of order[optional] [readonly]
update_timestrLast modification time of order[optional] [readonly]
create_time_msintCreation time of order (in milliseconds)[optional] [readonly]
update_time_msintLast modification time of order (in milliseconds)[optional] [readonly]
statusstrOrder status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled[optional] [readonly]
currency_pairstrCurrency pair[optional]
typestrOrder Type - limit : Limit Order - market : Market Order[optional] [default to 'limit']
accountstrAccount type, spot - spot account, margin - leveraged account, unified - unified account[optional] [default to 'spot']
sidestrBuy or sell order[optional]
amountstrTrade amount[optional]
pricestrOrder price[optional]
time_in_forcestrTime in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none[optional] [default to 'gtc']
icebergstrAmount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported[optional]
auto_borrowboolUsed in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough[optional]
auto_repayboolEnable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order[optional]
leftstrAmount left to fill[optional] [readonly]
filled_amountstrAmount filled[optional] [readonly]
fill_pricestrTotal filled in quote currency. Deprecated in favor of `filled_total`[optional] [readonly]
filled_totalstrTotal filled in quote currency[optional] [readonly]
avg_deal_pricestrAverage fill price[optional] [readonly]
feestrFee deducted[optional] [readonly]
fee_currencystrFee currency unit[optional] [readonly]
point_feestrPoints used to deduct fee[optional] [readonly]
gt_feestrGT used to deduct fee[optional] [readonly]
gt_discountboolWhether GT fee deduction is enabled[optional] [readonly]
rebated_feestrRebated fee[optional] [readonly]
rebated_fee_currencystrRebated fee currency unit[optional] [readonly]
stp_idintOrders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`[optional] [readonly]
stp_actstrSelf-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled[optional]
finish_asstrHow the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention[optional] [readonly]

[Back to Model list][Back to API list][Back to README]

, '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('^' + ".*" + ' gateapi-python/docs/BatchOrder.md at master · gateio/gateapi-python · GitHub
Skip to content
This repository was archived by the owner on Jul 16, 2026. It is now read-only.

Latest commit

History

History
47 lines (43 loc) · 5.32 KB

File metadata and controls

47 lines (43 loc) · 5.32 KB

BatchOrder

Batch order details

Properties

NameTypeDescriptionNotes
order_idstrOrder ID[optional]
amend_textstrThe custom data that the user remarked when amending the order[optional]
textstrOrder custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.)[optional]
succeededboolRequest execution result[optional]
labelstrError label, if any, otherwise an empty string[optional]
messagestrDetailed error message, if any, otherwise an empty string[optional]
idstrOrder ID[optional] [readonly]
create_timestrCreation time of order[optional] [readonly]
update_timestrLast modification time of order[optional] [readonly]
create_time_msintCreation time of order (in milliseconds)[optional] [readonly]
update_time_msintLast modification time of order (in milliseconds)[optional] [readonly]
statusstrOrder status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled[optional] [readonly]
currency_pairstrCurrency pair[optional]
typestrOrder Type - limit : Limit Order - market : Market Order[optional] [default to 'limit']
accountstrAccount type, spot - spot account, margin - leveraged account, unified - unified account[optional] [default to 'spot']
sidestrBuy or sell order[optional]
amountstrTrade amount[optional]
pricestrOrder price[optional]
time_in_forcestrTime in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none[optional] [default to 'gtc']
icebergstrAmount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported[optional]
auto_borrowboolUsed in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough[optional]
auto_repayboolEnable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order[optional]
leftstrAmount left to fill[optional] [readonly]
filled_amountstrAmount filled[optional] [readonly]
fill_pricestrTotal filled in quote currency. Deprecated in favor of `filled_total`[optional] [readonly]
filled_totalstrTotal filled in quote currency[optional] [readonly]
avg_deal_pricestrAverage fill price[optional] [readonly]
feestrFee deducted[optional] [readonly]
fee_currencystrFee currency unit[optional] [readonly]
point_feestrPoints used to deduct fee[optional] [readonly]
gt_feestrGT used to deduct fee[optional] [readonly]
gt_discountboolWhether GT fee deduction is enabled[optional] [readonly]
rebated_feestrRebated fee[optional] [readonly]
rebated_fee_currencystrRebated fee currency unit[optional] [readonly]
stp_idintOrders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`[optional] [readonly]
stp_actstrSelf-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled[optional]
finish_asstrHow the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention[optional] [readonly]

[Back to Model list][Back to API list][Back to README]

, '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" + ' gateapi-python/docs/BatchOrder.md at master · gateio/gateapi-python · GitHub
Skip to content
This repository was archived by the owner on Jul 16, 2026. It is now read-only.

Latest commit

History

History
47 lines (43 loc) · 5.32 KB

File metadata and controls

47 lines (43 loc) · 5.32 KB

BatchOrder

Batch order details

Properties

NameTypeDescriptionNotes
order_idstrOrder ID[optional]
amend_textstrThe custom data that the user remarked when amending the order[optional]
textstrOrder custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.)[optional]
succeededboolRequest execution result[optional]
labelstrError label, if any, otherwise an empty string[optional]
messagestrDetailed error message, if any, otherwise an empty string[optional]
idstrOrder ID[optional] [readonly]
create_timestrCreation time of order[optional] [readonly]
update_timestrLast modification time of order[optional] [readonly]
create_time_msintCreation time of order (in milliseconds)[optional] [readonly]
update_time_msintLast modification time of order (in milliseconds)[optional] [readonly]
statusstrOrder status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled[optional] [readonly]
currency_pairstrCurrency pair[optional]
typestrOrder Type - limit : Limit Order - market : Market Order[optional] [default to 'limit']
accountstrAccount type, spot - spot account, margin - leveraged account, unified - unified account[optional] [default to 'spot']
sidestrBuy or sell order[optional]
amountstrTrade amount[optional]
pricestrOrder price[optional]
time_in_forcestrTime in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none[optional] [default to 'gtc']
icebergstrAmount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported[optional]
auto_borrowboolUsed in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough[optional]
auto_repayboolEnable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order[optional]
leftstrAmount left to fill[optional] [readonly]
filled_amountstrAmount filled[optional] [readonly]
fill_pricestrTotal filled in quote currency. Deprecated in favor of `filled_total`[optional] [readonly]
filled_totalstrTotal filled in quote currency[optional] [readonly]
avg_deal_pricestrAverage fill price[optional] [readonly]
feestrFee deducted[optional] [readonly]
fee_currencystrFee currency unit[optional] [readonly]
point_feestrPoints used to deduct fee[optional] [readonly]
gt_feestrGT used to deduct fee[optional] [readonly]
gt_discountboolWhether GT fee deduction is enabled[optional] [readonly]
rebated_feestrRebated fee[optional] [readonly]
rebated_fee_currencystrRebated fee currency unit[optional] [readonly]
stp_idintOrders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`[optional] [readonly]
stp_actstrSelf-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled[optional]
finish_asstrHow the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention[optional] [readonly]

[Back to Model list][Back to API list][Back to README]

, '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('^' + ".*" + ' gateapi-python/docs/BatchOrder.md at master · gateio/gateapi-python · GitHub
Skip to content
This repository was archived by the owner on Jul 16, 2026. It is now read-only.

Latest commit

History

History
47 lines (43 loc) · 5.32 KB

File metadata and controls

47 lines (43 loc) · 5.32 KB

BatchOrder

Batch order details

Properties

NameTypeDescriptionNotes
order_idstrOrder ID[optional]
amend_textstrThe custom data that the user remarked when amending the order[optional]
textstrOrder custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.)[optional]
succeededboolRequest execution result[optional]
labelstrError label, if any, otherwise an empty string[optional]
messagestrDetailed error message, if any, otherwise an empty string[optional]
idstrOrder ID[optional] [readonly]
create_timestrCreation time of order[optional] [readonly]
update_timestrLast modification time of order[optional] [readonly]
create_time_msintCreation time of order (in milliseconds)[optional] [readonly]
update_time_msintLast modification time of order (in milliseconds)[optional] [readonly]
statusstrOrder status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled[optional] [readonly]
currency_pairstrCurrency pair[optional]
typestrOrder Type - limit : Limit Order - market : Market Order[optional] [default to 'limit']
accountstrAccount type, spot - spot account, margin - leveraged account, unified - unified account[optional] [default to 'spot']
sidestrBuy or sell order[optional]
amountstrTrade amount[optional]
pricestrOrder price[optional]
time_in_forcestrTime in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none[optional] [default to 'gtc']
icebergstrAmount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported[optional]
auto_borrowboolUsed in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough[optional]
auto_repayboolEnable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order[optional]
leftstrAmount left to fill[optional] [readonly]
filled_amountstrAmount filled[optional] [readonly]
fill_pricestrTotal filled in quote currency. Deprecated in favor of `filled_total`[optional] [readonly]
filled_totalstrTotal filled in quote currency[optional] [readonly]
avg_deal_pricestrAverage fill price[optional] [readonly]
feestrFee deducted[optional] [readonly]
fee_currencystrFee currency unit[optional] [readonly]
point_feestrPoints used to deduct fee[optional] [readonly]
gt_feestrGT used to deduct fee[optional] [readonly]
gt_discountboolWhether GT fee deduction is enabled[optional] [readonly]
rebated_feestrRebated fee[optional] [readonly]
rebated_fee_currencystrRebated fee currency unit[optional] [readonly]
stp_idintOrders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`[optional] [readonly]
stp_actstrSelf-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled[optional]
finish_asstrHow the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention[optional] [readonly]

[Back to Model list][Back to API list][Back to README]

, '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); } })(); })(); gateapi-python/docs/BatchOrder.md at master · gateio/gateapi-python · GitHub
Skip to content
This repository was archived by the owner on Jul 16, 2026. It is now read-only.

Latest commit

History

History
47 lines (43 loc) · 5.32 KB

File metadata and controls

47 lines (43 loc) · 5.32 KB

BatchOrder

Batch order details

Properties

NameTypeDescriptionNotes
order_idstrOrder ID[optional]
amend_textstrThe custom data that the user remarked when amending the order[optional]
textstrOrder custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.)[optional]
succeededboolRequest execution result[optional]
labelstrError label, if any, otherwise an empty string[optional]
messagestrDetailed error message, if any, otherwise an empty string[optional]
idstrOrder ID[optional] [readonly]
create_timestrCreation time of order[optional] [readonly]
update_timestrLast modification time of order[optional] [readonly]
create_time_msintCreation time of order (in milliseconds)[optional] [readonly]
update_time_msintLast modification time of order (in milliseconds)[optional] [readonly]
statusstrOrder status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled[optional] [readonly]
currency_pairstrCurrency pair[optional]
typestrOrder Type - limit : Limit Order - market : Market Order[optional] [default to 'limit']
accountstrAccount type, spot - spot account, margin - leveraged account, unified - unified account[optional] [default to 'spot']
sidestrBuy or sell order[optional]
amountstrTrade amount[optional]
pricestrOrder price[optional]
time_in_forcestrTime in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none[optional] [default to 'gtc']
icebergstrAmount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported[optional]
auto_borrowboolUsed in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough[optional]
auto_repayboolEnable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order[optional]
leftstrAmount left to fill[optional] [readonly]
filled_amountstrAmount filled[optional] [readonly]
fill_pricestrTotal filled in quote currency. Deprecated in favor of `filled_total`[optional] [readonly]
filled_totalstrTotal filled in quote currency[optional] [readonly]
avg_deal_pricestrAverage fill price[optional] [readonly]
feestrFee deducted[optional] [readonly]
fee_currencystrFee currency unit[optional] [readonly]
point_feestrPoints used to deduct fee[optional] [readonly]
gt_feestrGT used to deduct fee[optional] [readonly]
gt_discountboolWhether GT fee deduction is enabled[optional] [readonly]
rebated_feestrRebated fee[optional] [readonly]
rebated_fee_currencystrRebated fee currency unit[optional] [readonly]
stp_idintOrders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`[optional] [readonly]
stp_actstrSelf-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled[optional]
finish_asstrHow the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention[optional] [readonly]

[Back to Model list][Back to API list][Back to README]