Class ScreenerContext

Screener context

Index

Constructors

Methods

new screenerRecommendStrategies screenerUserStrategies screenerStrategy screenerSearch screenerIndicators

Constructors

constructor

new ScreenerContext(): ScreenerContext
Returns ScreenerContext

Methods

`Static`new

new(config: Config): ScreenerContext
Create a new ScreenerContext
Parameters
- config: Config
Returns ScreenerContext

screenerRecommendStrategies

screenerRecommendStrategies(): Promise<ScreenerRecommendStrategiesResponse>
Get recommended built-in screener strategies

Returns Promise<ScreenerRecommendStrategiesResponse>

screenerUserStrategies

screenerUserStrategies(): Promise<ScreenerUserStrategiesResponse>
Get the current user's saved screener strategies

Returns Promise<ScreenerUserStrategiesResponse>

screenerStrategy

screenerStrategy(id: number): Promise<ScreenerStrategyResponse>
Get detail for one screener strategy by ID
Parameters
- id: number
Returns Promise<ScreenerStrategyResponse>

screenerSearch

screenerSearch(
    market: string,
    strategyId: number | null | undefined,
    page: number,
    size: number,
): Promise<ScreenerSearchResponse>
Search / screen securities using a strategy
Parameters
- market: string
- strategyId: number | null | undefined
- page: number
- size: number
Returns Promise<ScreenerSearchResponse>

screenerIndicators

screenerIndicators(): Promise<ScreenerIndicatorsResponse>
Get all available screener indicator definitions

Returns Promise<ScreenerIndicatorsResponse>