---
title: "Get Valid IServer Scanner Parameters"
method: GET
path: "/iserver/scanner/params"
tags: ["tradingScanner"]
---

# Get Valid IServer Scanner Parameters

`GET /iserver/scanner/params`

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

## Response `200`

An array of objects detailing contract information.

- IserverScannerParams
  - `scan_type_list` IserverScannerParamsScanTypeListItems[] — 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` unknown[] — Returns all instruments the scanner type can be used with.
      - unknown
  - `instrument_list` IserverScannerParamsInstrumentListItems[] — 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` unknown[] — Returns an array of all filters uniquely avaliable to that instrument type.
      - unknown
  - `filter_list` IserverScannerParamsFilterListItems[]
    - `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.
    - `combo_values` IserverScannerParamsFilterListItemsComboValuesItems[] — combo values when type equals to combo
      - `default` boolean
      - `vendor` IserverScannerParamsFilterListItemsComboValuesItemsVendor
  - `location_tree` IserverScannerParamsLocationTreeItems[] — 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` IserverScannerParamsLocationTreeItemsLocationsItems[]
      - `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` IserverScannerParamsLocationTreeItemsLocationsItemsLocationsItems[]
        - `display_name` string
        - `type` string

## Other responses

- `401` — Missing, invalid, or unparseable Authorization token.
- `500` — internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests. For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.
- `503` — service is unavailable. For example if request takes more than 10s due to some internal service unavailability, request aborted and this status returned

---

[API](https://skmtc.net/interactivebrokers/apis/api-reference.md) · [All operations](https://skmtc.net/interactivebrokers/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactivebrokers/api-reference/revisions/67f9f562c2c6/schema)