Managed Investments Screener API

Managed Investments API

RequestManagedInvestmentsScreener

object

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:mip_data_univ

Example:mip_data_univ

scopeobject

Defines the starting universe of investments. For managed investments, the scoping data point is basicReference.countryAvailableForSale. 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: { "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
dataPointsarray[string]

Lists data points to return. Retrieve valid values programmatically via GET /direct-web-services/v1/screeners/managed-investments/data-points, or browse the full reference in the data dictionary.

<= 100 items

Example:basicReference.legalName, basicReference.name, basicReference.firmName, basicReference.inceptionDate

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

object

Data points and operators supported for managed investments 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

ResponseManagedInvestmentsScreener

object

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":"0P0001RHZF","basicReference.firmName":"10X Investments (Pty) Ltd","basicReference.inceptionDate":"2023-05-17","basicReference.name":"10X Income AMETF","yieldsHistorical.12MoYield":7.2118}

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