UFC - Unified Finance Client/com.ulalax.ufc.infrastructure.yahoo/YahooClient/screener

screener

suspend fun screener(query: ScreenerQuery, sortField: ScreenerSortField = ScreenerSortField.TICKER, sortAsc: Boolean = false, size: Int = 100, offset: Int = 0): ScreenerResult(source)

Searches for stocks using a custom query with the Yahoo Finance Screener API.

Return

ScreenerResult containing matching stocks with their data

Parameters

query

ScreenerQuery containing custom filter conditions

sortField

Field to sort results by (default: ScreenerSortField.TICKER)

sortAsc

Whether to sort in ascending order (default: false)

size

Number of results to return (default: 100, max: 250)

offset

Pagination offset for retrieving additional results (default: 0)

Throws

If the API call fails or returns an error response

suspend fun screener(predefinedId: String, count: Int = 25, sortField: ScreenerSortField? = null, sortAsc: Boolean? = null): ScreenerResult(source)

Searches for stocks using a predefined screener query with the Yahoo Finance Screener API.

Return

ScreenerResult containing matching stocks with their data

Parameters

predefinedId

Predefined screener ID (e.g., "day_gainers", "most_actives")

count

Number of results to return (range: 1-250)

sortField

Custom sort field (if null, uses the predefined screener's default)

sortAsc

Custom sort direction (if null, uses the predefined screener's default)

Throws

If the API call fails or returns an error response

suspend fun screener(predefined: PredefinedScreener, count: Int = 25, sortField: ScreenerSortField? = null, sortAsc: Boolean? = null): ScreenerResult(source)

Searches for stocks using a predefined screener query with the Yahoo Finance Screener API.

Return

ScreenerResult containing matching stocks with their data

Parameters

predefined

PredefinedScreener enum value (e.g., DAY_GAINERS, MOST_ACTIVES)

count

Number of results to return (range: 1-250)

sortField

Custom sort field (if null, uses the predefined screener's default)

sortAsc

Custom sort direction (if null, uses the predefined screener's default)

Throws

If the API call fails or returns an error response