Query equity investments and return selected data points.
Returns the investments that meet the conditions defined in universe/scope and query. Returns instrumentIdentifiers.performanceId by default and any other data points specified in the dataPoints array.
post
Body
application/json
Body
application/json
RequestEquitiesScreener
Screener 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
Response
application/json
Response
application/json
OK
ResponseEquitiesScreener
Screener 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
post/direct-web-services/v1/screeners/equities
Authentication
Body
{
"scope": {
"shareClassInformation.exchangeCode": "XPAR"
},
"query": {
"shareClassInformation.symbol": "MSES"
},
"dataPoints": [
"esgCompanyLevel2DataCarbonEmissions.carbonIntensity",
"factorProfile.emergingAsiaPacificFactorMultiAssetModel",
"indexLevelsPrice.closeAsMovingAvg200DayMoEnd",
"shortInterest.percentageChanged",
"companyInformation.sic",
"esgCompanyLevel1DataLowCarbonTransitionRating.lowCarbonTransitionVarValueAtRiskIprFpsOverallRisk2050Usd",
"esgCompanyLevelDataSfdrPAI.breachOfUnGlobalCompactPrinciplesAndOecdGuidelinesForMultinationalEnterprisesSfdrYearOfReference",
"esgCompanyLevel2DataImpactMetricsSDGsAndThemes.sdg3PercOfRevenue",
"monthlyStandardDeviation.arithmeticMean24Month",
"dividendResidualRiskAndReturnSensitivity.beta24Month",
"pricesMostRecent.avgVolumeInMil5YrQtrEnd",
"shareClassInformation.symbol",
"factorProfile.styleFactorMultiAssetModel",
"esgCompanyLevelDataSfdrPAI.icPoliticalStabilityScoreSfdrYearOfReference",
"shareClassInformation.investmentStatus",
"pricesMostRecent.avgVolumeInMil10YrMoEnd",
"esgCompanyLevel2DataEsgRiskRating.sustainalyticsRatingDate",
"esgCompanyLevel1DataLowCarbonTransitionRating.reportingSufficiencyCategory",
"dividendResidualRiskAndReturnSensitivity.beta120Month",
"trailingReturn.trailing10YearReturn",
"esgCompanyLevelDataSfdrPAI.boardGenderDiversityPercentageOfFemaleBoardMembersSfdr",
"pricesMostRecent.avgVolumeInMil9MoDaily",
"pricesMostRecent.totalVolumeInMil2WkDaily",
"marketCapital.asOfDate",
"quantitativeFairValues.quantitativeMoat",
"factorProfile.realEstateFactorMultiAssetModel",
"dividendResidualRiskAndReturnSensitivity.rSquare60Month"
],
"pagination": {
"pageSize": 10
},
"sort": [
{
"dataPoint": "marketCapital.asOfDate"
}
]
}
application/json
Data Points
Discover data points supported for equities screening.
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
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
Authentication
application/json
ErrorResponseAuthentication
objectA 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
arrayLists 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