---
title: "Run Scanner (Beta)"
method: POST
path: "/hmds/scanner"
tags: ["Scanner"]
---

# Run Scanner (Beta)

`POST /hmds/scanner`

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

## Request body

- object
  - `instrument` string
  - `locations` string
  - `scanCode` string
  - `secType` string
  - `filters` object[]
    - `code` string
    - `value` boolean — Value can be either an integer, double, boolean or a string depending upon the type of filter specified in the code section

## Response `200`

Valid result

- ScannerResult
  - `total` integer
  - `size` integer
  - `offset` integer
  - `scanTime` string
  - `id` number
  - `position` string
  - `Contracts` object — Contains list of contracts matching the scanner query
    - `Contract` object[]
      - `inScanTime` string
      - `distance` integer
      - `contractID` integer

## Other responses

- `400` — Bad request

---

[API](https://skmtc.dev/interactivebrokers/apis/client-portal-web-api.md) · [All operations](https://skmtc.dev/interactivebrokers/apis/client-portal-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/interactivebrokers/client-portal-web-api/revisions/32edbfe496d1/schema)