MetatraderOrder (cloud.metaapi.sdk:metaapi-java-sdk 14.0.7 API)

java.lang.Object
- cloud.metaapi.sdk.clients.meta_api.models.MetatraderOrder

public class MetatraderOrder
extends Object

MetaTrader order

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetatraderOrder.FillingMode` Order filling mode.
`static class`	`MetatraderOrder.OrderReason` Order opening reason.
`static class`	`MetatraderOrder.OrderState` Order state.
`static class`	`MetatraderOrder.OrderType` Order type.

Field Summary

Fields
Modifier and Type	Field and Description
`Double`	`accountCurrencyExchangeRate` Current exchange rate of account currency into account base currency (USD if you did not override it), or `null`
`String`	`brokerTime` Time order was created at, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format
`String`	`clientId` Client-assigned id or `null`.
`String`	`closeByPositionId` Identifier of an opposite position used for closing by order ORDER_TYPE_CLOSE_BY, or `null`
`String`	`comment` Order comment or `null`.
`double`	`currentPrice` Current price
`double`	`currentVolume` Order remaining quantity, i.e.
`String`	`doneBrokerTime` Time order was executed or canceled at, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or `null`.
`cloud.metaapi.sdk.clients.models.IsoTime`	`doneTime` Time order was executed or canceled at or `null`.
`cloud.metaapi.sdk.clients.models.IsoTime`	`expirationTime` Optional order expiration time or `null`
`ExpirationOptions.ExpirationType`	`expirationType` Order expiration type
`MetatraderOrder.FillingMode`	`fillingMode` Order filling mode
`String`	`id` Order id (ticket number)
`long`	`magic` Order magic number, identifies the EA which created the order
`Double`	`openPrice` Order open price (market price for market orders, limit price for limit orders or stop price for stop orders) or `null`
`String`	`originalComment` Order original comment or `null` (present if possible to restore original comment from history)
`String`	`platform` Platform id (mt4 or mt5)
`String`	`positionId` Order position id or `null`.
`MetatraderOrder.OrderReason`	`reason` Order opening reason
`MetatraderOrder.OrderState`	`state` Order state
`Double`	`stopLimitPrice` The Limit order price for the StopLimit order, or `null`
`Double`	`stopLoss` Order stop loss price or `null`
`String`	`symbol` Order symbol
`Double`	`takeProfit` Order take profit price or `null`
`cloud.metaapi.sdk.clients.models.IsoTime`	`time` Time order was created at
`MetatraderOrder.OrderType`	`type` Order type
`Boolean`	`updatePending` Optional flag indicating that order client id and original comment was not identified yet and will be updated in a future synchronization packet, or `null`
`double`	`volume` Order requested quantity

Constructor Summary

Constructors
Constructor and Description

MetatraderOrder()

Constructors
Constructor and Description
`MetatraderOrder()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
public String id
```
    Order id (ticket number)
  - type
```
public MetatraderOrder.OrderType type
```
    Order type
  - state
```
public MetatraderOrder.OrderState state
```
    Order state
  - magic
```
public long magic
```
    Order magic number, identifies the EA which created the order
  - time
```
public cloud.metaapi.sdk.clients.models.IsoTime time
```
    Time order was created at
  - brokerTime
```
public String brokerTime
```
    Time order was created at, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format
  - doneTime
```
public cloud.metaapi.sdk.clients.models.IsoTime doneTime
```
    Time order was executed or canceled at or null. Will be specified for completed orders only
  - doneBrokerTime
```
public String doneBrokerTime
```
    Time order was executed or canceled at, in broker timezone, YYYY-MM-DD HH:mm:ss.SSS format, or null. Will be specified for completed orders only
  - symbol
```
public String symbol
```
    Order symbol
  - openPrice
```
public Double openPrice
```
    Order open price (market price for market orders, limit price for limit orders or stop price for stop orders) or null
  - currentPrice
```
public double currentPrice
```
    Current price
  - stopLoss
```
public Double stopLoss
```
    Order stop loss price or null
  - takeProfit
```
public Double takeProfit
```
    Order take profit price or null
  - volume
```
public double volume
```
    Order requested quantity
  - currentVolume
```
public double currentVolume
```
    Order remaining quantity, i.e. requested quantity - filled quantity
  - positionId
```
public String positionId
```
    Order position id or null. Present only if the order has a position attached to it
  - comment
```
public String comment
```
    Order comment or null. The sum of the line lengths of the comment and the clientId must be less than or equal to 26. For more information see https://metaapi.cloud/docs/client/clientIdUsage/
  - originalComment
```
public String originalComment
```
    Order original comment or null (present if possible to restore original comment from history)
  - clientId
```
public String clientId
```
    Client-assigned id or null. The id value can be assigned when submitting a trade and will be present on position, history orders and history deals related to the trade. You can use this field to bind your trades to objects in your application and then track trade progress. The sum of the line lengths of the comment and the clientId must be less than or equal to 26. For more information see https://metaapi.cloud/docs/client/clientIdUsage/
  - platform
```
public String platform
```
    Platform id (mt4 or mt5)
  - updatePending
```
public Boolean updatePending
```
    Optional flag indicating that order client id and original comment was not identified yet and will be updated in a future synchronization packet, or null
  - reason
```
public MetatraderOrder.OrderReason reason
```
    Order opening reason
  - fillingMode
```
public MetatraderOrder.FillingMode fillingMode
```
    Order filling mode
  - expirationType
```
public ExpirationOptions.ExpirationType expirationType
```
    Order expiration type
  - expirationTime
```
public cloud.metaapi.sdk.clients.models.IsoTime expirationTime
```
    Optional order expiration time or null
  - accountCurrencyExchangeRate
```
public Double accountCurrencyExchangeRate
```
    Current exchange rate of account currency into account base currency (USD if you did not override it), or null
  - closeByPositionId
```
public String closeByPositionId
```
    Identifier of an opposite position used for closing by order ORDER_TYPE_CLOSE_BY, or null
  - stopLimitPrice
```
public Double stopLimitPrice
```
    The Limit order price for the StopLimit order, or null
- Constructor Detail
  - MetatraderOrder
```
public MetatraderOrder()
```

Class MetatraderOrder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

type

state

magic

time

brokerTime

doneTime

doneBrokerTime

symbol

openPrice

currentPrice

stopLoss

takeProfit

volume

currentVolume

positionId

comment

originalComment

clientId

platform

updatePending

reason

fillingMode

expirationType

expirationTime

accountCurrencyExchangeRate

closeByPositionId

stopLimitPrice

Constructor Detail

MetatraderOrder