UFC - Unified Finance Client/com.ulalax.ufc.api/Ufc/screener

screener

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

Screens stocks using a custom query with filtering criteria.

This method allows you to build complex queries to filter stocks based on fundamental metrics like market cap, P/E ratio, sector, dividend yield, etc.

Return

Screener results matching the query criteria

Parameters

query

Custom screener query built using ScreenerQuery operators

sortField

Field to sort results by (default: TICKER)

sortAsc

Sort in ascending order if true, descending if false (default: false)

size

Maximum number of results to return (default: 100)

offset

Number of results to skip for pagination (default: 0)

Throws

if the query is invalid or the request fails

Samples

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

Screens stocks using a predefined screener ID.

This method uses Yahoo Finance's predefined screener IDs for common screening strategies.

Return

Screener results for the predefined screen

Parameters

predefinedId

The predefined screener ID string

count

Maximum number of results to return (default: 25)

sortField

Optional field to sort results by

sortAsc

Optional sort order (true for ascending, false for descending)

Throws

if the screener ID is invalid or the request fails

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

Screens stocks using a predefined screener enum.

This method provides convenient access to Yahoo Finance's predefined screeners such as day gainers, day losers, most active, etc.

Return

Screener results for the predefined screen

Parameters

predefined

The predefined screener enum (e.g., DAY_GAINERS, DAY_LOSERS, MOST_ACTIVE)

count

Maximum number of results to return (default: 25)

sortField

Optional field to sort results by

sortAsc

Optional sort order (true for ascending, false for descending)

Throws

if the request fails

Samples