Get Valid IServer Scanner Parameters

GET

/iserver/scanner/params

GET

/iserver/scanner/params

$ curl https://api.ibkr.com/iserver/scanner/params

1 {
2   "scan_type_list": [
3     {
4       "display_name": "Top % Gainers",
5       "code": "TOP_PERC_GAIN",
6       "instruments": [
7         "STK",
8         "ETF.EQ.US",
9         "ETF.FI.US",
10         "FUT.US",
11         "IND.US",
12         "STOCK.NA",
13         "FUT.NA",
14         "SSF.NA",
15         "STOCK.EU",
16         "FUT.EU",
17         "IND.EU",
18         "SSF.EU",
19         "STOCK.ME",
20         "STOCK.HK",
21         "FUT.HK",
22         "IND.HK",
23         "SSF.HK"
24       ]
25     }
26   ],
27   "instrument_list": [
28     {
29       "display_name": "US Stocks",
30       "type": "STK",
31       "filters": [
32         "afterHoursChange",
33         "afterHoursChangePerc",
34         "avgOptVolume",
35         "avgPriceTarget",
36         "avgRating"
37       ]
38     }
39   ],
40   "filter_list": [
41     {
42       "group": "afterHoursChangeAbove",
43       "display_name": "After-Hours Change Above",
44       "code": "afterHoursChangeAbove",
45       "type": "non-range"
46     },
47     {
48       "group": "stkTypes",
49       "display_name": "Stock type",
50       "code": "stkTypes",
51       "combo_values": [
52         {
53           "default": true
54         }
55       ]
56     }
57   ],
58   "location_tree": [
59     {
60       "display_name": "US Stocks",
61       "type": "STK",
62       "locations": [
63         {
64           "display_name": "Listed/NASDAQ",
65           "type": "STK.US.MAJOR",
66           "locations": []
67         },
68         {
69           "display_name": "OTCMarkets",
70           "type": "STK.US.MINOR",
71           "locations": []
72         }
73       ]
74     },
75     {
76       "display_name": "US Futures",
77       "type": "FUT.US",
78       "locations": [
79         {
80           "display_name": "CME",
81           "type": "FUT.CME"
82         },
83         {
84           "display_name": "CBOT",
85           "type": "FUT.CBOT"
86         },
87         {
88           "display_name": "NYMEX",
89           "type": "FUT.NYMEX"
90         }
91       ]
92     }
93   ]
94 }

Returns an xml file containing all available parameters to be sent for the Iserver scanner request.

Response

An array of objects detailing contract information.

scan_type_listlist of objects

Contains all values used as the scanner "type" in the request.

instrument_listlist of objects

Contains all values relevant to the scanner "instrument" request field.

filter_listlist of objects

location_treelist of objects

Contains all values relevant to the location field of the market scanner request.

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error