OutputScreenerMetadata
objectMetadata returned with screener results, including pagination tokens and information about data points not returned.
* Additional properties are NOT allowed.
paginationTokenNextstring | null
Token to fetch the next page of results.
Example:CNOAQhoJKQBIuTktAQAAGhU6E3RlYW0gcGFydG5lcnMgZ3JvdXAaDDoKMHAwMDAwYTZ6dCIMOgowUDAwMDBBNlpU
paginationTokenPreviousstring | null
Token to fetch the previous page of results.
Example:CKDjNhoJKQBIuTktAQAAGg06C2dkZiBzdWV6IHNhGgw6CjBwMDAwMDl3cW8iDDoKMFAwMDAwOVdRTw==
totalCountinteger | null(int32)
Total number of results found.
Example:2162
messagesarray | null[object]
Indicates why specific data points were not returned for one or more results.
* Additional properties are NOT allowed.
Show Child Parameters
securityReferencearray | null[object]
Resolved identifiers for a valid investment.
* Additional properties are NOT allowed.
Show Child Parameters
requestIdstring | null
Unique request identifier.
Example:c63e7f6c-b52d-42c3-9d1b-4a4b4ac05f3c
timestring(date-time)read-only
Time the response was generated.
Example:2025-10-02T10:54:36.9161062Z
Example
OutputToken
objectA successful authentication response containing a JWT bearer token.
access_tokenstringrequired
The signed JWT to use as a Bearer token in subsequent authenticated requests.
Example:eyJhbGciOiJ example
expires_inintegerrequired
The number of seconds until the token expires. After expiry, request a new token.
Example:3599
token_typestringrequired
The token type. Always Bearer.
Example:Bearer
Example
RequestEquitiesScreener
objectScreener request body. Define the starting universe with universe or scope, then narrow results with query.
* Additional properties are NOT allowed.
universestring | null
Applies a predefined scope. Use as an alternative to defining a custom scope.
Allowed values:equity_scope_xnys
Example:equity_scope_xnys
scopeobject
Defines the starting universe of investments. For equities, the scoping data point is shareClassInformation.exchangeCode. Compound and nested compound queries are supported. Each branch of the query must contain the scoping data point.
Show Child Parameters
queryobject
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
dataPointsarray[string]
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:companyInformation.cik, companyInformation.legalName, balanceSheet.totalAssetsValueFY, basicReference.isin
paginationobject
Determines how results are paginated.
* Additional properties are NOT allowed.
Show Child Parameters
sortarray | null[object]
The data point and sort direction.
* Additional properties are NOT allowed.
Show Child Parameters
languageIdstring | null
Specifies the language code used for language-dependent results.
Allowed values:ARACHIDANDUTENGFINFREGERHEBITAJPNKORNORPORSPASWETHAZHO
Default:ENG
Example:JPN
currencyIdstring | null
Specifies the currency used for currency-dependent results. Accepts ISO 4217 currency codes.
Default:USD
Example:EUR
Example
ResponseDataPoints
objectData 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
Example
ResponseEquitiesScreener
objectScreener response including results and metadata.
* Additional properties are NOT allowed.
investmentsarray | null[object]
Data points and values returned for a single result. Keys are data point names in the format <dataGroup>.<fieldName>; values depend on the data type of the data point. instrumentIdentifiers.performanceId is always returned. Data points with no value may be omitted.
Example:{"instrumentIdentifiers.performanceId":"0P0001VK71","shareClassInformation.symbol":"MSES","shareClassInformation.investmentStatus":1,"marketCapital.asOfDate":"2025-10-02","trailingReturn.trailing10YearReturn":12.45,"companyInformation.sic":6719}
metadataobject
Metadata returned with screener results, including pagination tokens and information about data points not returned.
* Additional properties are NOT allowed.
Show Child Parameters
Example