AlgoOrderOptions (Lime Brokerage Trading API)

java.lang.Object
- limebrokerage.trading.api.AlgoOrderOptions

```
public final class AlgoOrderOptions
extends java.lang.Object
```
Order options for Algo orders for US-Equities securities. All setters return the object, so that multiple sets can be easily chained together.
Not all order options are applicable for all venues or account types. Setting an option where not allowed or not applicable will result in an order reject.

See Also:
Client.placeAlgo(long, int, long, limebrokerage.trading.api.Side, java.lang.String, java.lang.String, java.lang.String)

Constructor Summary

Constructors
Constructor and Description

AlgoOrderOptions()
Constructs an instance without any options set.

Constructors
Constructor and Description
`AlgoOrderOptions()` Constructs an instance without any options set.

Method Summary

Methods
Modifier and Type	Method and Description
`AlgoOrderOptions`	`setAggression(int value)` Enables the aggression option.
`AlgoOrderOptions`	`setClientData1(java.lang.String clientData)` Enables the client data 1 option.
`AlgoOrderOptions`	`setClientData2(java.lang.String clientData)` Enables the client data 2 option.
`AlgoOrderOptions`	`setClientData3(java.lang.String clientData)` Enables the client data 3 option.
`AlgoOrderOptions`	`setDiscretionOffset(int offset)` Enables the discretion offset option.
`AlgoOrderOptions`	`setEndTime(java.util.Date time)` Enables the end-time option.
`AlgoOrderOptions`	`setExcludedVenues(java.lang.String venues)` Enables the excluded Venues option.
`AlgoOrderOptions`	`setExpireTime(java.util.Date expire)` Enables the expire-time option.
`AlgoOrderOptions`	`setInvisible()` Enables the invisible option.
`AlgoOrderOptions`	`setIWouldPx(int price)` Enables the iWouldPx option.
`AlgoOrderOptions`	`setMaxFloor(int floor)` Enables the max-floor option.
`AlgoOrderOptions`	`setMaxMarketOrderSlippageAmount(int diff)` Enables the max market order slippage amount option.
`AlgoOrderOptions`	`setMinimumTriggerPercent(int mtp)` Enables the minimumTriggerPercent option.
`AlgoOrderOptions`	`setMinimumTriggerVol(int mtv)` Enables the minimumTriggerVol option.
`AlgoOrderOptions`	`setMinQuantity(int qty)` Enables the min-quantity option.
`AlgoOrderOptions`	`setPegDifference(int difference)` Enables the peg-difference option.
`AlgoOrderOptions`	`setPegType(PegType type)` Enables the peg-type option.
`AlgoOrderOptions`	`setQuickstart(QuickstartSetting qs)` Enables the quickstart option.
`AlgoOrderOptions`	`setRegularSessionOnly()` Enables the regularSessionOnly option.
`AlgoOrderOptions`	`setSaleAffirm()` Enables the sale affirm option.
`AlgoOrderOptions`	`setShortSaleAffirmLongQuantity(int quantity)` Enables the short-sale affirm long-quantity option.
`AlgoOrderOptions`	`setStartTime(java.util.Date time)` Enables the start-time option.
`AlgoOrderOptions`	`setSweepType(SweepType type)` Enables the sweepType option.
`AlgoOrderOptions`	`setTimeInForce(TimeInForce tif)` Enables the time-in-force option.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AlgoOrderOptions
```
public AlgoOrderOptions()
```
    Constructs an instance without any options set.
- Method Detail
  - setTimeInForce
```
public AlgoOrderOptions setTimeInForce(TimeInForce tif)
```
    Enables the time-in-force option. This option determines how long the order will remain live. The default is to stay live for the rest of the day. Certain TIF values may require additional options set.
    
    Parameters:
    tif - Time-in-force setting
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a TIF value not appropriate for an Algo order
  - setExpireTime
```
public AlgoOrderOptions setExpireTime(java.util.Date expire)
```
    Enables the expire-time option. This option must only be set in conjunction with the TimeInForce.GOOD_TILL_DATE TIF option and is required for it. It determines the time when the order should expire.
    
    Parameters:
    expire - expiration time
    
    Returns:
    itself
    See Also:
    TimeInForce.GOOD_TILL_DATE
  - setMaxFloor
```
public AlgoOrderOptions setMaxFloor(int floor)
```
    Enables the max-floor option.
    
    Parameters:
    floor - max floor value
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a negative or zero max-floor
  - setMinQuantity
```
public AlgoOrderOptions setMinQuantity(int qty)
```
    Enables the min-quantity option.
    
    Parameters:
    qty - min-quantity value
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a negative or zero min-quantity
  - setDiscretionOffset
