Equities Screener API

InputQueryOptions

object

Filters investments using dataPoint: filter conditions or compound logic. Keys are data point names; values are filters. For example:

  • Equals: { "shareClassInformation.symbol": "MSES" }
  • In: { "shareClassInformation.symbol": ["MSES", "CA40"] }
  • Range: { "marketCapital.asOfDate": { "gt": "2020-01-01", "lt": "2024-01-01" } }
  • Contains: { "companyInformation.legalName": { "contains": "apple" } }
  • Fuzzy: { "shareClassInformation.investmentName": "aople inc", "fuzzy": true }
  • Compound: { "and": [ { "dataPoint1": "value1" }, { "dataPoint2": "value2" } ] }
  • Nested compound: { "or": [ { "and": [ ... ] }, { "dataPoint": "value" } ] }

Check the operators supported by each data point via the data points endpoint.

andarray[object]

Filters investments using dataPoint: filter conditions or compound logic. Keys are data point names; values are filters. For example:

  • Equals: { "shareClassInformation.symbol": "MSES" }
  • In: { "shareClassInformation.symbol": ["MSES", "CA40"] }
  • Range: { "marketCapital.asOfDate": { "gt": "2020-01-01", "lt": "2024-01-01" } }
  • Contains: { "companyInformation.legalName": { "contains": "apple" } }
  • Fuzzy: { "shareClassInformation.investmentName": "aople inc", "fuzzy": true }
  • Compound: { "and": [ { "dataPoint1": "value1" }, { "dataPoint2": "value2" } ] }
  • Nested compound: { "or": [ { "and": [ ... ] }, { "dataPoint": "value" } ] }

Check the operators supported by each data point via the data points endpoint.

Show Child Parameters
orarray[object]

Filters investments using dataPoint: filter conditions or compound logic. Keys are data point names; values are filters. For example:

  • Equals: { "shareClassInformation.symbol": "MSES" }
  • In: { "shareClassInformation.symbol": ["MSES", "CA40"] }
  • Range: { "marketCapital.asOfDate": { "gt": "2020-01-01", "lt": "2024-01-01" } }
  • Contains: { "companyInformation.legalName": { "contains": "apple" } }
  • Fuzzy: { "shareClassInformation.investmentName": "aople inc", "fuzzy": true }
  • Compound: { "and": [ { "dataPoint1": "value1" }, { "dataPoint2": "value2" } ] }
  • Nested compound: { "or": [ { "and": [ ... ] }, { "dataPoint": "value" } ] }

Check the operators supported by each data point via the data points endpoint.

Show Child Parameters
notarray[object]

Filters investments using dataPoint: filter conditions or compound logic. Keys are data point names; values are filters. For example:

  • Equals: { "shareClassInformation.symbol": "MSES" }
  • In: { "shareClassInformation.symbol": ["MSES", "CA40"] }
  • Range: { "marketCapital.asOfDate": { "gt": "2020-01-01", "lt": "2024-01-01" } }
  • Contains: { "companyInformation.legalName": { "contains": "apple" } }
  • Fuzzy: { "shareClassInformation.investmentName": "aople inc", "fuzzy": true }
  • Compound: { "and": [ { "dataPoint1": "value1" }, { "dataPoint2": "value2" } ] }
  • Nested compound: { "or": [ { "and": [ ... ] }, { "dataPoint": "value" } ] }

Check the operators supported by each data point via the data points endpoint.

Show Child Parameters
fuzzyboolean | null

When true, applies fuzzy text matching to the string equals conditions in this object. Supported only by data points where fuzzy is true.

Default:false

Example

InputSortOption

object

The data point and sort direction.

* Additional properties are NOT allowed.
dataPointstringrequired

Data point name. Must also be passed in the dataPoints array.

Example:shareClassInformation.exchangeCode

orderBystring

Sort direction.

Allowed values:ascdesc

Default:asc

Example:desc

Example

InputUniverse

string,null

Applies a predefined scope. Use as an alternative to defining a custom scope.

Allowed values:equity_scope_xnys

Example

OutputCodeMappedValue

object

Value of a code-mapped data point: the underlying code and its display value.

* Additional properties are NOT allowed.
codeAny Of

Code. Depending on the data point, a string, number, integer, or boolean.

Variant 1string
valuestring | null

Display value for the code. Language-dependent data points use languageId.

Example

OutputDataPoint

object

A data point and the screening features it supports.

* Additional properties are NOT allowed.
namestring | null

Data point name in the format <dataGroup>.<fieldName>. Retrieve valid values programmatically via GET /direct-web-services/v1/screeners/equities/data-points, or browse the full reference in the data dictionary.

Example:companyInformation.domicileCountryCode

typestring | null

Data type of the data point. Dates are returned as type string.

Example:decimal

operatorsarray | null[string]

Filter operators supported by the data point. Compound operators (and, or, not) are supported for all data points.

Example:gt, gte, lt, lte, eq, in

isSortableboolean

When true, the data point can be used to sort results.

isLanguageDependentboolean

When true, values depend on languageId.

isCurrencyDependentboolean

When true, values depend on currencyId.

fuzzyboolean

When true, the data point supports fuzzy text matching.

enumboolean

When true, the data point accepts a fixed set of values.

isCodeMappedboolean | null

When true, values are returned as OutputCodeMappedValue objects (code and display value).

Example