InputQueryOptions
objectFilters investments using dataPoint: filter conditions or compound logic. Keys are data point names; values are filters. For example:
- Equals:
{ "basicReference.baseCurrency": "USD" } - In:
{ "basicReference.baseCurrency": ["USD", "GBP"] } - Range:
{ "basicReference.inceptionDate": { "gt": "2020-01-01", "lt": "2024-01-01" } } - Contains:
{ "basicReference.name": { "contains": "app" } } - Fuzzy:
{ "basicReference.name": "Aviva", "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.
Filters investments using dataPoint: filter conditions or compound logic. Keys are data point names; values are filters. For example:
- Equals:
{ "basicReference.baseCurrency": "USD" } - In:
{ "basicReference.baseCurrency": ["USD", "GBP"] } - Range:
{ "basicReference.inceptionDate": { "gt": "2020-01-01", "lt": "2024-01-01" } } - Contains:
{ "basicReference.name": { "contains": "app" } } - Fuzzy:
{ "basicReference.name": "Aviva", "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
Filters investments using dataPoint: filter conditions or compound logic. Keys are data point names; values are filters. For example:
- Equals:
{ "basicReference.baseCurrency": "USD" } - In:
{ "basicReference.baseCurrency": ["USD", "GBP"] } - Range:
{ "basicReference.inceptionDate": { "gt": "2020-01-01", "lt": "2024-01-01" } } - Contains:
{ "basicReference.name": { "contains": "app" } } - Fuzzy:
{ "basicReference.name": "Aviva", "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
Filters investments using dataPoint: filter conditions or compound logic. Keys are data point names; values are filters. For example:
- Equals:
{ "basicReference.baseCurrency": "USD" } - In:
{ "basicReference.baseCurrency": ["USD", "GBP"] } - Range:
{ "basicReference.inceptionDate": { "gt": "2020-01-01", "lt": "2024-01-01" } } - Contains:
{ "basicReference.name": { "contains": "app" } } - Fuzzy:
{ "basicReference.name": "Aviva", "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
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
InputSortOption
objectThe data point and sort direction.
Data point name. Must also be passed in the dataPoints array.
Example:basicReference.legalName
Sort direction.
Allowed values:ascdesc
Default:asc
Example:desc
InputUniverse
string,nullApplies a predefined scope. Use as an alternative to defining a custom scope.
Allowed values:mip_data_univ
OutputCodeMappedValue
objectValue of a code-mapped data point: the underlying code and its display value.
Any OfCode. Depending on the data point, a string, number, integer, or boolean.
Display value for the code. Language-dependent data points use languageId.
OutputDataPoint
objectA data point and the screening features it supports.
Data point name in the format <dataGroup>.<fieldName>. Retrieve valid values programmatically via GET /direct-web-services/v1/screeners/managed-investments/data-points, or browse the full reference in the data dictionary.
Example:basicReference.legalName
Data type of the data point. Dates are returned as type string.
Example:decimal
Filter operators supported by the data point. Compound operators (and, or, not) are supported for all data points.
Example:gt, gte, lt, lte, eq, in
When true, the data point can be used to sort results.
When true, values depend on languageId.
When true, values depend on currencyId.
When true, the data point supports fuzzy text matching.
When true, the data point accepts a fixed set of values.
When true, values are returned as OutputCodeMappedValue objects (code and display value).