Equities Screener API

InputFieldRangeFilter

object

Filters for values within a range or based on a comparison. Supports number, integer, and date data types.

* Additional properties are NOT allowed.
gtAny Of

Greater than.

Variant 1number
gteAny Of

Greater than or equal to.

Variant 1number
ltAny Of

Less than.

Variant 1number
lteAny Of

Less than or equal to.

Variant 1number
Example

InputFieldValueFilter

Exact match (eq) to a single value, or match to any value in a list (in).

Any Of
InputFilterValueAny Of

A single filter value. Supports string, number, integer, boolean, and date (YYYY-MM-DD string) data types. For code-mapped data points, filter on the code.

Variant 1string

InputFilterOptions

Filter applied to a data point. The data type of the value must match the data type of the data point.

One Of
InputFieldValueFilterAny Of

Exact match (eq) to a single value, or match to any value in a list (in).

InputFilterValueAny Of

A single filter value. Supports string, number, integer, boolean, and date (YYYY-MM-DD string) data types. For code-mapped data points, filter on the code.

Variant 1string

InputFilterValue

A single filter value. Supports string, number, integer, boolean, and date (YYYY-MM-DD string) data types. For code-mapped data points, filter on the code.

Any Of

InputPaginationOptions

object

Determines how results are paginated.

* Additional properties are NOT allowed.
pageSizeinteger(int32)

Specifies the maximum number of results per page.

Default:50

>= 1<= 50

Example:10

paginationTokenNextstring | null

Token returned in metadata.paginationTokenNext. Retrieves the next page of results.

Example:CJ2aBBoROg81YmFuYyBzcGxpdCBpbmMaDDoKMHAwMDAwbTJkaiIMOgowUDAwMDBNMkRK

paginationTokenPreviousstring | null

Token returned in metadata.paginationTokenPrevious. Retrieves the previous page of results.

Example:CKDjNhoJKQBIuTktAQAAGg06C2dkZiBzdWV6IHNhGgw6CjBwMDAwMDl3cW8iDDoKMFAwMDAwOVdRTw==

Example