Thanks to visit codestin.com
Credit goes to longbridge.github.io

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(
market: string,
): Promise<ScreenerRecommendStrategiesResponse>
Get recommended built-in screener strategies
Parameters
- market: string
Returns Promise<ScreenerRecommendStrategiesResponse>

screenerUserStrategies

screenerUserStrategies(market: string): Promise<ScreenerUserStrategiesResponse>
Get the current user's saved screener strategies
Parameters
- market: string
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,
    conditions: ScreenerCondition[],
    show: string[],
    page: number,
    size: number,
): Promise<ScreenerSearchResponse>
Search / screen securities using a strategy or custom conditions.

When strategyId is given (Mode A), the strategy is fetched from the AI endpoint and its filters drive the search. The market is taken from the strategy response.

When strategyId is null / undefined (Mode B), conditions must be ScreenerCondition objects and market is used directly.

filter_ is stripped from every items[].indicators[].key in the response before it is returned.
Parameters
- market: string
- strategyId: number | null | undefined
- conditions: ScreenerCondition[]
- show: string[]
- page: number
- size: number
Returns Promise<ScreenerSearchResponse>

screenerIndicators

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

Returns Promise<ScreenerIndicatorsResponse>