INinteractivebrokers
Scanner

Run Scanner (Beta)

Using a direct connection to the market data farm, will provide results to the requested scanner.

post/hmds/scanner

Request

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

Request body

instrumentstring
locationsstring
scanCodestring
secTypestring

Example request

{
  "instrument": "BOND.GOVT",
  "locations": "BOND.GOVT.US",
  "scanCode": "FAR_MATURITY_DATE",
  "secType": "BOND",
  "filters": [
    {
      "code": "bondValidNetBidOrAskOnly",
      "value": true
    }
  ]
}

Response

Valid result

totalinteger
sizeinteger
offsetinteger
scanTimestring
idnumber
positionstring

Changes

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