|
|
This documentation is now deprecated. Please switch to the IBKR Campus for up-to-date information regarding IBKR's API solutions. |
Defines a market scanner request. More...
Properties | |
int | NumberOfRows [get, set] |
The number of rows to be returned for the query. | |
string | Instrument = -1 [get, set] |
The instrument's type for the scan. I.e. STK, FUT.HK, etc. | |
string | LocationCode [get, set] |
The request's location (STK.US, STK.US.MAJOR, etc). | |
string | ScanCode [get, set] |
Same as TWS Market Scanner's "parameters" field, for example: TOP_PERC_GAIN. | |
double | AbovePrice [get, set] |
Filters out Contracts which price is below this value. | |
double | BelowPrice = double.MaxValue [get, set] |
Filters out contracts which price is above this value. | |
int | AboveVolume = double.MaxValue [get, set] |
Filters out Contracts which volume is above this value. | |
int | AverageOptionVolumeAbove = int.MaxValue [get, set] |
Filters out Contracts which option volume is above this value. | |
double | MarketCapAbove = int.MaxValue [get, set] |
Filters out Contracts which market cap is above this value. | |
double | MarketCapBelow = double.MaxValue [get, set] |
Filters out Contracts which market cap is below this value. | |
string | MoodyRatingAbove = double.MaxValue [get, set] |
Filters out Contracts which Moody's rating is below this value. | |
string | MoodyRatingBelow [get, set] |
Filters out Contracts which Moody's rating is above this value. | |
string | SpRatingAbove [get, set] |
Filters out Contracts with a S&P rating below this value. | |
string | SpRatingBelow [get, set] |
Filters out Contracts with a S&P rating above this value. | |
string | MaturityDateAbove [get, set] |
Filter out Contracts with a maturity date earlier than this value. | |
string | MaturityDateBelow [get, set] |
Filter out Contracts with a maturity date older than this value. | |
double | CouponRateAbove [get, set] |
Filter out Contracts with a coupon rate lower than this value. | |
double | CouponRateBelow = double.MaxValue [get, set] |
Filter out Contracts with a coupon rate higher than this value. | |
bool | ExcludeConvertible = double.MaxValue [get, set] |
Filters out Convertible bonds. | |
string | ScannerSettingPairs [get, set] |
For example, a pairing "Annual, true" used on the "top Option Implied Vol % Gainers" scan would return annualized volatilities. | |
string | StockTypeFilter [get, set] |
| |
Defines a market scanner request.