Equities Screener API

Powerful, criteria-based screening using flexible filtering logic.

Equities Screener API

The Equities Screener API finds equities that meet criteria you define. You set the starting universe, apply filter conditions with exact matches, ranges, exclusions and multi-factor logic, and choose the data points to return. The API responds with the matching investments, including their performance IDs, ready for research, discovery or downstream analysis.

New to the API? Start with Getting Started.

At a Glance

FeatureDetails
Investments screenedEquities
Starting universeYour entitled universe of equities, narrowed by exchange
Scoping data pointshareClassInformation.exchangeCode
Data points per requestUp to 100
Results per pageUp to 50, with token-based pagination
AuthenticationOAuth 2.0 access token, valid for 60 minutes

Key Capabilities

  • Apply complex filtering logic with and, or and not, comparisons and value lists, including nested filters.
  • Retrieve performance IDs and the data points you need for downstream API requests.
  • Choose exactly which data points to return, to keep responses small.
  • Sort results, and use token-based pagination to work through large result sets.
  • List the supported data points, with their data types, operators and dependencies, to build valid queries.

How It Works

  1. Build your screening criteria. Set the scope to define the starting universe, then add filter conditions. Combine them with logical operators to shape the results.
  2. Select the data points to return. Choose the identifiers, details and measures you want for each match.
  3. Send the screener request. Include the scope, the filter conditions, the data points, and any sort and pagination settings.
  4. Retrieve and iterate. The response contains the matching investments, metadata, and pagination tokens. Use the tokens to retrieve further pages until you have all the results.

In This Guide

SectionWhat You'll Find
Getting StartedThe workflow for making your first screen.
Core ConceptsHow scope, filters, data points, sorting and pagination work together.
Explore Data PointsHow to list data points and read their metadata.
Screen EquitiesBuild and send a complete screen, step by step.
Filter ConditionsEquality, text, comparison and compound filters in detail.
Work with ResultsHow to read the response, page through results and handle warnings.
Example ScreensComplete requests you can adapt.
Quick LookupReference for API Inputs, Operators and Errors.
FAQsAnswers to common questions.
TroubleshootingFixes for common problems.