Equities Screener API

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

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