```
public AlgoOrderOptions setDiscretionOffset(int offset)
```
    Enables the discretion offset option.
    
    Parameters:
    offset - discretion offset (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
  - setIWouldPx
```
public AlgoOrderOptions setIWouldPx(int price)
```
    Enables the iWouldPx option. Price at which to trigger market specific behavior.
    
    Parameters:
    price - iWouldPx (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
  - setAggression
```
public AlgoOrderOptions setAggression(int value)
```
    Enables the aggression option. Market specific parameter to control aggression of the strategy.
    
    Parameters:
    value - aggression
    
    Returns:
    itself
  - setStartTime
```
public AlgoOrderOptions setStartTime(java.util.Date time)
```
    Enables the start-time option. Time for the start of strategy execution.
    
    Parameters:
    time - start time
    
    Returns:
    itself
  - setEndTime
```
public AlgoOrderOptions setEndTime(java.util.Date time)
```
    Enables the end-time option. Time for the end of strategy execution.
    
    Parameters:
    time - end time
    
    Returns:
    itself
  - setSaleAffirm
```
public AlgoOrderOptions setSaleAffirm()
```
    Enables the sale affirm option. This option is needed for sale affirmation for DVP accounts.
    
    Returns:
    itself
  - setShortSaleAffirmLongQuantity
```
public AlgoOrderOptions setShortSaleAffirmLongQuantity(int quantity)
```
    Enables the short-sale affirm long-quantity option. This option is required for certain accounts and affirms that the client has the given long position in the security being traded. This option can only be set for orders which are short-sales. The value must be greater than zero.
    
    Parameters:
    quantity - long position being affirmed
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a negative or zero value
    See Also:
    OrderOptions.setSaleAffirm()
  - setInvisible
```
public AlgoOrderOptions setInvisible()
```
    Enables the invisible option. An order with this option set will not be displayed on the market's order book.
    
    Returns:
    itself
  - setPegType
```
public AlgoOrderOptions setPegType(PegType type)
```
    Enables the peg-type option.
    
    Parameters:
    type - peg-type value
    
    Returns:
    itself
  - setPegDifference
```
public AlgoOrderOptions setPegDifference(int difference)
```
    Enables the peg-difference option.
    
    Parameters:
    difference - peg-difference value (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
  - setMinimumTriggerVol
```
public AlgoOrderOptions setMinimumTriggerVol(int mtv)
```
    Enables the minimumTriggerVol option.
    
    Parameters:
    mtv - minimum Trigger Volume
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a Minimum Trigger Volume of zero or less
  - setMinimumTriggerPercent
```
public AlgoOrderOptions setMinimumTriggerPercent(int mtp)
```
    Enables the minimumTriggerPercent option.
    
    Parameters:
    mtp - minimum Trigger Percent (scaled by Client.PERCENT_SCALE)
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a Minimum Trigger Percentage of zero or less
  - setQuickstart
```
public AlgoOrderOptions setQuickstart(QuickstartSetting qs)
```
    Enables the quickstart option.
    
    Parameters:
    qs - quickstart; overrides the strategy quickstart settings -- if set to enable the order will not wait for market data before sending out child orders to the markets, if disable, it will wait to achieve a minimum quorum, none results in strategy's default behavior.
    
    Returns:
    itself
  - setSweepType
```
public AlgoOrderOptions setSweepType(SweepType type)
```
    Enables the sweepType option.
    
    Parameters:
    qs - sweepType; overrides the strategy sweepType settings -- if set to standard, it will override the strategy configured option for a standard sweep. ISO setting will trigger ISO on parent order.
    
    Returns:
    itself
  - setMaxMarketOrderSlippageAmount
```
public AlgoOrderOptions setMaxMarketOrderSlippageAmount(int diff)
```
    Enables the max market order slippage amount option.
    
    Parameters:
    diff - max slippage amount for market orders to diverge from NBBO when LSR receives the order as the market moves away (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
  - setExcludedVenues
```
public AlgoOrderOptions setExcludedVenues(java.lang.String venues)
```
    Enables the excluded Venues option.
    
    Parameters:
    venues - comma separated list of exDestinations for the venues to be excluded for the strategy or sequence of strategies. Whitespace is not allowed.
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting an empty or too large string
  - setRegularSessionOnly
```
public AlgoOrderOptions setRegularSessionOnly()
```
    Enables the regularSessionOnly option. Only in combination with tif = DAY. Means this order will participate in opening auction and regular session only.
    
    Returns:
    itself
  - setClientData1
```
public AlgoOrderOptions setClientData1(java.lang.String clientData)
```
    Enables the client data 1 option. The contents of this option will be echoed on fills.
    
    Parameters:
    clientData - client data 1 value
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting an empty or too large string
  - setClientData2
```
public AlgoOrderOptions setClientData2(java.lang.String clientData)
```
    Enables the client data 2 option. The contents of this option will be echoed on fills.
    
    Parameters:
    clientData - client data 2 value
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting an empty or too large string
  - setClientData3
```
public AlgoOrderOptions setClientData3(java.lang.String clientData)
```
    Enables the client data 3 option. The contents of this option will be echoed on fills.
    
    Parameters:
    clientData - client data 3 value
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting an empty or too large string

Class AlgoOrderOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlgoOrderOptions

Method Detail

setTimeInForce

setExpireTime

setMaxFloor

setMinQuantity

setDiscretionOffset

setIWouldPx

setAggression

setStartTime

setEndTime

setSaleAffirm

setShortSaleAffirmLongQuantity

setInvisible

setPegType

setPegDifference

setMinimumTriggerVol

setMinimumTriggerPercent

setQuickstart

setSweepType

setMaxMarketOrderSlippageAmount

setExcludedVenues

setRegularSessionOnly

setClientData1

setClientData2

setClientData3

Reach Us

General Inquiries

Quant & Algo Traders