> This page is for TWS API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://interactivebrokers.com/docs/llms.txt.

# IBKRATS Order Types

Customers can direct non-marketable U.S. stock orders to the IBKRATS destination to add liquidity. Orders directed to IBKRATS are tagged as "not held" orders, and are posted in IBKR's order book where incoming SmartRouted orders from other IBKR customers are eligible to take liquidity by trading against them.\
To route an order to IBKRATS via the API, you need to set the `Contract.Exchange` field to "IBKRATS" and `Order.NotHeld` to True.

More on [IBKRATS Orders](https://www.interactivebrokers.com/en/index.php?f=4485)

Note: The order must have the NotHeld field set to True, or you may receive a rejection with the reason; "IBKRAts order must be a not-held". When submitting via the TWS UI, this is set automatically.

## Pegged-to-Best

#### Python

```python
order = Order()
order.action = action
order.orderType = "PEG BEST"
order.lmtPrice = limitPrice
order.totalQuantity = quantity
order.notHeld = True
order.minCompeteSize = minCompeteSize
order.competeAgainstBestOffset = competeAgainstBestOffset
```

#### Java

```java
Order order = new Order();
order.action(action);
order.orderType("PEG BEST");
order.lmtPrice(limitPrice);
order.totalQuantity(quantity);
order.notHeld(true);
order.minCompeteSize(minCompeteSize);
order.competeAgainstBestOffset(competeAgainstBestOffset);
```

#### C++

```cpp
Order order;
order.action = action;
order.orderType = "PEG BEST";
order.lmtPrice = limitPrice;
order.totalQuantity = quantity;
order.notHeld = true;
order.minCompeteSize = minCompeteSize;
order.competeAgainstBestOffset = competeAgainstBestOffset;
```

#### C\#

```csharp
Order order = new Order();
order.Action = action;
order.OrderType = "PEG BEST";
order.LmtPrice = limitPrice;
order.TotalQuantity = quantity;
order.NotHeld = true;
order.MinCompeteSize = minCompeteSize;
order.CompeteAgainstBestOffset = competeAgainstBestOffset;
```

#### VB.NET

```vbnet
Dim order As Order = New Order
order.Action = action
order.OrderType = "PEG BEST"
order.LmtPrice = limitPrice
order.TotalQuantity = quantity
order.NotHeld = True
order.MinCompeteSize = minCompeteSize
order.CompeteAgainstBestOffset = competeAgainstBestOffset
```

## Pegged-to-Midpoint

#### Python

```python
order = Order()
order.action = action
order.orderType = "PEG MID"
order.lmtPrice = limitPrice
order.totalQuantity = quantity
order.notHeld = True
order.minTradeQty = minTradeQty
order.midOffsetAtWhole = midOffsetAtWhole
order.midOffsetAtHalf = midOffsetAtHalf
```

#### Java

```java
Order order = new Order();
order.action(action);
order.orderType("PEG MID");
order.lmtPrice(limitPrice);
order.totalQuantity(quantity);
order.notHeld(true);
order.minTradeQty(minTradeQty);
order.midOffsetAtWhole(midOffsetAtWhole);
order.midOffsetAtHalf(midOffsetAtHalf);
```

#### C++

```cpp
Order order;
order.action = action;
order.orderType = "PEG MID";
order.lmtPrice = limitPrice;
order.totalQuantity = quantity;
order.notHeld = true;
order.minTradeQty = minTradeQty;
order.midOffsetAtWhole = midOffsetAtWhole;
order.midOffsetAtHalf = midOffsetAtHalf;
```

#### C\#

```csharp
Order order = new Order();
order.Action = action;
order.OrderType = "PEG MID";
order.LmtPrice = limitPrice;
order.TotalQuantity = quantity;
order.NotHeld = true;
order.MinTradeQty = minTradeQty;
order.MidOffsetAtWhole = midOffsetAtWhole;
order.MidOffsetAtHalf = midOffsetAtHalf;
```

#### VB.NET

```vbnet
Dim order As Order = New Order
order.Action = action
order.OrderType = "PEG MID"
order.LmtPrice = limitPrice
order.TotalQuantity = quantity
order.NotHeld = True
order.MinTradeQty = minTradeQty
order.MidOffsetAtWhole = midOffsetAtWhole
order.MidOffsetAtHalf = midOffsetAtHalf
```

## Pegged-to-Best Offset Difference

#### Python

```python
order = Order()
order.action = action
order.orderType = "PEG BEST"
order.lmtPrice = limitPrice
order.totalQuantity = quantity
order.notHeld = True
order.minCompeteSize = minCompeteSize
order.competeAgainstBestOffset = COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID
order.midOffsetAtWhole = midOffsetAtWhole
order.midOffsetAtHalf = midOffsetAtHalf
```

#### Java

```java
Order order = new Order();
order.action(action);
order.orderType("PEG BEST");
order.lmtPrice(limitPrice);
order.totalQuantity(quantity);
order.notHeld(true);
order.minCompeteSize(minCompeteSize);
order.competeAgainstBestOffset(Order.COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID);
order.midOffsetAtWhole(midOffsetAtWhole);
order.midOffsetAtHalf(midOffsetAtHalf);
```

#### C++

```cpp
Order order;
order.action = action;
order.orderType = "PEG BEST";
order.lmtPrice = limitPrice;
order.totalQuantity = quantity;
order.notHeld = true;
order.minCompeteSize = minCompeteSize;
order.competeAgainstBestOffset = COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID;
order.midOffsetAtWhole = midOffsetAtWhole;
order.midOffsetAtHalf = midOffsetAtHalf;
```

#### C\#

```csharp
Order order = new Order();
order.Action = action;
order.OrderType = "PEG BEST";
order.LmtPrice = limitPrice;
order.TotalQuantity = quantity;
order.NotHeld = true;
order.MinCompeteSize = minCompeteSize;
order.CompeteAgainstBestOffset = Order.COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID;
order.MidOffsetAtWhole = midOffsetAtWhole;
order.MidOffsetAtHalf = midOffsetAtHalf;
```

#### VB.NET

```vbnet
Dim order As Order = New Order
order.Action = action
order.OrderType = "PEG BEST"
order.LmtPrice = limitPrice
order.TotalQuantity = quantity
order.NotHeld = True
order.MinCompeteSize = minCompeteSize
order.CompeteAgainstBestOffset = Order.COMPETE_AGAINST_BEST_OFFSET_UP_TO_MID
order.MidOffsetAtWhole = midOffsetAtWhole
order.MidOffsetAtHalf = midOffsetAtHalf
```