Search Contract Rules
Returns trading related rules for a specific contract and side.
POST /iserver/contract/rules
Request Object
Body Parameters
conid: Number. Required
Contract identifier for the interested contract.
exchange: String.
Designate the exchange you wish to receive information for in relation to the contract.
isBuy: bool.
Side of the market rules apply too. Set to true for Buy Orders, set to false for Sell Orders
Defaults to true or Buy side rules.
modifyOrder: bool.
Used to find trading rules related to an existing order.
orderId: Number. Required for modifyOrder:true
Specify the order identifier used for tracking a given order.
Python
Abap
Response Object
algoEligible: bool.
Indicates if the contract can trade algos or not.
overnightEligible: bool.
Indicates if outsideRTH trading is permitted for the instrument
costReport: bool.
Indicates whether or not a cost report has been requested (Client Portal only).
canTradeAcctIds: Array of Strings.
Indicates permitted accountIDs that may trade the contract.
error: String.
If rules information can not be received for any reason, it will be expressed here.
orderTypes: Array of Strings
Indicates permitted order types for use with standard quantity trading.
ibAlgoTypes: Array of Strings.
Indicates permitted algo types for use with the given contract.
fraqTypes: Array of Strings.
Indicates permitted order types for use with fractional trading.
forceOrderPreview: bool.
Indicates if the order preview is forced upon the user before submission.
cqtTypes: Array of Strings.
Indicates accepted order types for use with cash quantity.
orderDefaults: Object of objects
Indicates default order type for the given security type.
orderTypesOutside: Array of Strings.
Indicates permitted order types for use outside of regular trading hours.
defaultSize: int.
Default total quantity value for orders.
cashSize: float.
Default cash value quantity.
sizeIncrement: int.
Indicates quantity increase for the contract.
tifTypes: Array of Strings.
Indicates allowed tif types supported for the contract.
tifDefaults: Object.
Object containing details about your TIF value defaults.
These defaults can be viewed and modified in TWS’s within the Global Configuration.
limitPrice: float.
Default limit price for the given contract.
stopprice: float.
Default stop price for the given contract.
orderOrigination: String.
Order origin designation for US securities options and Options Clearing Corporation
preview: bool.
Indicates if the order preview is required (for client portal only)
displaySize: int.
fraqInt: int.
Indicates decimal places for fractional order size
cashCcy: String.
Indicates base currency for the instrument.
cashQtyIncr: int.
Indicates cash quantity increment rules.
priceMagnifier: int.
Signifies if a contract is not trading in the standard cash denomination.
If a symbol is priced in Cents, Pence, or the currency’s fractional equivalent, the relative value will be displayed. For standard instruments, Null will be passed.
negativeCapable: bool.
Indicates if the value of the contract can be negative (true) or if it is always positive (false).
incrementType: int.
Indicates the type of increment style.
incrementRules: Array of objects.
Indicates increment rule values including lowerEdge and increment value.
hasSecondary: bool.
modTypes: Array of Strings.
Lists the available order types supported when modifying the order.
increment: float.
Minimum increment values for prices
incrementDigits: int.
Number of decimal places to indicate the increment value.