latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingContracts

Search Contract Rules

Returns trading related rules for a specific contract and side.

post/iserver/contract/rules

Request body

conidinteger required

Contract identifier for the interested contract.

isBuyboolean

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

modifyOrderboolean

Used to find trading rules related to an existing order.

orderIdinteger

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).

canTradeAcctIdsstring[]

Indicates permitted accountIDs that may trade the contract.

errorstring nullable

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

orderTypesContractRulesOrderTypesItems[]

Indicates permitted order types for use with standard quantity trading.

ibAlgoTypesContractRulesIbAlgoTypesItems[]

Indicates permitted algo types for use with the given contract.

fraqTypesContractRulesFraqTypesItems[]

Indicates permitted order types for use with fractional trading.

forceOrderPreviewboolean

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

cqtTypesContractRulesCqtTypesItems[]

Indicates accepted order types for use with cash quantity.

orderTypesOutsideContractRulesOrderTypesOutsideItems[]

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

defaultSizeinteger

Default total quantity value for orders.

cashSizeinteger

Default cash value quantity.

sizeIncrementinteger

Indicates quantity increase for the contract.

tifTypesstring[]

Indicates allowed tif types supported for the contract.

limitPricenumber double

Default limit price for the given contract.

stopPricenumber double

Default stop price for the given contract.

orderOriginationstring nullable

Order origin designation for US securities options and Options Clearing Corporation

previewboolean

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

displaySizeinteger nullable

Standard display increment rule for the instrument.

fraqIntinteger

Indicates decimal places for fractional order size.

cashCcystring

Indicates base currency for the instrument.

cashQtyIncrinteger

Indicates cash quantity increment rules.

priceMagnifierinteger nullable

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).

incrementTypeinteger

Indicates the type of increment style.

hasSecondaryboolean
incrementnumber double

Minimum increment values for prices

incrementDigitsinteger

Number of decimal places to indicate the increment value.