Skip to content

Scanners

ibc.rest.scanner.Scanners

Client for managing scanners via the Interactive Brokers API.

__init__(ib_client, ib_session)

Initializes the Scanners client.

Parameters

ib_client : InteractiveBrokersClient The InteractiveBrokersClient Python Client.

InteractiveBrokersSession

The IB session handler.

scanners()

Returns an object contains four lists contain all parameters for scanners.

Returns

dict: A collection of Scanner resources.

Usage
>>> scanners_service = ibc_client.scanners
>>> scanners_service.scanners()

run_scanner(scanner)

Runs scanner to get a list of contracts.

Parameters

scanner : dict A scanner definition that you want to run.

Returns

dict: A collection of contract resources.

Usage
>>> scanners_service = ibc_client.scanners
>>> scanners_service.run_scanner(
    scanner={
        "instrument": "STK",
        "type": "NOT_YET_TRADED_TODAY",
        "filter": [
            {
                "code": "priceAbove",
                "value": 50
            },
            {
                "code": "priceBelow",
                "value": 70
            },
            {
                "code": "volumeAbove",
                "value": None
            },
            {
                "code": "volumeBelow",
                "value": None
            }
        ],
        "location": "STK.US.MAJOR",
        "size": "25"
    }
)