Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.ISearchApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< List< InstrumentMatch > >	InstrumentsSearchAsync (List< InstrumentSearchProperty > instrumentSearchProperty, DateTimeOrCutLabel? masteredEffectiveAt=default(DateTimeOrCutLabel?), bool? masteredOnly=default(bool?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] InstrumentsSearch: Instruments search More...

System.Threading.Tasks.Task< ApiResponse< List< InstrumentMatch > > >	InstrumentsSearchWithHttpInfoAsync (List< InstrumentSearchProperty > instrumentSearchProperty, DateTimeOrCutLabel? masteredEffectiveAt=default(DateTimeOrCutLabel?), bool? masteredOnly=default(bool?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] InstrumentsSearch: Instruments search More...

System.Threading.Tasks.Task< PagedResourceListOfPortfolioGroupSearchResult >	SearchPortfolioGroupsAsync (string? search=default(string?), string? filter=default(string?), string? sortBy=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SearchPortfolioGroups: Search Portfolio Groups More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfPortfolioGroupSearchResult > >	SearchPortfolioGroupsWithHttpInfoAsync (string? search=default(string?), string? filter=default(string?), string? sortBy=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SearchPortfolioGroups: Search Portfolio Groups More...

System.Threading.Tasks.Task< PagedResourceListOfPortfolioSearchResult >	SearchPortfoliosAsync (string? search=default(string?), string? filter=default(string?), string? sortBy=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SearchPortfolios: Search Portfolios More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfPortfolioSearchResult > >	SearchPortfoliosWithHttpInfoAsync (string? search=default(string?), string? filter=default(string?), string? sortBy=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SearchPortfolios: Search Portfolios More...

System.Threading.Tasks.Task< PagedResourceListOfPropertyDefinitionSearchResult >	SearchPropertiesAsync (string? search=default(string?), string? filter=default(string?), string? sortBy=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SearchProperties: Search Property Definitions More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfPropertyDefinitionSearchResult > >	SearchPropertiesWithHttpInfoAsync (string? search=default(string?), string? filter=default(string?), string? sortBy=default(string?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	SearchProperties: Search Property Definitions More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ InstrumentsSearchAsync()

System.Threading.Tasks.Task<List<InstrumentMatch> > Lusid.Sdk.Api.ISearchApiAsync.InstrumentsSearchAsync	(	List< InstrumentSearchProperty >	instrumentSearchProperty,
		DateTimeOrCutLabel?	masteredEffectiveAt = `default(DateTimeOrCutLabel?)`,
		bool?	masteredOnly = `default(bool?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] InstrumentsSearch: Instruments search

Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service, currently OpenFIGI.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

instrumentSearchProperty	A collection of instrument properties to search for. LUSID will return instruments for any matched properties.
masteredEffectiveAt	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. (optional)
masteredOnly	If set to true, only search over instruments that have been mastered within LUSID. Defaults to false. (optional, default to false)
scope	The scope in which the instrument lies. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of List<InstrumentMatch>

Implemented in Lusid.Sdk.Api.SearchApi.

◆ InstrumentsSearchWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<List<InstrumentMatch> > > Lusid.Sdk.Api.ISearchApiAsync.InstrumentsSearchWithHttpInfoAsync	(	List< InstrumentSearchProperty >	instrumentSearchProperty,
		DateTimeOrCutLabel?	masteredEffectiveAt = `default(DateTimeOrCutLabel?)`,
		bool?	masteredOnly = `default(bool?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] InstrumentsSearch: Instruments search

Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service, currently OpenFIGI.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

instrumentSearchProperty	A collection of instrument properties to search for. LUSID will return instruments for any matched properties.
masteredEffectiveAt	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. (optional)
masteredOnly	If set to true, only search over instruments that have been mastered within LUSID. Defaults to false. (optional, default to false)
scope	The scope in which the instrument lies. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (List<InstrumentMatch>)

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPortfolioGroupsAsync()

System.Threading.Tasks.Task<PagedResourceListOfPortfolioGroupSearchResult> Lusid.Sdk.Api.ISearchApiAsync.SearchPortfolioGroupsAsync	(	string?	search = `default(string?)`,
		string?	filter = `default(string?)`,
		string?	sortBy = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SearchPortfolioGroups: Search Portfolio Groups

Search through all portfolio groups

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

search	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. (optional)
filter	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. (optional)
sortBy	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 (optional)
limit	When paginating, only return this number of records (optional)
page	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfPortfolioGroupSearchResult

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPortfolioGroupsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfPortfolioGroupSearchResult> > Lusid.Sdk.Api.ISearchApiAsync.SearchPortfolioGroupsWithHttpInfoAsync	(	string?	search = `default(string?)`,
		string?	filter = `default(string?)`,
		string?	sortBy = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SearchPortfolioGroups: Search Portfolio Groups

Search through all portfolio groups

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

search	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. (optional)
filter	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. (optional)
sortBy	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 (optional)
limit	When paginating, only return this number of records (optional)
page	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfPortfolioGroupSearchResult)

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPortfoliosAsync()

System.Threading.Tasks.Task<PagedResourceListOfPortfolioSearchResult> Lusid.Sdk.Api.ISearchApiAsync.SearchPortfoliosAsync	(	string?	search = `default(string?)`,
		string?	filter = `default(string?)`,
		string?	sortBy = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SearchPortfolios: Search Portfolios

Search through all portfolios

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

search	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. (optional)
filter	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. (optional)
sortBy	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 (optional)
limit	When paginating, only return this number of records (optional)
page	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfPortfolioSearchResult

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPortfoliosWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfPortfolioSearchResult> > Lusid.Sdk.Api.ISearchApiAsync.SearchPortfoliosWithHttpInfoAsync	(	string?	search = `default(string?)`,
		string?	filter = `default(string?)`,
		string?	sortBy = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SearchPortfolios: Search Portfolios

Search through all portfolios

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

search	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. (optional)
filter	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. (optional)
sortBy	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 (optional)
limit	When paginating, only return this number of records (optional)
page	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfPortfolioSearchResult)

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPropertiesAsync()

System.Threading.Tasks.Task<PagedResourceListOfPropertyDefinitionSearchResult> Lusid.Sdk.Api.ISearchApiAsync.SearchPropertiesAsync	(	string?	search = `default(string?)`,
		string?	filter = `default(string?)`,
		string?	sortBy = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SearchProperties: Search Property Definitions

Search through all Property Definitions

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

search	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. (optional)
filter	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. (optional)
sortBy	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 (optional)
limit	When paginating, only return this number of records (optional)
page	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfPropertyDefinitionSearchResult

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfPropertyDefinitionSearchResult> > Lusid.Sdk.Api.ISearchApiAsync.SearchPropertiesWithHttpInfoAsync	(	string?	search = `default(string?)`,
		string?	filter = `default(string?)`,
		string?	sortBy = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

SearchProperties: Search Property Definitions

Search through all Property Definitions

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

search	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. (optional)
filter	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. (optional)
sortBy	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 (optional)
limit	When paginating, only return this number of records (optional)
page	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfPropertyDefinitionSearchResult)

Implemented in Lusid.Sdk.Api.SearchApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/SearchApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ InstrumentsSearchAsync()

◆ InstrumentsSearchWithHttpInfoAsync()

◆ SearchPortfolioGroupsAsync()

◆ SearchPortfolioGroupsWithHttpInfoAsync()

◆ SearchPortfoliosAsync()

◆ SearchPortfoliosWithHttpInfoAsync()

◆ SearchPropertiesAsync()

◆ SearchPropertiesWithHttpInfoAsync()