Skip to content

ScannerApi.md

Latest commit

 

History

History
214 lines (139 loc) · 6.4 KB

ScannerApi.md

File metadata and controls

214 lines (139 loc) · 6.4 KB
Raw

ibkr_web_api.ScannerApi

All URIs are relative to http://localhost:5000/v1/api

Method HTTP request Description
hmds_scanner_post POST /hmds/scanner Run Scanner (Beta)
iserver_scanner_params_get GET /iserver/scanner/params Scanner Parameters
iserver_scanner_run_post POST /iserver/scanner/run Scanner Run

hmds_scanner_post

ScannerResult hmds_scanner_post(body)

Run Scanner (Beta)

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

Example

import ibkr_web_api
from ibkr_web_api.models.hmds_scanner_post_request import HmdsScannerPostRequest
from ibkr_web_api.models.scanner_result import ScannerResult
from ibkr_web_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5000/v1/api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibkr_web_api.Configuration(
    host = "http://localhost:5000/v1/api"
)


# Enter a context with an instance of the API client
with ibkr_web_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibkr_web_api.ScannerApi(api_client)
    body = ibkr_web_api.HmdsScannerPostRequest() # HmdsScannerPostRequest | request body

    try:
        # Run Scanner (Beta)
        api_response = api_instance.hmds_scanner_post(body)
        print("The response of ScannerApi->hmds_scanner_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScannerApi->hmds_scanner_post: %s\n" % e)

Parameters

Name Type Description Notes
body HmdsScannerPostRequest request body

Return type

ScannerResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 Bad request -
200 Valid result -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_scanner_params_get

IserverScannerParamsGet200Response iserver_scanner_params_get()

Scanner Parameters

Returns an object contains four lists contain all parameters for scanners

Example

import ibkr_web_api
from ibkr_web_api.models.iserver_scanner_params_get200_response import IserverScannerParamsGet200Response
from ibkr_web_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5000/v1/api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibkr_web_api.Configuration(
    host = "http://localhost:5000/v1/api"
)


# Enter a context with an instance of the API client
with ibkr_web_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibkr_web_api.ScannerApi(api_client)

    try:
        # Scanner Parameters
        api_response = api_instance.iserver_scanner_params_get()
        print("The response of ScannerApi->iserver_scanner_params_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScannerApi->iserver_scanner_params_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

IserverScannerParamsGet200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An object contains lists -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_scanner_run_post

List[IserverScannerRunPost200ResponseInner] iserver_scanner_run_post(body)

Scanner Run

Searches for contracts according to the filters specified in scanner/params endpoint

Example

import ibkr_web_api
from ibkr_web_api.models.iserver_scanner_run_post200_response_inner import IserverScannerRunPost200ResponseInner
from ibkr_web_api.models.scanner_params import ScannerParams
from ibkr_web_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5000/v1/api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibkr_web_api.Configuration(
    host = "http://localhost:5000/v1/api"
)


# Enter a context with an instance of the API client
with ibkr_web_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibkr_web_api.ScannerApi(api_client)
    body = ibkr_web_api.ScannerParams() # ScannerParams | scanner-params request

    try:
        # Scanner Run
        api_response = api_instance.iserver_scanner_run_post(body)
        print("The response of ScannerApi->iserver_scanner_run_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ScannerApi->iserver_scanner_run_post: %s\n" % e)

Parameters

Name Type Description Notes
body ScannerParams scanner-params request

Return type

List[IserverScannerRunPost200ResponseInner]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 returns an array -

[Back to top] [Back to API list] [Back to Model list] [Back to README]