ScannerSubscription

View as MarkdownOpen in Claude

ScannerSubscription

FieldTypeDescription
numberOfRowsint32Determine the number of rows or results from the market scanner to be returned. Returns the maximum, 50, by default.
instrumentstringReturns the Instrument type to be returned. See scannerParameters xml response for details.
locationCodestringReturns the exchange regions to be returned. See scannerParameters xml response for details.
scanCodestringReturns the code to sort results by. See scannerParameters xml response for details.
abovePricedoubleSet the maximum MARK price to filter by.
belowPricedoubleSet the minimum MARK price to filter by.
aboveVolumeint64Set the minimum trade volume of the day.
marketCapAbovedoubleSet the minimum market cap restriction.
marketCapBelowdoubleSet the maximum market cap restriction.
moodyRatingAbovestringMinimum Moody Rating
moodyRatingBelowstringMaximum Moody Rating
spRatingAbovestringStandard & Poor’s (S&P) uses a letter-based rating system to evaluate the creditworthiness of bonds and debt issuers. This field will indicate the lowest acceptable rating to be returned from the result.
spRatingBelowstringStandard & Poor’s (S&P) uses a letter-based rating system to evaluate the creditworthiness of bonds and debt issuers. This field will indicate the highest acceptable rating to be returned from the result.
maturityDateAbovestringSet the minimum Maturity date. Formatted as YYYYMMDD.
maturityDateBelowstringSet the maximum Maturity date. Formatted as YYYYMMDD.
couponRateAbovedoubleSet the minimum Coupon Rate
couponRateBelowdoubleSet the maximum Coupon Rate
excludeConvertibleboolDetermine of the bond should be convertible or not.
averageOptionVolumeAboveint64Determine the minimum average option volume from the underlying.
scannerSettingPairsstringTagValue pair to indicate scanner restrictions. Currently only supports TagValue(“annualVolatility”, true) or an empty list.
stockTypeFilterstringDetermine the stock type: Common, CORP, ADR, ETF, ETN, REIT, CEF, ETMF, EFN
scannerSubscriptionFilterOptionsScannerSubscriptionFilterOptionsEntry
scannerSubscriptionOptionsScannerSubscriptionOptionsEntry

ScannerSubscription.ScannerSubscriptionFilterOptionsEntry

FieldTypeDescription
keystring
valuestring

ScannerSubscription.ScannerSubscriptionOptionsEntry

FieldTypeDescription
keystring
valuestring