Search Algos For An Instrument

GET

/iserver/contract/:conid/algos

GET

/v1/api/iserver/contract/:conid/algos

$ curl https://api.ibkr.com/v1/api/iserver/contract/conid/algos

1 {
2   "algos": [
3     {
4       "name": "Adaptive",
5       "id": "Adaptive"
6     },
7     {
8       "name": "Arrival Price",
9       "id": "ArrivalPx"
10     },
11     {
12       "name": "Close Price",
13       "id": "ClosePx"
14     },
15     {
16       "name": "DarkIce",
17       "id": "DarkIce"
18     },
19     {
20       "name": "Percentage of Volume",
21       "id": "PctVol"
22     },
23     {
24       "name": "Price Variant Percentage of Volume",
25       "id": "PctVolPx"
26     },
27     {
28       "name": "Size Variant Percentage of Volume",
29       "id": "PctVolSz"
30     },
31     {
32       "name": "TWAP",
33       "id": "Twap"
34     },
35     {
36       "name": "Time Variant Percentage of Volume",
37       "id": "PctVolTm"
38     },
39     {
40       "name": "VWAP",
41       "id": "Vwap"
42     }
43   ]
44 }

Returns supported IB Algos for an instrument. A pre-flight request must be submitted before retrieving information.

Path parameters

conidstringRequired

Query parameters

algosenumOptional

List of algo ids delimited by ”;” to filter by. Max of 8 algos ids can be specified. Case sensitive to algo id.

Allowed values:

addDescriptionenumOptionalDefaults to 0

Whether or not to add algo descriptions to response. Set to 1 for yes, 0 for no.

Allowed values:

addParamsenumOptionalDefaults to 0

Whether or not to show algo parameters. Set to 1 for yes, 0 for no.

Allowed values:

Response

Returns a list of available algos and a description of their behavior.

algoslist of objects

Contains all relevant algos for the contract.

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error