Get Valid IServer Scanner Parameters

GET

/v1/api/iserver/scanner/params

GET

/v1/api/iserver/scanner/params

curl https://localhost:5000/v1/api/iserver/scanner/params \
     -H "Authorization: Bearer <token>"

{
  "scan_type_list": [
    {
      "display_name": "Top % Gainers",
      "code": "TOP_PERC_GAIN",
      "instruments": [
        "STK",
        "ETF.EQ.US",
        "ETF.FI.US",
        "FUT.US",
        "IND.US",
        "STOCK.NA",
        "FUT.NA",
        "SSF.NA",
        "STOCK.EU",
        "FUT.EU",
        "IND.EU",
        "SSF.EU",
        "STOCK.ME",
        "STOCK.HK",
        "FUT.HK",
        "IND.HK",
        "SSF.HK"
      ]
    }
  ],
  "instrument_list": [
    {
      "display_name": "US Stocks",
      "type": "STK",
      "filters": [
        "afterHoursChange",
        "afterHoursChangePerc",
        "avgOptVolume",
        "avgPriceTarget",
        "avgRating"
      ]
    }
  ],
  "filter_list": [
    {
      "group": "afterHoursChangeAbove",
      "display_name": "After-Hours Change Above",
      "code": "afterHoursChangeAbove",
      "type": "non-range"
    },
    {
      "group": "stkTypes",
      "display_name": "Stock type",
      "code": "stkTypes",
      "combo_values": [
        {
          "default": true
        }
      ]
    }
  ],
  "location_tree": [
    {
      "display_name": "US Stocks",
      "type": "STK",
      "locations": [
        {
          "display_name": "Listed/NASDAQ",
          "type": "STK.US.MAJOR",
          "locations": []
        },
        {
          "display_name": "OTCMarkets",
          "type": "STK.US.MINOR",
          "locations": []
        }
      ]
    },
    {
      "display_name": "US Futures",
      "type": "FUT.US",
      "locations": [
        {
          "display_name": "CME",
          "type": "FUT.CME"
        },
        {
          "display_name": "CBOT",
          "type": "FUT.CBOT"
        },
        {
          "display_name": "NYMEX",
          "type": "FUT.NYMEX"
        }
      ]
    }
  ]
}

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

Authentication

AuthorizationBearer

SSO bearer token.

Response

An array of objects detailing contract information.

scan_type_listlist of objectsOptional

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

instrument_listlist of objectsOptional

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

filter_listlist of objectsOptional

location_treelist of objectsOptional

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