Equities Screener API
Powerful, criteria-based screening using flexible filtering logic.
API Inputs
Request-Level Inputs
These inputs apply to the request as a whole: the request headers, and the top-level fields of the request body, including the scope, the query, the data points to return, and the sort and pagination settings.
accept
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | application/json |
| Example | application/json |
Specifies the response format. Used with the data points endpoint.
Authorization
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | Bearer {token}, where the token is a JSON Web Token |
| Example | Bearer eyJhbGciOi... |
Specifies the token that authorizes the request. Required. For more information about getting a token, see the Authentication page.
Content-Type
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | application/json |
| Example | application/json |
Specifies the format of the request body. Required for POST requests.
currencyId
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string |
| Possible Values | 3-character ISO 4217 currency codes. Default: USD |
| Example | EUR |
Specifies the currency used to return currency-dependent data points. Required for currency-dependent data points.
dataPoints
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | array of strings |
| Possible Values | Up to 100 data point names. Default: performanceId |
| Example | ["shareClassInformation.symbol", "marketCapital.asOfDate"] |
List of data points to return for each investment. A maximum of 100 data points can be passed in a single request. The performance ID is always returned.
languageId
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string |
| Possible Values | ARA, CHI, DAN, DUT, ENG, FIN, FRE, GER, HEB, ITA, JPN, KOR, NOR, POR, SPA, SWE, THA, ZHO. Default: ENG |
| Example | FRE |
Specifies the language used to return language-dependent data points. Required for language-dependent data points.
pagination
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | object |
| Possible Values | pageSize, paginationTokenNext, paginationTokenPrevious |
| Example | { "pageSize": 25 } |
Container for the pagination settings. See Pagination Inputs below for the fields inside it.
query
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | object |
| Possible Values | A single filter condition, or a compound filter that uses and, or and not |
| Example | { "shareClassInformation.symbol": "MSES" } |
Specifies the filter conditions applied to the scoped universe. If omitted, no filtering is applied beyond the scope. See Filter Inputs below for the operators.
scope
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | object |
| Possible Values | Filter conditions on the exchange code data point, shareClassInformation.exchangeCode |
| Example | { "shareClassInformation.exchangeCode": "XPAR" } |
Specifies the starting universe of investments, limited to your entitled universe. Required. Uses the same syntax as query. In a compound filter, each branch must contain the exchange code data point.
sort
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | array of objects |
| Possible Values | Objects with dataPoint and orderBy. Default: ascending performanceId |
| Example | [{ "dataPoint": "marketCapital.asOfDate", "orderBy": "desc" }] |
Specifies how results are sorted. Entries are applied in order. See Sort Inputs below for the fields inside each entry.
Pagination Inputs
These inputs live inside the pagination object.
pageSize
| Attribute | Value |
|---|---|
| Type | Request Payload (pagination) |
| Data Type | integer |
| Possible Values | Up to 50. Default: 50 |
| Example | 25 |
Specifies the number of results per page.
paginationTokenNext
| Attribute | Value |
|---|---|
| Type | Request Payload (pagination) |
| Data Type | string |
| Possible Values | The paginationTokenNext value from the previous response |
| Example | CIvvDRoJKQDgW9yaAQAAGhw6... |
Specifies the token used to retrieve the next page of results. Use either this or paginationTokenPrevious in a request, not both.
paginationTokenPrevious
| Attribute | Value |
|---|---|
| Type | Request Payload (pagination) |
| Data Type | string |
| Possible Values | The paginationTokenPrevious value from the previous response |
| Example | CIvvDRoJKQDgW9yaAQAAGhw6... |
Specifies the token used to retrieve the previous page of results. Use either this or paginationTokenNext in a request, not both.
Sort Inputs
These inputs live inside each object in the sort array.
dataPoint
| Attribute | Value |
|---|---|
| Type | Request Payload (sort[]) |
| Data Type | string |
| Possible Values | A sortable data point that is also in dataPoints. Default: performanceId |
| Example | marketCapital.asOfDate |
Specifies the data point to sort by.
orderBy
| Attribute | Value |
|---|---|
| Type | Request Payload (sort[]) |
| Data Type | string |
| Possible Values | asc, desc. Default: asc |
| Example | desc |
Specifies the sort direction.
Filter Inputs
These operators are used inside scope and query. Equality filters need no operator: a single value matches that value, and a list of values matches any value in the list. For the syntax of each filter, see Filter Conditions.
and
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | array of objects |
| Possible Values | One or more filter conditions |
| Example | [{ "shareClassInformation.symbol": "MSES" }, { "marketCapital.asOfDate": { "gt": "2024-01-01" } }] |
All conditions must match.
contains
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | string |
| Possible Values | Text |
| Example | APP |
Matches a substring. Supported for some string data points.
fuzzy
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | boolean |
| Possible Values | true, false |
| Example | true |
Enables fuzzy text matching. Supported for some string data points. Used with value.
gt
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | number or string (date) |
| Possible Values | A number, or a date in yyyy-MM-dd format |
| Example | 4 |
Greater than.
gte
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | number or string (date) |
| Possible Values | A number, or a date in yyyy-MM-dd format |
| Example | 2024-01-01 |
Greater than or equal to.
lt
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | number or string (date) |
| Possible Values | A number, or a date in yyyy-MM-dd format |
| Example | 10 |
Less than.
lte
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | number or string (date) |
| Possible Values | A number, or a date in yyyy-MM-dd format |
| Example | 2024-12-31 |
Less than or equal to.
not
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | array of objects |
| Possible Values | One or more filter conditions |
| Example | [{ "shareClassInformation.symbol": "USSM" }] |
None of the conditions can match.
or
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | array of objects |
| Possible Values | One or more filter conditions |
| Example | [{ "shareClassInformation.symbol": "MSES" }, { "shareClassInformation.symbol": "CA40" }] |
At least one condition must match.
value
| Attribute | Value |
|---|---|
| Type | Request Payload (query, scope) |
| Data Type | string |
| Possible Values | Text of at least 3 characters |
| Example | appel |
Specifies the text to match when fuzzy is true.