Search Contract Rules

POST

/iserver/contract/rules

POST

/iserver/contract/rules

$ curl -X POST https://api.ibkr.com/iserver/contract/rules \
>      -H "Content-Type: application/json" \
>      -d '{
>   "conid": 1
> }'

1 {
2   "algoEligible": true,
3   "allOrNoneEligible": true,
4   "costReport": false,
5   "canTradeAcctIds": [
6     "U1234567",
7     "U1234568",
8     "U1234569"
9   ],
10   "error": null,
11   "orderTypes": [
12     "limit",
13     "midprice",
14     "market",
15     "stop",
16     "stop_limit",
17     "mit",
18     "lit",
19     "trailing_stop",
20     "trailing_stop_limit",
21     "relative",
22     "marketonclose",
23     "limitonclose"
24   ],
25   "ibAlgoTypes": [
26     "limit",
27     "stop_limit",
28     "lit",
29     "trailing_stop_limit",
30     "relative",
31     "marketonclose",
32     "limitonclose"
33   ],
34   "fraqTypes": [
35     "limit",
36     "market",
37     "stop",
38     "stop_limit",
39     "mit",
40     "lit",
41     "trailing_stop",
42     "trailing_stop_limit"
43   ],
44   "forceOrderPreview": false,
45   "cqtTypes": [
46     "limit",
47     "market",
48     "stop",
49     "stop_limit",
50     "mit",
51     "lit",
52     "trailing_stop",
53     "trailing_stop_limit"
54   ],
55   "orderDefaults": {
56     "LMT": {
57       "LP": "198.22"
58     }
59   },
60   "orderTypesOutside": [
61     "limit",
62     "stop_limit",
63     "lit",
64     "trailing_stop_limit",
65     "relative"
66   ],
67   "defaultSize": 100,
68   "cashSize": 0,
69   "sizeIncrement": 100,
70   "tifTypes": [
71     "IOC/MARKET,LIMIT,RELATIVE,MARKETONCLOSE,MIDPRICE,LIMITONCLOSE,MKT_PROTECT,STPPRT,a",
72     "GTC/o,a",
73     "OPG/LIMIT,MARKET,a",
74     "GTD/o,a",
75     "DAY/o,a"
76   ],
77   "tifDefaults": {
78     "TIF": "DAY",
79     "SIZE": "100.00",
80     "DEFAULT_ACCT": "U1234567",
81     "PMALGO": true
82   },
83   "limitPrice": 198.22,
84   "orderOrigination": null,
85   "preview": true,
86   "displaySize": null,
87   "fraqInt": 4,
88   "cashCcy": "USD",
89   "cashQtyIncr": 500,
90   "priceMagnifier": null,
91   "negativeCapable": false,
92   "incrementType": 1,
93   "incrementRules": [
94     {
95       "lowerEdge": 0,
96       "increment": 1
97     }
98   ],
99   "hasSecondary": true,
100   "increment": 0.01,
101   "incrementDigits": 2,
102   "stopprice": 198.22
103 }

Returns trading related rules for a specific contract and side.

Request

This endpoint expects an object.

conidlongRequired

Contract identifier for the interested contract.

isBuybooleanOptionalDefaults to true

Side of the market rules apply too. Set to true for Buy Orders, set to false for Sell orders.

modifyOrderbooleanOptionalDefaults to false

Used to find trading rules related to an existing order.

orderIdlongOptional

Specify the order identifier used for tracking a given order.

Response

An array of objects detailing contract information.

algoEligibleboolean

Indicates if the contract can trade algos or not.

allOrNoneEligibleboolean

indicates all or non option is eligible for given contract.

costReportboolean

Indicates whether or not a cost report has been requested (Client Portal only).

canTradeAcctIdslist of strings

Indicates permitted accountIDs that may trade the contract.

errorstring or null

If rules information can not be received for any reason, it will be expressed here.

orderTypeslist of enums

Indicates permitted order types for use with standard quantity trading.

ibAlgoTypeslist of enums

Indicates permitted algo types for use with the given contract.

fraqTypeslist of enums

Indicates permitted order types for use with fractional trading.

forceOrderPreviewboolean

Indicates if the order preview is forced upon the user before submission.

cqtTypeslist of enums

Indicates accepted order types for use with cash quantity.

orderDefaultsobject

Indicates default order type for the given security type.

orderTypesOutsidelist of enums

Indicates permitted order types for use outside of regular trading hours.

defaultSizelong

Default total quantity value for orders.

cashSizelong

Default cash value quantity.

sizeIncrementlong

Indicates quantity increase for the contract.

tifTypeslist of strings

Indicates allowed tif types supported for the contract.

tifDefaultsobject

Object containing details about your TIF value defaults. These defaults can be viewed and modified in TWS's within the Global Configuration.

limitPricedouble

Default limit price for the given contract.

stopPricedouble

Default stop price for the given contract.

orderOriginationstring or null

Order origin designation for US securities options and Options Clearing Corporation

previewboolean

Indicates if the order preview is required (for client portal only)

displaySizelong or null

Standard display increment rule for the instrument.

fraqIntlong

Indicates decimal places for fractional order size.

cashCcystring

Indicates base currency for the instrument.

cashQtyIncrlong

Indicates cash quantity increment rules.

priceMagnifierlong or null

Signifies the magnifier of a given contract. This is separate from the price multiplier, and will typically return 'null'

negativeCapableboolean

Indicates if the value of the contract can be negative (true) or if it is always positive (false).

incrementTypelong

Indicates the type of increment style.

incrementRuleslist of objects

Indicates increment rule values including lowerEdge and increment value.

hasSecondaryboolean

modTypeslist of any

Lists the available order types supported when modifying the order.

incrementdouble

Minimum increment values for prices

incrementDigitslong

Number of decimal places to indicate the increment value.

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error