Run An IServer Market Scanner

POST

/iserver/scanner/run

POST

/iserver/scanner/run

$ curl -X POST https://api.ibkr.com/iserver/scanner/run \
>      -H "Content-Type: application/json"

1 {
2   "contracts": [
3     {
4       "server_id": "0",
5       "column_name": "Trades",
6       "symbol": "TSLA",
7       "conidex": "76792991",
8       "con_id": 76792991,
9       "available_chart_periods": "#R|1",
10       "company_name": "TESLA INC",
11       "contract_description_1": "TSLA",
12       "listing_exchange": "NASDAQ.NMS",
13       "sec_type": "STK",
14       "scan_data": "221.521K"
15     },
16     {
17       "server_id": "1",
18       "symbol": "SPY",
19       "conidex": "756733",
20       "con_id": 756733,
21       "available_chart_periods": "#R|1",
22       "company_name": "SPDR S&P 500 ETF TRUST",
23       "contract_description_1": "SPY",
24       "listing_exchange": "ARCA",
25       "sec_type": "STK",
26       "scan_data": "123.661K"
27     }
28   ],
29   "scan_data_column_name": "Trades"
30 }

Searches for contracts according to the filters specified in /iserver/scanner/params endpoint.

Request

This endpoint expects an object.

instrumentstringOptional

Instrument type as the target of the market scanner request. Found in the “instrument_list” section of the /iserver/scanner/params response.

typestringOptional

Scanner value the market scanner is sorted by. Based on the “scan_type_list” section of the /iserver/scanner/params response.

locationstringOptional

Location value the market scanner is searching through. Based on the “location_tree” section of the /iserver/scanner/params response.

filterlist of objectsOptional

Contains any additional filters that should apply to response.

Response

An array of objects detailing contract information.

contractslist of objects

Contains contracts related to the market scanner request.

scan_data_column_namestring

Internal Use Only

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error