Iserver Scanner Parameters

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

1
GET /iserver/scanner/params

Response Object

scan_type_list: List Array of objects.
Contains all values used as the scanner “type” in the request.
[{
display_name: String.
Human readable name for the scanner “type”

code: String.
Value used for the market scanner request.

instruments: Array of Strings.
Returns all instruments the scanner type can be used with.
}]

instrument_list: Array of Objects.
Contains all values relevant to the scanner “instrument” request field.
[{
display_name: String.
Human readable representation of the instrument type.

type: String.
Value used for the market scanner request.

filters: Array of Strings.
Returns an array of all filters uniquely avaliable to that instrument type.
}]

filter_list: Array of Objects.
[{
group: String.
Returns the group of filters the request is affiliated with.

display_name: String.
Returns the human-readable identifier for the filter.

code: String.
Value used for the market scanner request.

type: String.
Returns the type of value to be used in the request.
This can indicate a range based value, or if it should be a single value.
}]

location_tree: Array of objects.
Contains all values relevant to the location field of the market scanner request.

display_name: String.
Returns the overarching instrument type to designate the location.

type: String.
Returns the code value of the market scanner instrument type value.

locations: Array of objects.
[{
display_name: String.
Returns the human-readable value of the market scanner’s location value.

type: String.
Returns the code value of the market scanner location value.

locations: Array.
Always returns an empty array at this depth.
}]

]

{
  "scan_type_list":[
    {
      "display_name": "display_name",
      "code": "code",
      "instruments": []
    }
  ],
  "instrument_list":[ 
    {
      "display_name": "display_name",
      "type": "type",
      "filters": []
    }
  ],
  "filter_list":[
    {
      "group": "group",
      "display_name": "display_name",
      "code": "code",
      "type": "type"
    }
  ],
  "location_tree":[
    {
      "display_name": "display_name",
      "type": "type",
      "locations": [
        {
          "display_name": "display_name",
          "type": "type",
          "locations": []
        }
      ]
    }
  ]
}