OANDA · Schema
MarketOrderTransaction
A MarketOrderTransaction represents the creation of a Market Order in the user's account. A Market Order is an Order that is filled immediately at the current market price. Market Orders can be specialized when they are created to accomplish a specific task: to close a Trade, to closeout a Position or to particiate in in a Margin closeout.
ForexFX TradingCFD TradingFinancial ServicesTrading APIs
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The Transaction's Identifier. |
| time | string | The date/time when the Transaction was created. |
| userID | integer | The ID of the user that initiated the creation of the Transaction. |
| accountID | string | The ID of the Account the Transaction was created for. |
| batchID | string | The ID of the "batch" that the Transaction belongs to. Transactions in the same batch are applied to the Account simultaneously. |
| requestID | string | The Request ID of the request which generated the transaction. |
| type | string | The Type of the Transaction. Always set to "MARKET_ORDER" in a MarketOrderTransaction. |
| instrument | string | The Market Order's Instrument. |
| units | string | The quantity requested to be filled by the Market Order. A posititive number of units results in a long Order, and a negative number of units results in a short Order. |
| timeInForce | string | The time-in-force requested for the Market Order. Restricted to FOK or IOC for a MarketOrder. |
| priceBound | string | The worst price that the client is willing to have the Market Order filled at. |
| positionFill | string | Specification of how Positions in the Account are modified when the Order is filled. |
| tradeClose | object | |
| longPositionCloseout | object | |
| shortPositionCloseout | object | |
| marginCloseout | object | |
| delayedTradeClose | object | |
| reason | string | The reason that the Market Order was created |
| clientExtensions | object | |
| takeProfitOnFill | object | |
| stopLossOnFill | object | |
| trailingStopLossOnFill | object | |
| tradeClientExtensions | object |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "MarketOrderTransaction",
"description": "A MarketOrderTransaction represents the creation of a Market Order in the user's account. A Market Order is an Order that is filled immediately at the current market price.\nMarket Orders can be specialized when they are created to accomplish a specific task: to close a Trade, to closeout a Position or to particiate in in a Margin closeout.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Transaction's Identifier.",
"format": "String representation of the numerical OANDA-assigned TransactionID"
},
"time": {
"type": "string",
"description": "The date/time when the Transaction was created.",
"format": "The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places)."
},
"userID": {
"type": "integer",
"description": "The ID of the user that initiated the creation of the Transaction."
},
"accountID": {
"type": "string",
"description": "The ID of the Account the Transaction was created for.",
"format": "\"-\"-delimited string with format \"{siteID}-{divisionID}-{userID}-{accountNumber}\""
},
"batchID": {
"type": "string",
"description": "The ID of the \"batch\" that the Transaction belongs to. Transactions in the same batch are applied to the Account simultaneously.",
"format": "String representation of the numerical OANDA-assigned TransactionID"
},
"requestID": {
"type": "string",
"description": "The Request ID of the request which generated the transaction."
},
"type": {
"type": "string",
"description": "The Type of the Transaction. Always set to \"MARKET_ORDER\" in a MarketOrderTransaction.",
"enum": [
"CREATE",
"CLOSE",
"REOPEN",
"CLIENT_CONFIGURE",
"CLIENT_CONFIGURE_REJECT",
"TRANSFER_FUNDS",
"TRANSFER_FUNDS_REJECT",
"MARKET_ORDER",
"MARKET_ORDER_REJECT",
"FIXED_PRICE_ORDER",
"LIMIT_ORDER",
"LIMIT_ORDER_REJECT",
"STOP_ORDER",
"STOP_ORDER_REJECT",
"MARKET_IF_TOUCHED_ORDER",
"MARKET_IF_TOUCHED_ORDER_REJECT",
"TAKE_PROFIT_ORDER",
"TAKE_PROFIT_ORDER_REJECT",
"STOP_LOSS_ORDER",
"STOP_LOSS_ORDER_REJECT",
"TRAILING_STOP_LOSS_ORDER",
"TRAILING_STOP_LOSS_ORDER_REJECT",
"ORDER_FILL",
"ORDER_CANCEL",
"ORDER_CANCEL_REJECT",
"ORDER_CLIENT_EXTENSIONS_MODIFY",
"ORDER_CLIENT_EXTENSIONS_MODIFY_REJECT",
"TRADE_CLIENT_EXTENSIONS_MODIFY",
"TRADE_CLIENT_EXTENSIONS_MODIFY_REJECT",
"MARGIN_CALL_ENTER",
"MARGIN_CALL_EXTEND",
"MARGIN_CALL_EXIT",
"DELAYED_TRADE_CLOSURE",
"DAILY_FINANCING",
"RESET_RESETTABLE_PL"
]
},
"instrument": {
"type": "string",
"description": "The Market Order's Instrument.",
"format": "A string containing the base currency and quote currency delimited by a \"_\"."
},
"units": {
"type": "string",
"description": "The quantity requested to be filled by the Market Order. A posititive number of units results in a long Order, and a negative number of units results in a short Order.",
"format": "A decimal number encoded as a string. The amount of precision provided depends on what the number represents."
},
"timeInForce": {
"type": "string",
"description": "The time-in-force requested for the Market Order. Restricted to FOK or IOC for a MarketOrder.",
"enum": [
"GTC",
"GTD",
"GFD",
"FOK",
"IOC"
]
},
"priceBound": {
"type": "string",
"description": "The worst price that the client is willing to have the Market Order filled at.",
"format": "A decimal number encodes as a string. The amount of precision provided depends on the Instrument."
},
"positionFill": {
"type": "string",
"description": "Specification of how Positions in the Account are modified when the Order is filled.",
"enum": [
"OPEN_ONLY",
"REDUCE_FIRST",
"REDUCE_ONLY",
"DEFAULT"
]
},
"tradeClose": {
"$ref": "#/definitions/MarketOrderTradeClose"
},
"longPositionCloseout": {
"$ref": "#/definitions/MarketOrderPositionCloseout"
},
"shortPositionCloseout": {
"$ref": "#/definitions/MarketOrderPositionCloseout"
},
"marginCloseout": {
"$ref": "#/definitions/MarketOrderMarginCloseout"
},
"delayedTradeClose": {
"$ref": "#/definitions/MarketOrderDelayedTradeClose"
},
"reason": {
"type": "string",
"description": "The reason that the Market Order was created",
"enum": [
"CLIENT_ORDER",
"TRADE_CLOSE",
"POSITION_CLOSEOUT",
"MARGIN_CLOSEOUT",
"DELAYED_TRADE_CLOSE"
]
},
"clientExtensions": {
"$ref": "#/definitions/ClientExtensions"
},
"takeProfitOnFill": {
"$ref": "#/definitions/TakeProfitDetails"
},
"stopLossOnFill": {
"$ref": "#/definitions/StopLossDetails"
},
"trailingStopLossOnFill": {
"$ref": "#/definitions/TrailingStopLossDetails"
},
"tradeClientExtensions": {
"$ref": "#/definitions/ClientExtensions"
}
}
}