Create an Entry Order

Create an Entry Order

A regular entry order opens a position when the specified market condition is met.
Please note that if hedging is disabled for the account, the order, first, closes existing opposite positions for the same account and instrument and only then opens a new position for the remaining amount.

A netting entry order closes all positions for the specified instrument and account which are in the direction (buy or sell) opposite to the direction of the entry order.

There are two types of Entry orders : Limit Entry and Stop Entry. This command allows you to create an entry order without specifying order type. The system will determine order type automatically, based on three parameters:

Order direction (Buy or Sell).
Desired order rate.
Current market price of a trading instrument.

The system will create a Limit Entry order if:

Rate for a buy order is below current market price.
Rate for a sell order is above current market price.

The system will create a Stop Entry order if:

Rate for a buy order is above current market price.
Rate for a sell order is below current market price.

Note: This command only available when using O2GTableManager.

Parameter name

Datatype

Description

Command

string

The command. Must be CreateOrder.

OrderType

string

The type of the order. Must be E.

OfferID

string

The identifier of the instrument the order should be placed for. The value must be obtained from the Offers table, the OfferID column.

AccountID

string

The identifier of the account the order should be placed for. The value must be obtained from the Accounts table, the AccountID column.

Please note that the account identifier may not necessarily be equal to the account name which is shown in the Trading Station application.

BuySell

string

The order direction.

The value must be B - for buy orders and S - for sell orders.

Amount

int

The amount of the order. In the case of FX instruments, the amount is expressed in the base currency of an instrument. In the case of CFD instruments, the amount is expressed in contracts. Must be divisible by the value of the lot size.

The amount must not be specified in case the NetQuantity parameter is used.

NetQuantity

string

The net quantity flag. Use this parameter with the value y or Y only for a net quantity order.

An entry order in the netting mode does not create any positions but closes all positions which exist at the moment of the order filling and which are created for the order account and order instrument in the direction (see BuySell) opposite to the direction of the order.

Rate

double

The rate at which the order must be filled.

TrailStep

int

The trailing entry order follows the market in case the market moves in the direction opposite to that of the order (i.e. when the distance between the order and the current market price increases).

The value specifies the maximum change of the market price after which the rate of the order will be changed as well.

The value is expressed in the units of the minimum change of the price (see the Digits column of the Offers table).

For example, if the value in the Digits column is 3 and the value of this field is 5, the maximum change of the market price will be 5 * 10^-3 = 0.005.

If the value is 1, it means that the dynamic trailing mode is used, i.e. the order rate is changed with every change of the market price. Please note that in some systems, only dynamic trailing mode is supported.

The value is optional. By default, this value is 0. 0, it means a non-trailing order.

If the value is specified, the order type in the Orders table will be STE or LTE.

TimeInForce

string

The Time In Force value.

Can be GTC (Good Till Cancelled) or DAY (Day Order).

The value is optional.

Entry orders are GTC orders by default.

ClientRate

double

The current price of the order instrument.

The value is optional. It is used for logging purposes.

CustomID

string

The custom identifier of the order. This value will be populated into these columns of the trading tables:

Table	Column for opening order	Column for closing order
Orders	`RequestTXT`	`RequestTXT`
Trades	`OpenOrderRequestTXT`	N/A
Closed Trades	`OpenOrderRequestTXT`	`CloseOrderRequestTXT`

The value is optional.

You can also create a pair of stop and limit orders for the trade using the same command. Please refer to Attach Stop and/or Limit Orders to the Command for details.

Example: Create an Entry order [hide]

mSession.useTableManager(O2GTableManagerMode.Yes);
mSession.login(mUserID, mPassword, mURL, mConnection);
//...
O2GTableManager tableManager = mSession.getTableManager();
//...
 
 
public void CreateEntryOrder(string sOfferID, string sAccountID, int iAmount, double dRate, string sBuySell)
{
    O2GRequestFactory factory = mSession.getRequestFactory();
    if (factory == null)
        return;
    O2GValueMap valuemap = factory.createValueMap();
    valuemap.setString(O2GRequestParamsEnum.Command, Constants.Commands.CreateOrder);
    valuemap.setString(O2GRequestParamsEnum.OrderType, Constants.Orders.Entry);
    valuemap.setString(O2GRequestParamsEnum.AccountID, sAccountID);         // The identifier of the account the order should be placed for.
    valuemap.setString(O2GRequestParamsEnum.OfferID, sOfferID);             // The identifier of the instrument the order should be placed for.
    valuemap.setString(O2GRequestParamsEnum.BuySell, sBuySell);             // The order direction (Constants.Buy for buy, Constants.Sell for sell)
    valuemap.setDouble(O2GRequestParamsEnum.Rate, dRate);                   // The dRate at which the order must be filled.
    valuemap.setInt(O2GRequestParamsEnum.Amount, iAmount);                  // The quantity of the instrument to be bought or sold.
    valuemap.setString(O2GRequestParamsEnum.CustomID, "EntryOrder");    // The custom identifier of the order.
    O2GRequest request = factory.createOrderRequest(valuemap);
    mSession.sendRequest(request);
}

back