107 lines (90 loc) · 8.36 KB
Order

Spot order details
Properties

Name	Type	Description	Notes
id	String	Order ID	[optional] [readonly]
text	String	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 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders	[optional]
amendText	String	The custom data that the user remarked when amending the order	[optional] [readonly]
createTime	String	Creation time of order	[optional] [readonly]
updateTime	String	Last modification time of order	[optional] [readonly]
createTimeMs	Long	Creation time of order (in milliseconds)	[optional] [readonly]
updateTimeMs	Long	Last modification time of order (in milliseconds)	[optional] [readonly]
status	StatusEnum	Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled	[optional] [readonly]
currencyPair	String	Currency pair
type	TypeEnum	Order Type - limit : Limit Order - market : Market Order	[optional]
account	String	Account type, spot - spot account, margin - leveraged account, unified - unified account	[optional]
side	SideEnum	Buy or sell order
amount	String	Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT`
price	String	Trading price, required when `type`=`limit`	[optional]
timeInForce	TimeInForceEnum	Time 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 Only `ioc` and `fok` are supported when `type`=`market`	[optional]
iceberg	String	Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported	[optional]
autoBorrow	Boolean	Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough	[optional]
autoRepay	Boolean	Enable 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]
left	String	Amount left to fill	[optional] [readonly]
filledAmount	String	Amount filled	[optional] [readonly]
fillPrice	String	Total filled in quote currency. Deprecated in favor of `filled_total`	[optional] [readonly]
filledTotal	String	Total filled in quote currency	[optional] [readonly]
avgDealPrice	String	Average fill price	[optional] [readonly]
fee	String	Fee deducted	[optional] [readonly]
feeCurrency	String	Fee currency unit	[optional] [readonly]
pointFee	String	Points used to deduct fee	[optional] [readonly]
gtFee	String	GT used to deduct fee	[optional] [readonly]
gtMakerFee	String	GT amount used to deduct maker fee	[optional] [readonly]
gtTakerFee	String	GT amount used to deduct taker fee	[optional] [readonly]
gtDiscount	Boolean	Whether GT fee deduction is enabled	[optional] [readonly]
rebatedFee	String	Rebated fee	[optional] [readonly]
rebatedFeeCurrency	String	Rebated fee currency unit	[optional] [readonly]
stpId	Integer	Orders 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]
stpAct	StpActEnum	Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention 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, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled	[optional]
finishAs	FinishAsEnum	How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown	[optional] [readonly]
actionMode	String	Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default)	[optional]
slippage	String	Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%)	[optional]
stopProfit	SpotOrderStopProfit		[optional]
stopLoss	SpotOrderStopLoss		[optional]
Enum: StatusEnum

Name	Value
OPEN	"open"
CLOSED	"closed"
CANCELLED	"cancelled"
Enum: TypeEnum

Name	Value
LIMIT	"limit"
MARKET	"market"
Enum: SideEnum

Name	Value
BUY	"buy"
SELL	"sell"
Enum: TimeInForceEnum

Name	Value
GTC	"gtc"
IOC	"ioc"
POC	"poc"
FOK	"fok"
Enum: StpActEnum

Name	Value
CN	"cn"
CO	"co"
CB	"cb"
MINUS	"-"
Enum: FinishAsEnum

Name	Value
OPEN	"open"
FILLED	"filled"
CANCELLED	"cancelled"
LIQUIDATE_CANCELLED	"liquidate_cancelled"
DEPTH_NOT_ENOUGH	"depth_not_enough"
TRADER_NOT_ENOUGH	"trader_not_enough"
SMALL	"small"
IOC	"ioc"
POC	"poc"
FOK	"fok"
STP	"stp"
PRICE_PROTECT_CANCELLED	"price_protect_cancelled"
UNKNOWN	"unknown"
, '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-java/docs/Order.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
107 lines (90 loc) · 8.36 KB
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
File metadata and controls
107 lines (90 loc) · 8.36 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
Order
Spot order details
Properties
Name Type Description Notes
id String Order ID [optional] [readonly]
text String 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 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders [optional]
amendText String The custom data that the user remarked when amending the order [optional] [readonly]
createTime String Creation time of order [optional] [readonly]
updateTime String Last modification time of order [optional] [readonly]
createTimeMs Long Creation time of order (in milliseconds) [optional] [readonly]
updateTimeMs Long Last modification time of order (in milliseconds) [optional] [readonly]
status StatusEnum Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled [optional] [readonly]
currencyPair String Currency pair 
type TypeEnum Order Type - limit : Limit Order - market : Market Order [optional]
account String Account type, spot - spot account, margin - leveraged account, unified - unified account [optional]
side SideEnum Buy or sell order 
amount String Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT` 
price String Trading price, required when `type`=`limit` [optional]
timeInForce TimeInForceEnum Time 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 Only `ioc` and `fok` are supported when `type`=`market` [optional]
iceberg String Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported [optional]
autoBorrow Boolean Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough [optional]
autoRepay Boolean Enable 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]
left String Amount left to fill [optional] [readonly]
filledAmount String Amount filled [optional] [readonly]
fillPrice String Total filled in quote currency. Deprecated in favor of `filled_total` [optional] [readonly]
filledTotal String Total filled in quote currency [optional] [readonly]
avgDealPrice String Average fill price [optional] [readonly]
fee String Fee deducted [optional] [readonly]
feeCurrency String Fee currency unit [optional] [readonly]
pointFee String Points used to deduct fee [optional] [readonly]
gtFee String GT used to deduct fee [optional] [readonly]
gtMakerFee String GT amount used to deduct maker fee [optional] [readonly]
gtTakerFee String GT amount used to deduct taker fee [optional] [readonly]
gtDiscount Boolean Whether GT fee deduction is enabled [optional] [readonly]
rebatedFee String Rebated fee [optional] [readonly]
rebatedFeeCurrency String Rebated fee currency unit [optional] [readonly]
stpId Integer Orders 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]
stpAct StpActEnum Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention 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, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled [optional]
finishAs FinishAsEnum How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown [optional] [readonly]
actionMode String Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) [optional]
slippage String Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%) [optional]
stopProfit SpotOrderStopProfit [optional]
stopLoss SpotOrderStopLoss [optional]Enum: StatusEnum
Name Value
OPEN "open"
CLOSED "closed"
CANCELLED "cancelled"Enum: TypeEnum
Name Value
LIMIT "limit"
MARKET "market"Enum: SideEnum
Name Value
BUY "buy"
SELL "sell"Enum: TimeInForceEnum
Name Value
GTC "gtc"
IOC "ioc"
POC "poc"
FOK "fok"Enum: StpActEnum
Name Value
CN "cn"
CO "co"
CB "cb"
MINUS "-"Enum: FinishAsEnum
Name Value
OPEN "open"
FILLED "filled"
CANCELLED "cancelled"
LIQUIDATE_CANCELLED "liquidate_cancelled"
DEPTH_NOT_ENOUGH "depth_not_enough"
TRADER_NOT_ENOUGH "trader_not_enough"
SMALL "small"
IOC "ioc"
POC "poc"
FOK "fok"
STP "stp"
PRICE_PROTECT_CANCELLED "price_protect_cancelled"
UNKNOWN "unknown"
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, '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-java/docs/Order.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
107 lines (90 loc) · 8.36 KB
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
File metadata and controls
107 lines (90 loc) · 8.36 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
Order
Spot order details
Properties
Name Type Description Notes
id String Order ID [optional] [readonly]
text String 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 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders [optional]
amendText String The custom data that the user remarked when amending the order [optional] [readonly]
createTime String Creation time of order [optional] [readonly]
updateTime String Last modification time of order [optional] [readonly]
createTimeMs Long Creation time of order (in milliseconds) [optional] [readonly]
updateTimeMs Long Last modification time of order (in milliseconds) [optional] [readonly]
status StatusEnum Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled [optional] [readonly]
currencyPair String Currency pair 
type TypeEnum Order Type - limit : Limit Order - market : Market Order [optional]
account String Account type, spot - spot account, margin - leveraged account, unified - unified account [optional]
side SideEnum Buy or sell order 
amount String Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT` 
price String Trading price, required when `type`=`limit` [optional]
timeInForce TimeInForceEnum Time 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 Only `ioc` and `fok` are supported when `type`=`market` [optional]
iceberg String Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported [optional]
autoBorrow Boolean Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough [optional]
autoRepay Boolean Enable 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]
left String Amount left to fill [optional] [readonly]
filledAmount String Amount filled [optional] [readonly]
fillPrice String Total filled in quote currency. Deprecated in favor of `filled_total` [optional] [readonly]
filledTotal String Total filled in quote currency [optional] [readonly]
avgDealPrice String Average fill price [optional] [readonly]
fee String Fee deducted [optional] [readonly]
feeCurrency String Fee currency unit [optional] [readonly]
pointFee String Points used to deduct fee [optional] [readonly]
gtFee String GT used to deduct fee [optional] [readonly]
gtMakerFee String GT amount used to deduct maker fee [optional] [readonly]
gtTakerFee String GT amount used to deduct taker fee [optional] [readonly]
gtDiscount Boolean Whether GT fee deduction is enabled [optional] [readonly]
rebatedFee String Rebated fee [optional] [readonly]
rebatedFeeCurrency String Rebated fee currency unit [optional] [readonly]
stpId Integer Orders 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]
stpAct StpActEnum Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention 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, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled [optional]
finishAs FinishAsEnum How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown [optional] [readonly]
actionMode String Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) [optional]
slippage String Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%) [optional]
stopProfit SpotOrderStopProfit [optional]
stopLoss SpotOrderStopLoss [optional]Enum: StatusEnum
Name Value
OPEN "open"
CLOSED "closed"
CANCELLED "cancelled"Enum: TypeEnum
Name Value
LIMIT "limit"
MARKET "market"Enum: SideEnum
Name Value
BUY "buy"
SELL "sell"Enum: TimeInForceEnum
Name Value
GTC "gtc"
IOC "ioc"
POC "poc"
FOK "fok"Enum: StpActEnum
Name Value
CN "cn"
CO "co"
CB "cb"
MINUS "-"Enum: FinishAsEnum
Name Value
OPEN "open"
FILLED "filled"
CANCELLED "cancelled"
LIQUIDATE_CANCELLED "liquidate_cancelled"
DEPTH_NOT_ENOUGH "depth_not_enough"
TRADER_NOT_ENOUGH "trader_not_enough"
SMALL "small"
IOC "ioc"
POC "poc"
FOK "fok"
STP "stp"
PRICE_PROTECT_CANCELLED "price_protect_cancelled"
UNKNOWN "unknown"
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, '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-java/docs/Order.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
107 lines (90 loc) · 8.36 KB
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
File metadata and controls
107 lines (90 loc) · 8.36 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
Order
Spot order details
Properties
Name Type Description Notes
id String Order ID [optional] [readonly]
text String 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 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders [optional]
amendText String The custom data that the user remarked when amending the order [optional] [readonly]
createTime String Creation time of order [optional] [readonly]
updateTime String Last modification time of order [optional] [readonly]
createTimeMs Long Creation time of order (in milliseconds) [optional] [readonly]
updateTimeMs Long Last modification time of order (in milliseconds) [optional] [readonly]
status StatusEnum Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled [optional] [readonly]
currencyPair String Currency pair 
type TypeEnum Order Type - limit : Limit Order - market : Market Order [optional]
account String Account type, spot - spot account, margin - leveraged account, unified - unified account [optional]
side SideEnum Buy or sell order 
amount String Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT` 
price String Trading price, required when `type`=`limit` [optional]
timeInForce TimeInForceEnum Time 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 Only `ioc` and `fok` are supported when `type`=`market` [optional]
iceberg String Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported [optional]
autoBorrow Boolean Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough [optional]
autoRepay Boolean Enable 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]
left String Amount left to fill [optional] [readonly]
filledAmount String Amount filled [optional] [readonly]
fillPrice String Total filled in quote currency. Deprecated in favor of `filled_total` [optional] [readonly]
filledTotal String Total filled in quote currency [optional] [readonly]
avgDealPrice String Average fill price [optional] [readonly]
fee String Fee deducted [optional] [readonly]
feeCurrency String Fee currency unit [optional] [readonly]
pointFee String Points used to deduct fee [optional] [readonly]
gtFee String GT used to deduct fee [optional] [readonly]
gtMakerFee String GT amount used to deduct maker fee [optional] [readonly]
gtTakerFee String GT amount used to deduct taker fee [optional] [readonly]
gtDiscount Boolean Whether GT fee deduction is enabled [optional] [readonly]
rebatedFee String Rebated fee [optional] [readonly]
rebatedFeeCurrency String Rebated fee currency unit [optional] [readonly]
stpId Integer Orders 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]
stpAct StpActEnum Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention 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, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled [optional]
finishAs FinishAsEnum How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown [optional] [readonly]
actionMode String Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) [optional]
slippage String Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%) [optional]
stopProfit SpotOrderStopProfit [optional]
stopLoss SpotOrderStopLoss [optional]Enum: StatusEnum
Name Value
OPEN "open"
CLOSED "closed"
CANCELLED "cancelled"Enum: TypeEnum
Name Value
LIMIT "limit"
MARKET "market"Enum: SideEnum
Name Value
BUY "buy"
SELL "sell"Enum: TimeInForceEnum
Name Value
GTC "gtc"
IOC "ioc"
POC "poc"
FOK "fok"Enum: StpActEnum
Name Value
CN "cn"
CO "co"
CB "cb"
MINUS "-"Enum: FinishAsEnum
Name Value
OPEN "open"
FILLED "filled"
CANCELLED "cancelled"
LIQUIDATE_CANCELLED "liquidate_cancelled"
DEPTH_NOT_ENOUGH "depth_not_enough"
TRADER_NOT_ENOUGH "trader_not_enough"
SMALL "small"
IOC "ioc"
POC "poc"
FOK "fok"
STP "stp"
PRICE_PROTECT_CANCELLED "price_protect_cancelled"
UNKNOWN "unknown"
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, '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-java/docs/Order.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
107 lines (90 loc) · 8.36 KB
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
File metadata and controls
107 lines (90 loc) · 8.36 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
Order
Spot order details
Properties
Name Type Description Notes
id String Order ID [optional] [readonly]
text String 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 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders [optional]
amendText String The custom data that the user remarked when amending the order [optional] [readonly]
createTime String Creation time of order [optional] [readonly]
updateTime String Last modification time of order [optional] [readonly]
createTimeMs Long Creation time of order (in milliseconds) [optional] [readonly]
updateTimeMs Long Last modification time of order (in milliseconds) [optional] [readonly]
status StatusEnum Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled [optional] [readonly]
currencyPair String Currency pair 
type TypeEnum Order Type - limit : Limit Order - market : Market Order [optional]
account String Account type, spot - spot account, margin - leveraged account, unified - unified account [optional]
side SideEnum Buy or sell order 
amount String Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT` 
price String Trading price, required when `type`=`limit` [optional]
timeInForce TimeInForceEnum Time 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 Only `ioc` and `fok` are supported when `type`=`market` [optional]
iceberg String Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported [optional]
autoBorrow Boolean Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough [optional]
autoRepay Boolean Enable 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]
left String Amount left to fill [optional] [readonly]
filledAmount String Amount filled [optional] [readonly]
fillPrice String Total filled in quote currency. Deprecated in favor of `filled_total` [optional] [readonly]
filledTotal String Total filled in quote currency [optional] [readonly]
avgDealPrice String Average fill price [optional] [readonly]
fee String Fee deducted [optional] [readonly]
feeCurrency String Fee currency unit [optional] [readonly]
pointFee String Points used to deduct fee [optional] [readonly]
gtFee String GT used to deduct fee [optional] [readonly]
gtMakerFee String GT amount used to deduct maker fee [optional] [readonly]
gtTakerFee String GT amount used to deduct taker fee [optional] [readonly]
gtDiscount Boolean Whether GT fee deduction is enabled [optional] [readonly]
rebatedFee String Rebated fee [optional] [readonly]
rebatedFeeCurrency String Rebated fee currency unit [optional] [readonly]
stpId Integer Orders 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]
stpAct StpActEnum Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention 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, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled [optional]
finishAs FinishAsEnum How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown [optional] [readonly]
actionMode String Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) [optional]
slippage String Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%) [optional]
stopProfit SpotOrderStopProfit [optional]
stopLoss SpotOrderStopLoss [optional]Enum: StatusEnum
Name Value
OPEN "open"
CLOSED "closed"
CANCELLED "cancelled"Enum: TypeEnum
Name Value
LIMIT "limit"
MARKET "market"Enum: SideEnum
Name Value
BUY "buy"
SELL "sell"Enum: TimeInForceEnum
Name Value
GTC "gtc"
IOC "ioc"
POC "poc"
FOK "fok"Enum: StpActEnum
Name Value
CN "cn"
CO "co"
CB "cb"
MINUS "-"Enum: FinishAsEnum
Name Value
OPEN "open"
FILLED "filled"
CANCELLED "cancelled"
LIQUIDATE_CANCELLED "liquidate_cancelled"
DEPTH_NOT_ENOUGH "depth_not_enough"
TRADER_NOT_ENOUGH "trader_not_enough"
SMALL "small"
IOC "ioc"
POC "poc"
FOK "fok"
STP "stp"
PRICE_PROTECT_CANCELLED "price_protect_cancelled"
UNKNOWN "unknown"
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, '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-java/docs/Order.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
107 lines (90 loc) · 8.36 KB
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
File metadata and controls
107 lines (90 loc) · 8.36 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
Order
Spot order details
Properties
Name Type Description Notes
id String Order ID [optional] [readonly]
text String 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 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders [optional]
amendText String The custom data that the user remarked when amending the order [optional] [readonly]
createTime String Creation time of order [optional] [readonly]
updateTime String Last modification time of order [optional] [readonly]
createTimeMs Long Creation time of order (in milliseconds) [optional] [readonly]
updateTimeMs Long Last modification time of order (in milliseconds) [optional] [readonly]
status StatusEnum Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled [optional] [readonly]
currencyPair String Currency pair 
type TypeEnum Order Type - limit : Limit Order - market : Market Order [optional]
account String Account type, spot - spot account, margin - leveraged account, unified - unified account [optional]
side SideEnum Buy or sell order 
amount String Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT` 
price String Trading price, required when `type`=`limit` [optional]
timeInForce TimeInForceEnum Time 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 Only `ioc` and `fok` are supported when `type`=`market` [optional]
iceberg String Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported [optional]
autoBorrow Boolean Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough [optional]
autoRepay Boolean Enable 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]
left String Amount left to fill [optional] [readonly]
filledAmount String Amount filled [optional] [readonly]
fillPrice String Total filled in quote currency. Deprecated in favor of `filled_total` [optional] [readonly]
filledTotal String Total filled in quote currency [optional] [readonly]
avgDealPrice String Average fill price [optional] [readonly]
fee String Fee deducted [optional] [readonly]
feeCurrency String Fee currency unit [optional] [readonly]
pointFee String Points used to deduct fee [optional] [readonly]
gtFee String GT used to deduct fee [optional] [readonly]
gtMakerFee String GT amount used to deduct maker fee [optional] [readonly]
gtTakerFee String GT amount used to deduct taker fee [optional] [readonly]
gtDiscount Boolean Whether GT fee deduction is enabled [optional] [readonly]
rebatedFee String Rebated fee [optional] [readonly]
rebatedFeeCurrency String Rebated fee currency unit [optional] [readonly]
stpId Integer Orders 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]
stpAct StpActEnum Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention 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, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled [optional]
finishAs FinishAsEnum How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown [optional] [readonly]
actionMode String Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) [optional]
slippage String Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%) [optional]
stopProfit SpotOrderStopProfit [optional]
stopLoss SpotOrderStopLoss [optional]Enum: StatusEnum
Name Value
OPEN "open"
CLOSED "closed"
CANCELLED "cancelled"Enum: TypeEnum
Name Value
LIMIT "limit"
MARKET "market"Enum: SideEnum
Name Value
BUY "buy"
SELL "sell"Enum: TimeInForceEnum
Name Value
GTC "gtc"
IOC "ioc"
POC "poc"
FOK "fok"Enum: StpActEnum
Name Value
CN "cn"
CO "co"
CB "cb"
MINUS "-"Enum: FinishAsEnum
Name Value
OPEN "open"
FILLED "filled"
CANCELLED "cancelled"
LIQUIDATE_CANCELLED "liquidate_cancelled"
DEPTH_NOT_ENOUGH "depth_not_enough"
TRADER_NOT_ENOUGH "trader_not_enough"
SMALL "small"
IOC "ioc"
POC "poc"
FOK "fok"
STP "stp"
PRICE_PROTECT_CANCELLED "price_protect_cancelled"
UNKNOWN "unknown"
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, '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); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
gateapi-java/docs/Order.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
107 lines (90 loc) · 8.36 KB
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
File metadata and controls
107 lines (90 loc) · 8.36 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
Order
Spot order details
Properties
Name Type Description Notes
id String Order ID [optional] [readonly]
text String 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 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders [optional]
amendText String The custom data that the user remarked when amending the order [optional] [readonly]
createTime String Creation time of order [optional] [readonly]
updateTime String Last modification time of order [optional] [readonly]
createTimeMs Long Creation time of order (in milliseconds) [optional] [readonly]
updateTimeMs Long Last modification time of order (in milliseconds) [optional] [readonly]
status StatusEnum Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled [optional] [readonly]
currencyPair String Currency pair 
type TypeEnum Order Type - limit : Limit Order - market : Market Order [optional]
account String Account type, spot - spot account, margin - leveraged account, unified - unified account [optional]
side SideEnum Buy or sell order 
amount String Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT` 
price String Trading price, required when `type`=`limit` [optional]
timeInForce TimeInForceEnum Time 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 Only `ioc` and `fok` are supported when `type`=`market` [optional]
iceberg String Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported [optional]
autoBorrow Boolean Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough [optional]
autoRepay Boolean Enable 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]
left String Amount left to fill [optional] [readonly]
filledAmount String Amount filled [optional] [readonly]
fillPrice String Total filled in quote currency. Deprecated in favor of `filled_total` [optional] [readonly]
filledTotal String Total filled in quote currency [optional] [readonly]
avgDealPrice String Average fill price [optional] [readonly]
fee String Fee deducted [optional] [readonly]
feeCurrency String Fee currency unit [optional] [readonly]
pointFee String Points used to deduct fee [optional] [readonly]
gtFee String GT used to deduct fee [optional] [readonly]
gtMakerFee String GT amount used to deduct maker fee [optional] [readonly]
gtTakerFee String GT amount used to deduct taker fee [optional] [readonly]
gtDiscount Boolean Whether GT fee deduction is enabled [optional] [readonly]
rebatedFee String Rebated fee [optional] [readonly]
rebatedFeeCurrency String Rebated fee currency unit [optional] [readonly]
stpId Integer Orders 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]
stpAct StpActEnum Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention 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, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled [optional]
finishAs FinishAsEnum How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown [optional] [readonly]
actionMode String Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) [optional]
slippage String Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%) [optional]
stopProfit SpotOrderStopProfit [optional]
stopLoss SpotOrderStopLoss [optional]Enum: StatusEnum
Name Value
OPEN "open"
CLOSED "closed"
CANCELLED "cancelled"Enum: TypeEnum
Name Value
LIMIT "limit"
MARKET "market"Enum: SideEnum
Name Value
BUY "buy"
SELL "sell"Enum: TimeInForceEnum
Name Value
GTC "gtc"
IOC "ioc"
POC "poc"
FOK "fok"Enum: StpActEnum
Name Value
CN "cn"
CO "co"
CB "cb"
MINUS "-"Enum: FinishAsEnum
Name Value
OPEN "open"
FILLED "filled"
CANCELLED "cancelled"
LIQUIDATE_CANCELLED "liquidate_cancelled"
DEPTH_NOT_ENOUGH "depth_not_enough"
TRADER_NOT_ENOUGH "trader_not_enough"
SMALL "small"
IOC "ioc"
POC "poc"
FOK "fok"
STP "stp"
PRICE_PROTECT_CANCELLED "price_protect_cancelled"
UNKNOWN "unknown"
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
gateapi-java/docs/Order.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
107 lines (90 loc) · 8.36 KB
Breadcrumbs
gateapi-java
/docs
/Order.md
Copy path
File metadata and controls
107 lines (90 loc) · 8.36 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
Order
Spot order details
Properties
Name Type Description Notes
id String Order ID [optional] [readonly]
text String 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 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders [optional]
amendText String The custom data that the user remarked when amending the order [optional] [readonly]
createTime String Creation time of order [optional] [readonly]
updateTime String Last modification time of order [optional] [readonly]
createTimeMs Long Creation time of order (in milliseconds) [optional] [readonly]
updateTimeMs Long Last modification time of order (in milliseconds) [optional] [readonly]
status StatusEnum Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled [optional] [readonly]
currencyPair String Currency pair 
type TypeEnum Order Type - limit : Limit Order - market : Market Order [optional]
account String Account type, spot - spot account, margin - leveraged account, unified - unified account [optional]
side SideEnum Buy or sell order 
amount String Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT` 
price String Trading price, required when `type`=`limit` [optional]
timeInForce TimeInForceEnum Time 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 Only `ioc` and `fok` are supported when `type`=`market` [optional]
iceberg String Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported [optional]
autoBorrow Boolean Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough [optional]
autoRepay Boolean Enable 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]
left String Amount left to fill [optional] [readonly]
filledAmount String Amount filled [optional] [readonly]
fillPrice String Total filled in quote currency. Deprecated in favor of `filled_total` [optional] [readonly]
filledTotal String Total filled in quote currency [optional] [readonly]
avgDealPrice String Average fill price [optional] [readonly]
fee String Fee deducted [optional] [readonly]
feeCurrency String Fee currency unit [optional] [readonly]
pointFee String Points used to deduct fee [optional] [readonly]
gtFee String GT used to deduct fee [optional] [readonly]
gtMakerFee String GT amount used to deduct maker fee [optional] [readonly]
gtTakerFee String GT amount used to deduct taker fee [optional] [readonly]
gtDiscount Boolean Whether GT fee deduction is enabled [optional] [readonly]
rebatedFee String Rebated fee [optional] [readonly]
rebatedFeeCurrency String Rebated fee currency unit [optional] [readonly]
stpId Integer Orders 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]
stpAct StpActEnum Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention 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, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled [optional]
finishAs FinishAsEnum How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown [optional] [readonly]
actionMode String Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) [optional]
slippage String Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%) [optional]
stopProfit SpotOrderStopProfit [optional]
stopLoss SpotOrderStopLoss [optional]Enum: StatusEnum
Name Value
OPEN "open"
CLOSED "closed"
CANCELLED "cancelled"Enum: TypeEnum
Name Value
LIMIT "limit"
MARKET "market"Enum: SideEnum
Name Value
BUY "buy"
SELL "sell"Enum: TimeInForceEnum
Name Value
GTC "gtc"
IOC "ioc"
POC "poc"
FOK "fok"Enum: StpActEnum
Name Value
CN "cn"
CO "co"
CB "cb"
MINUS "-"Enum: FinishAsEnum
Name Value
OPEN "open"
FILLED "filled"
CANCELLED "cancelled"
LIQUIDATE_CANCELLED "liquidate_cancelled"
DEPTH_NOT_ENOUGH "depth_not_enough"
TRADER_NOT_ENOUGH "trader_not_enough"
SMALL "small"
IOC "ioc"
POC "poc"
FOK "fok"
STP "stp"
PRICE_PROTECT_CANCELLED "price_protect_cancelled"
UNKNOWN "unknown"
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.
Uh oh!

