INinteractivebrokers
Scanner

Scanner Run

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

post/iserver/scanner/run

Request

  • Base URL
    http://localhost:5000/v1/api
  • URL
    http://localhost:5000/v1/api/iserver/scanner/run
  • Auth
    none declared

Request body

instrumentstring

Contains an instrument, which to scan for. For example - "STK"

typestring

Specify the scan type to use. For example - "MOST_ACTIVE_USD"

locationstring

Contains location code, where to look for specified instrument. For example - "STK.US.MAJOR"

Response

returns an array

server_idstring
column_namestring
symbolstring

Underlying symbol

conidexstring

conid and exchange. Format supports conid or conid@exchange

con_idnumber
available_chart_periodsstring

List of available chart periods

company_namestring

Contracts company name

contract_description_1string

Format contract name

listing_exchangestring
sec_typestring

Example response

[
  {
    "contract_description_1": "FB Stock (NASDAQ.NMS)"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.