Equities Screener API

List all equity data points.

Returns the list of equity data points supported for screener queries. Metadata for each entry includes the data type, supported operators, and whether the data point is sortable, language-dependent, currency-dependent, fuzzy-searchable, or code-mapped.

get

Response

application/json

OK

ResponseDataPoints

Data points and operators supported for equities screening.

* Additional properties are NOT allowed.
datapointsarray | null[object]

A data point and the screening features it supports.

* Additional properties are NOT allowed.
Show Child Parameters
metadataobject

Request ID and timestamp for use in troubleshooting.

* Additional properties are NOT allowed.
Show Child Parameters
get/direct-web-services/v1/screeners/equities/data-points
 
application/json

ErrorResponseAuthentication

object

A response body returned when authentication fails.

* Additional properties are NOT allowed.
error_messagestringrequired

A human-readable description of the error.

Example:Incorrect username or password

Example

InputDataPoints

array

Lists data points to return. Retrieve valid values programmatically via GET /direct-web-services/v1/screeners/equities/data-points, or browse the full reference in the data dictionary.

<= 100 items

Example

InputFieldContainsFilter

object

Matches string values that contain the specified text.

* Additional properties are NOT allowed.
containsstringrequired

Text to search for.

Example:apple

Example

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