FilesExpand file tree

Order.md

Latest commit

History

Order.md

File metadata and controls

Order

Properties

Enum: StatusEnum

Enum: TypeEnum

Enum: SideEnum

Enum: TimeInForceEnum

Enum: StpActEnum

Enum: FinishAsEnum

Uh oh!

FilesExpand file tree

Order.md

Latest commit

History

Order.md

File metadata and controls

Order

Properties

Enum: StatusEnum

Enum: TypeEnum

Enum: SideEnum

Enum: TimeInForceEnum

Enum: StpActEnum

Enum: FinishAsEnum

Uh oh!

FilesExpand file tree

Order.md

Latest commit

History

Order.md

File metadata and controls

Order

Properties

Enum: StatusEnum

Enum: TypeEnum

Enum: SideEnum

Enum: TimeInForceEnum

Enum: StpActEnum

Enum: FinishAsEnum

Uh oh!

FilesExpand file tree

Order.md

Latest commit

History

Order.md

File metadata and controls

Order

Properties

Enum: StatusEnum

Enum: TypeEnum

Enum: SideEnum

Enum: TimeInForceEnum

Enum: StpActEnum

Enum: FinishAsEnum

Uh oh!

FilesExpand file tree

Order.md

Latest commit

History

Order.md

File metadata and controls

Order

Properties

Enum: StatusEnum

Enum: TypeEnum

Enum: SideEnum

Enum: TimeInForceEnum

Enum: StpActEnum

Enum: FinishAsEnum

Uh oh!

FilesExpand file tree

Order.md

Latest commit

History
