Search Criteria#

morningstar_data.direct.user_items.get_search_criteria() → DataFrame#

Returns all search criteria saved or shared to a user in Morningstar Direct

Returns:

A DataFrame object with all search criterias data. The DataFrame columns include:

id
name

Return type:

DataFrame

Examples:

import morningstar_data as md

df = md.direct.user_items.get_search_criteria()
df

Output:

id	name
4175985	sample
5022284	others
…

morningstar_data.direct.user_items.get_search_criteria_conditions( search_criteria_id: str, ) → Dict[str, Any]#

Returns the specific logic used for a given search criteria.

Parameters:: search_criteria_id (str) – The unique identifier of a saved search criteria from Morningstar Direct. The id string is numeric. For example, “9009”.
Returns:: Search conditions
Return type:: dict
Examples:

import morningstar_data as md

df = md.direct.user_items.get_search_criteria_conditions(search_criteria_id="9009")
df

Output:

{
    "universeId": "FO",
    "subUniverseId": "",
    "subUniverseName": "",
    "securityStatus": "activeonly",
    "useDefinedPrimary": False,
    "criteria": [
        {
            "relation": "",
            "field": "OS001",
            "operator": "=",
            "value": "AAAAX",
            "id": "FOUSA06JNH",
            "name": "AAAAX"
        }
    ]
}

morningstar_data.direct.user_items.get_search_results( search_criteria_id: str, ) → DataFrame#

Returns all investments matching the specified search criteria.

Parameters:: search_criteria_id (str) – The unique identifier of a saved search criteria from Morningstar Direct. The id string is numeric. For example, “9009”.
Returns:: DataFrame object, its columns are all column that user save in the special search criteria.
Return type:: DataFrame

Examples

Get core fields for investments with search criteria id “4237053”

import morningstar_data as md

df = md.direct.user_items.get_search_results(search_criteria_id="4237053")
df

Output:

secid	masterportfolioid	tradingsymbol	name	securitytype	exchangeid	category
FOUSA06JNH	210311	AAAAX	DWS RREEF Real Assets A	FO	EXXNAS	World Allocation
…

Errors:

AccessDeniedError - Raised when user lacks permission or not authorized to access the resource BadRequestException - Raised due to multiple reasons including invalid/incorrect request, malformed request syntax,

or deceptive request routing

NetworkExceptionError - Raised when there is an issue with the internet connection or if the request is made from: an unsecure network

ResourceNotFoundError - Raised when the requested resource does not exist in Direct