sdk.lusid.api.search_api.SearchApi

class SearchApi(api_client=None)[source]

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

`instruments_search`	[EARLY ACCESS] InstrumentsSearch: Instruments search # noqa: E501
`instruments_search_with_http_info`	[EARLY ACCESS] InstrumentsSearch: Instruments search # noqa: E501
`search_portfolio_groups`	SearchPortfolioGroups: Search Portfolio Groups # noqa: E501
`search_portfolio_groups_with_http_info`	SearchPortfolioGroups: Search Portfolio Groups # noqa: E501
`search_portfolios`	SearchPortfolios: Search Portfolios # noqa: E501
`search_portfolios_with_http_info`	SearchPortfolios: Search Portfolios # noqa: E501
`search_properties`	SearchProperties: Search Property Definitions # noqa: E501
`search_properties_with_http_info`	SearchProperties: Search Property Definitions # noqa: E501

instruments_search(instrument_search_property, mastered_effective_at=None, mastered_only=None, scope=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] InstrumentsSearch: Instruments search # noqa: E501

Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service, currently OpenFIGI. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.instruments_search(instrument_search_property, mastered_effective_at, mastered_only, scope, async_req=True)
>>> result = thread.get()

Parameters:

instrument_search_property (List[InstrumentSearchProperty]) – A collection of instrument properties to search for. LUSID will return instruments for any matched properties. (required)
mastered_effective_at (str) – The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.
mastered_only (bool) – If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.
scope (str) – The scope in which the instrument lies.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

List[InstrumentMatch]

instruments_search_with_http_info(instrument_search_property, mastered_effective_at=None, mastered_only=None, scope=None, **kwargs)[source]

[EARLY ACCESS] InstrumentsSearch: Instruments search # noqa: E501

Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service, currently OpenFIGI. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.instruments_search_with_http_info(instrument_search_property, mastered_effective_at, mastered_only, scope, async_req=True)
>>> result = thread.get()

Parameters:

instrument_search_property (List[InstrumentSearchProperty]) – A collection of instrument properties to search for. LUSID will return instruments for any matched properties. (required)
mastered_effective_at (str) – The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.
mastered_only (bool) – If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.
scope (str) – The scope in which the instrument lies.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(List[InstrumentMatch], status_code(int), headers(HTTPHeaderDict))

search_portfolio_groups(search=None, filter=None, sort_by=None, limit=None, page=None, async_req=None, **kwargs)[source]

SearchPortfolioGroups: Search Portfolio Groups # noqa: E501

Search through all portfolio groups # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.search_portfolio_groups(search, filter, sort_by, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

search (str) – A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. ‘Port*’). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
filter (str) – Expression to filter the result set. For example, to filter on the Scope, use “id.scope eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (str) – Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
limit (int) – When paginating, only return this number of records
page (str) – Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfPortfolioGroupSearchResult

search_portfolio_groups_with_http_info(search=None, filter=None, sort_by=None, limit=None, page=None, **kwargs)[source]

SearchPortfolioGroups: Search Portfolio Groups # noqa: E501

Search through all portfolio groups # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.search_portfolio_groups_with_http_info(search, filter, sort_by, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

search (str) – A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. ‘Port*’). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
filter (str) – Expression to filter the result set. For example, to filter on the Scope, use “id.scope eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (str) – Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
limit (int) – When paginating, only return this number of records
page (str) – Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfPortfolioGroupSearchResult, status_code(int), headers(HTTPHeaderDict))

search_portfolios(search=None, filter=None, sort_by=None, limit=None, page=None, async_req=None, **kwargs)[source]

SearchPortfolios: Search Portfolios # noqa: E501

Search through all portfolios # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.search_portfolios(search, filter, sort_by, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

search (str) – A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. ‘Port*’). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
filter (str) – Expression to filter the result set. For example, to filter on the portfolio Type, use “type eq ‘Transaction’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (str) – Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
limit (int) – When paginating, only return this number of records
page (str) – Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfPortfolioSearchResult

search_portfolios_with_http_info(search=None, filter=None, sort_by=None, limit=None, page=None, **kwargs)[source]

SearchPortfolios: Search Portfolios # noqa: E501

Search through all portfolios # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.search_portfolios_with_http_info(search, filter, sort_by, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

search (str) – A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. ‘Port*’). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
filter (str) – Expression to filter the result set. For example, to filter on the portfolio Type, use “type eq ‘Transaction’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (str) – Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
limit (int) – When paginating, only return this number of records
page (str) – Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfPortfolioSearchResult, status_code(int), headers(HTTPHeaderDict))

search_properties(search=None, filter=None, sort_by=None, limit=None, page=None, async_req=None, **kwargs)[source]

SearchProperties: Search Property Definitions # noqa: E501

Search through all Property Definitions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.search_properties(search, filter, sort_by, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

search (str) – A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. ‘Port*’). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
filter (str) – Expression to filter the result set. For example, to filter on the Value Type, use “valueType eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (str) – Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
limit (int) – When paginating, only return this number of records
page (str) – Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfPropertyDefinitionSearchResult

search_properties_with_http_info(search=None, filter=None, sort_by=None, limit=None, page=None, **kwargs)[source]

SearchProperties: Search Property Definitions # noqa: E501

Search through all Property Definitions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.search_properties_with_http_info(search, filter, sort_by, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

search (str) – A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. ‘Port*’). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
filter (str) – Expression to filter the result set. For example, to filter on the Value Type, use “valueType eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (str) – Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
limit (int) – When paginating, only return this number of records
page (str) – Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfPropertyDefinitionSearchResult, status_code(int), headers(HTTPHeaderDict))