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

Inheritance diagram for Lusid.Sdk.Api.IInstrumentsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< BatchUpsertInstrumentPropertiesResponse >	BatchUpsertInstrumentPropertiesAsync (Dictionary< string, UpsertInstrumentPropertyRequest > requestBody, string? scope=default(string?), DateTimeOrCutLabel? identifierEffectiveAt=default(DateTimeOrCutLabel?), string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] BatchUpsertInstrumentProperties: Batch upsert instruments properties More...

System.Threading.Tasks.Task< ApiResponse< BatchUpsertInstrumentPropertiesResponse > >	BatchUpsertInstrumentPropertiesWithHttpInfoAsync (Dictionary< string, UpsertInstrumentPropertyRequest > requestBody, string? scope=default(string?), DateTimeOrCutLabel? identifierEffectiveAt=default(DateTimeOrCutLabel?), string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] BatchUpsertInstrumentProperties: Batch upsert instruments properties More...

System.Threading.Tasks.Task< DeleteInstrumentResponse >	DeleteInstrumentAsync (string identifierType, string identifier, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteInstrument: Soft delete a single instrument More...

System.Threading.Tasks.Task< ApiResponse< DeleteInstrumentResponse > >	DeleteInstrumentWithHttpInfoAsync (string identifierType, string identifier, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteInstrument: Soft delete a single instrument More...

System.Threading.Tasks.Task< DeleteInstrumentPropertiesResponse >	DeleteInstrumentPropertiesAsync (string identifierType, string identifier, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties More...

System.Threading.Tasks.Task< ApiResponse< DeleteInstrumentPropertiesResponse > >	DeleteInstrumentPropertiesWithHttpInfoAsync (string identifierType, string identifier, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties More...

System.Threading.Tasks.Task< DeleteInstrumentsResponse >	DeleteInstrumentsAsync (List< string > requestBody, string? deleteMode=default(string?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteInstruments: Soft or hard delete multiple instruments More...

System.Threading.Tasks.Task< ApiResponse< DeleteInstrumentsResponse > >	DeleteInstrumentsWithHttpInfoAsync (List< string > requestBody, string? deleteMode=default(string?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteInstruments: Soft or hard delete multiple instruments More...

System.Threading.Tasks.Task< Dictionary< string, List< string > > >	GetAllPossibleFeaturesAsync (string instrumentType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. More...

System.Threading.Tasks.Task< ApiResponse< Dictionary< string, List< string > > > >	GetAllPossibleFeaturesWithHttpInfoAsync (string instrumentType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. More...

System.Threading.Tasks.Task< InstrumentCapabilities >	GetExistingInstrumentCapabilitiesAsync (string identifier, string? model=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. More...

System.Threading.Tasks.Task< ApiResponse< InstrumentCapabilities > >	GetExistingInstrumentCapabilitiesWithHttpInfoAsync (string identifier, string? model=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. More...

System.Threading.Tasks.Task< InstrumentModels >	GetExistingInstrumentModelsAsync (string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. More...

System.Threading.Tasks.Task< ApiResponse< InstrumentModels > >	GetExistingInstrumentModelsWithHttpInfoAsync (string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. More...

System.Threading.Tasks.Task< Instrument >	GetInstrumentAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetInstrument: Get instrument More...

System.Threading.Tasks.Task< ApiResponse< Instrument > >	GetInstrumentWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetInstrument: Get instrument More...

System.Threading.Tasks.Task< ResourceListOfInstrumentIdTypeDescriptor >	GetInstrumentIdentifierTypesAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetInstrumentIdentifierTypes: Get instrument identifier types More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfInstrumentIdTypeDescriptor > >	GetInstrumentIdentifierTypesWithHttpInfoAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetInstrumentIdentifierTypes: Get instrument identifier types More...

System.Threading.Tasks.Task< InstrumentPaymentDiary >	GetInstrumentPaymentDiaryAsync (string identifierType, string identifier, string recipeScope, string recipeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary More...

System.Threading.Tasks.Task< ApiResponse< InstrumentPaymentDiary > >	GetInstrumentPaymentDiaryWithHttpInfoAsync (string identifierType, string identifier, string recipeScope, string recipeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary More...

System.Threading.Tasks.Task< InstrumentProperties >	GetInstrumentPropertiesAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetInstrumentProperties: Get instrument properties More...

System.Threading.Tasks.Task< ApiResponse< InstrumentProperties > >	GetInstrumentPropertiesWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetInstrumentProperties: Get instrument properties More...

System.Threading.Tasks.Task< ResourceListOfPropertyInterval >	GetInstrumentPropertyTimeSeriesAsync (string identifierType, string identifier, string propertyKey, string? identifierEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetInstrumentPropertyTimeSeries: Get instrument property time series More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPropertyInterval > >	GetInstrumentPropertyTimeSeriesWithHttpInfoAsync (string identifierType, string identifier, string propertyKey, string? identifierEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetInstrumentPropertyTimeSeries: Get instrument property time series More...

System.Threading.Tasks.Task< ResourceListOfRelationship >	GetInstrumentRelationshipsAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfRelationship > >	GetInstrumentRelationshipsWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships More...

System.Threading.Tasks.Task< GetInstrumentsResponse >	GetInstrumentsAsync (string identifierType, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetInstruments: Get instruments More...

System.Threading.Tasks.Task< ApiResponse< GetInstrumentsResponse > >	GetInstrumentsWithHttpInfoAsync (string identifierType, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetInstruments: Get instruments More...

System.Threading.Tasks.Task< ResourceListOfProperty >	ListInstrumentPropertiesAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfProperty > >	ListInstrumentPropertiesWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) More...

System.Threading.Tasks.Task< PagedResourceListOfInstrument >	ListInstrumentsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? instrumentPropertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListInstruments: List instruments More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfInstrument > >	ListInstrumentsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? instrumentPropertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListInstruments: List instruments More...

System.Threading.Tasks.Task< InstrumentCapabilities >	QueryInstrumentCapabilitiesAsync (LusidInstrument lusidInstrument, string? model=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. More...

System.Threading.Tasks.Task< ApiResponse< InstrumentCapabilities > >	QueryInstrumentCapabilitiesWithHttpInfoAsync (LusidInstrument lusidInstrument, string? model=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. More...

System.Threading.Tasks.Task< Instrument >	UpdateInstrumentIdentifierAsync (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpdateInstrumentIdentifier: Update instrument identifier More...

System.Threading.Tasks.Task< ApiResponse< Instrument > >	UpdateInstrumentIdentifierWithHttpInfoAsync (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpdateInstrumentIdentifier: Update instrument identifier More...

System.Threading.Tasks.Task< UpsertInstrumentsResponse >	UpsertInstrumentsAsync (Dictionary< string, InstrumentDefinition > requestBody, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpsertInstruments: Upsert instruments More...

System.Threading.Tasks.Task< ApiResponse< UpsertInstrumentsResponse > >	UpsertInstrumentsWithHttpInfoAsync (Dictionary< string, InstrumentDefinition > requestBody, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpsertInstruments: Upsert instruments More...

System.Threading.Tasks.Task< UpsertInstrumentPropertiesResponse >	UpsertInstrumentsPropertiesAsync (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpsertInstrumentsProperties: Upsert instruments properties More...

System.Threading.Tasks.Task< ApiResponse< UpsertInstrumentPropertiesResponse > >	UpsertInstrumentsPropertiesWithHttpInfoAsync (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpsertInstrumentsProperties: Upsert instruments properties 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

◆ BatchUpsertInstrumentPropertiesAsync()

System.Threading.Tasks.Task<BatchUpsertInstrumentPropertiesResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.BatchUpsertInstrumentPropertiesAsync	(	Dictionary< string, UpsertInstrumentPropertyRequest >	requestBody,
		string?	scope = `default(string?)`,
		DateTimeOrCutLabel?	identifierEffectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] BatchUpsertInstrumentProperties: Batch upsert instruments properties

Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an effectiveFrom datetime from which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

requestBody	A list of instruments and associated instrument properties to create or update.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
identifierEffectiveAt	The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified. (optional)
successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of BatchUpsertInstrumentPropertiesResponse

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ BatchUpsertInstrumentPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<BatchUpsertInstrumentPropertiesResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.BatchUpsertInstrumentPropertiesWithHttpInfoAsync	(	Dictionary< string, UpsertInstrumentPropertyRequest >	requestBody,
		string?	scope = `default(string?)`,
		DateTimeOrCutLabel?	identifierEffectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] BatchUpsertInstrumentProperties: Batch upsert instruments properties

Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an effectiveFrom datetime from which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

requestBody	A list of instruments and associated instrument properties to create or update.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
identifierEffectiveAt	The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified. (optional)
successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (BatchUpsertInstrumentPropertiesResponse)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ DeleteInstrumentAsync()

System.Threading.Tasks.Task<DeleteInstrumentResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.DeleteInstrumentAsync	(	string	identifierType,
		string	identifier,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteInstrument: Soft delete a single instrument

Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeleteInstrumentResponse

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ DeleteInstrumentPropertiesAsync()

System.Threading.Tasks.Task<DeleteInstrumentPropertiesResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.DeleteInstrumentPropertiesAsync	(	string	identifierType,
		string	identifier,
		List< string >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties

Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
requestBody	A list of property keys from the 'Instruments' domain whose properties to delete.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeleteInstrumentPropertiesResponse

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ DeleteInstrumentPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeleteInstrumentPropertiesResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.DeleteInstrumentPropertiesWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		List< string >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties

Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
requestBody	A list of property keys from the 'Instruments' domain whose properties to delete.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeleteInstrumentPropertiesResponse)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ DeleteInstrumentsAsync()

System.Threading.Tasks.Task<DeleteInstrumentsResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.DeleteInstrumentsAsync	(	List< string >	requestBody,
		string?	deleteMode = `default(string?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteInstruments: Soft or hard delete multiple instruments

Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000.

Exceptions

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

Parameters

requestBody	The list of lusidInstrumentId's to delete.
deleteMode	The delete mode to use (defaults to 'Soft'). (optional)
scope	The scope in which the instruments lie. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeleteInstrumentsResponse

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ DeleteInstrumentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeleteInstrumentsResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.DeleteInstrumentsWithHttpInfoAsync	(	List< string >	requestBody,
		string?	deleteMode = `default(string?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteInstruments: Soft or hard delete multiple instruments

Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000.

Exceptions

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

Parameters

requestBody	The list of lusidInstrumentId's to delete.
deleteMode	The delete mode to use (defaults to 'Soft'). (optional)
scope	The scope in which the instruments lie. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeleteInstrumentsResponse)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ DeleteInstrumentWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeleteInstrumentResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.DeleteInstrumentWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteInstrument: Soft delete a single instrument

Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeleteInstrumentResponse)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetAllPossibleFeaturesAsync()

System.Threading.Tasks.Task<Dictionary<string, List<string> > > Lusid.Sdk.Api.IInstrumentsApiAsync.GetAllPossibleFeaturesAsync	(	string	instrumentType,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type.

Provides all possible instrument features an instrument of a given type can provide.

Exceptions

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

Parameters

instrumentType	A lusid instrument type e.g. Bond, FxOption.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Dictionary<string, List<string>>

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetAllPossibleFeaturesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Dictionary<string, List<string> > > > Lusid.Sdk.Api.IInstrumentsApiAsync.GetAllPossibleFeaturesWithHttpInfoAsync	(	string	instrumentType,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type.

Provides all possible instrument features an instrument of a given type can provide.

Exceptions

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

Parameters

instrumentType	A lusid instrument type e.g. Bond, FxOption.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Dictionary<string, List<string>>)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetExistingInstrumentCapabilitiesAsync()

System.Threading.Tasks.Task<InstrumentCapabilities> Lusid.Sdk.Api.IInstrumentsApiAsync.GetExistingInstrumentCapabilitiesAsync	(	string	identifier,
		string?	model = `default(string?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	instrumentScope = `default(string?)`,
		string?	recipeScope = `default(string?)`,
		string?	recipeCode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies.

Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS

Exceptions

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

Parameters

identifier	A lusid instrument id identifying the instrument.
model	A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
instrumentScope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
recipeScope	The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default")
recipeCode	A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of InstrumentCapabilities

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetExistingInstrumentCapabilitiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<InstrumentCapabilities> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetExistingInstrumentCapabilitiesWithHttpInfoAsync	(	string	identifier,
		string?	model = `default(string?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	instrumentScope = `default(string?)`,
		string?	recipeScope = `default(string?)`,
		string?	recipeCode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies.

Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS

Exceptions

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

Parameters

identifier	A lusid instrument id identifying the instrument.
model	A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
instrumentScope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
recipeScope	The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default")
recipeCode	A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (InstrumentCapabilities)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetExistingInstrumentModelsAsync()

System.Threading.Tasks.Task<InstrumentModels> Lusid.Sdk.Api.IInstrumentsApiAsync.GetExistingInstrumentModelsAsync	(	string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	instrumentScope = `default(string?)`,
		string?	recipeScope = `default(string?)`,
		string?	recipeCode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID.

Get the supported pricing models of a single instrument.

Exceptions

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

Parameters

identifier	A lusid instrument id identifying the instrument.
effectiveAt	The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
instrumentScope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
recipeScope	The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default")
recipeCode	A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of InstrumentModels

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetExistingInstrumentModelsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<InstrumentModels> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetExistingInstrumentModelsWithHttpInfoAsync	(	string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	instrumentScope = `default(string?)`,
		string?	recipeScope = `default(string?)`,
		string?	recipeCode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID.

Get the supported pricing models of a single instrument.

Exceptions

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

Parameters

identifier	A lusid instrument id identifying the instrument.
effectiveAt	The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
instrumentScope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
recipeScope	The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default")
recipeCode	A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (InstrumentModels)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentAsync()

System.Threading.Tasks.Task<Instrument> Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		string?	scope = `default(string?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetInstrument: Get instrument

Retrieve the definition of a particular instrument, as identified by a particular unique identifier.

Exceptions

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

Parameters

identifierType	The unique identifier type to use, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
effectiveAt	The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
propertyKeys	A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Instrument

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentIdentifierTypesAsync()

System.Threading.Tasks.Task<ResourceListOfInstrumentIdTypeDescriptor> Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentIdentifierTypesAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetInstrumentIdentifierTypes: Get instrument identifier types

Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values).

Exceptions

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

Parameters

operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfInstrumentIdTypeDescriptor

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentIdentifierTypesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfInstrumentIdTypeDescriptor> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentIdentifierTypesWithHttpInfoAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetInstrumentIdentifierTypes: Get instrument identifier types

Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values).

Exceptions

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

Parameters

operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfInstrumentIdTypeDescriptor)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentPaymentDiaryAsync()

System.Threading.Tasks.Task<InstrumentPaymentDiary> Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentPaymentDiaryAsync	(	string	identifierType,
		string	identifier,
		string	recipeScope,
		string	recipeCode,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary

Get the payment diary of a single instrument.

Exceptions

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

Parameters

identifierType	The identifier being supplied e.g. "Figi".
identifier	The value of the identifier for the requested instrument.
recipeScope	The scope of the valuation recipe being used to generate the payment diary
recipeCode	The code of the valuation recipe being used to generate the payment diary
effectiveAt	The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of InstrumentPaymentDiary

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentPaymentDiaryWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<InstrumentPaymentDiary> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentPaymentDiaryWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		string	recipeScope,
		string	recipeCode,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary

Get the payment diary of a single instrument.

Exceptions

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

Parameters

identifierType	The identifier being supplied e.g. "Figi".
identifier	The value of the identifier for the requested instrument.
recipeScope	The scope of the valuation recipe being used to generate the payment diary
recipeCode	The code of the valuation recipe being used to generate the payment diary
effectiveAt	The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (InstrumentPaymentDiary)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentPropertiesAsync()

System.Threading.Tasks.Task<InstrumentProperties> Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentPropertiesAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetInstrumentProperties: Get instrument properties

List all the properties of a particular instrument, as identified by a particular unique identifier.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
effectiveAt	The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of InstrumentProperties

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<InstrumentProperties> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentPropertiesWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetInstrumentProperties: Get instrument properties

List all the properties of a particular instrument, as identified by a particular unique identifier.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
effectiveAt	The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (InstrumentProperties)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentPropertyTimeSeriesAsync()

System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentPropertyTimeSeriesAsync	(	string	identifierType,
		string	identifier,
		string	propertyKey,
		string?	identifierEffectiveAt = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetInstrumentPropertyTimeSeries: Get instrument property time series

Retrieve the complete time series (history) for a particular property of an instrument.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
propertyKey	The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.
identifierEffectiveAt	The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied. (optional)
filter	Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional)
limit	When paginating, limit the results to this number. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentPropertyTimeSeriesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPropertyInterval> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentPropertyTimeSeriesWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		string	propertyKey,
		string?	identifierEffectiveAt = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetInstrumentPropertyTimeSeries: Get instrument property time series

Retrieve the complete time series (history) for a particular property of an instrument.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
propertyKey	The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.
identifierEffectiveAt	The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied. (optional)
filter	Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional)
limit	When paginating, limit the results to this number. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPropertyInterval)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentRelationshipsAsync()

System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentRelationshipsAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List< string >?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships

Get relationships for a particular Instrument.

Exceptions

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

Parameters

identifierType	An identifier type attached to the Instrument.
identifier	The identifier value.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional)
scope	The entity scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfRelationship

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentRelationshipsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfRelationship> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentRelationshipsWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List< string >?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships

Get relationships for a particular Instrument.

Exceptions

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

Parameters

identifierType	An identifier type attached to the Instrument.
identifier	The identifier value.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional)
scope	The entity scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfRelationship)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentsAsync()

System.Threading.Tasks.Task<GetInstrumentsResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentsAsync	(	string	identifierType,
		List< string >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		string?	scope = `default(string?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetInstruments: Get instruments

Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead.

Exceptions

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

Parameters

identifierType	The unique identifier type to use, for example 'Figi'.
requestBody	A list of one or more <i>identifierType</i> values to use to identify instruments.
effectiveAt	The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified. (optional)
propertyKeys	A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of GetInstrumentsResponse

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<GetInstrumentsResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentsWithHttpInfoAsync	(	string	identifierType,
		List< string >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		string?	scope = `default(string?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetInstruments: Get instruments

Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead.

Exceptions

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

Parameters

identifierType	The unique identifier type to use, for example 'Figi'.
requestBody	A list of one or more <i>identifierType</i> values to use to identify instruments.
effectiveAt	The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified. (optional)
propertyKeys	A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (GetInstrumentsResponse)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Instrument> > Lusid.Sdk.Api.IInstrumentsApiAsync.GetInstrumentWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		string?	scope = `default(string?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetInstrument: Get instrument

Retrieve the definition of a particular instrument, as identified by a particular unique identifier.

Exceptions

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

Parameters

identifierType	The unique identifier type to use, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
effectiveAt	The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional)
propertyKeys	A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Instrument)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ ListInstrumentPropertiesAsync()

System.Threading.Tasks.Task<ResourceListOfProperty> Lusid.Sdk.Api.IInstrumentsApiAsync.ListInstrumentPropertiesAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination)

List all the properties of a particular instrument, as identified by a particular unique identifier.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
effectiveAt	The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional)
page	The pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limit	When paginating, limit the results per page to this number. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfProperty

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ ListInstrumentPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfProperty> > Lusid.Sdk.Api.IInstrumentsApiAsync.ListInstrumentPropertiesWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination)

List all the properties of a particular instrument, as identified by a particular unique identifier.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
effectiveAt	The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional)
page	The pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limit	When paginating, limit the results per page to this number. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfProperty)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ ListInstrumentsAsync()

System.Threading.Tasks.Task<PagedResourceListOfInstrument> Lusid.Sdk.Api.IInstrumentsApiAsync.ListInstrumentsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	instrumentPropertyKeys = `default(List< string >?)`,
		string?	scope = `default(string?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListInstruments: List instruments

List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified. (optional)
page	The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the results to this number. (optional)
filter	Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional, default to "State eq 'Active'")
instrumentPropertyKeys	A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfInstrument

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ ListInstrumentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfInstrument> > Lusid.Sdk.Api.IInstrumentsApiAsync.ListInstrumentsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	instrumentPropertyKeys = `default(List< string >?)`,
		string?	scope = `default(string?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListInstruments: List instruments

List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified. (optional)
page	The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the results to this number. (optional)
filter	Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional, default to "State eq 'Active'")
instrumentPropertyKeys	A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfInstrument)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ QueryInstrumentCapabilitiesAsync()

System.Threading.Tasks.Task<InstrumentCapabilities> Lusid.Sdk.Api.IInstrumentsApiAsync.QueryInstrumentCapabilitiesAsync	(	LusidInstrument	lusidInstrument,
		string?	model = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies.

Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS

Exceptions

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

Parameters

lusidInstrument	The definition of the instrument.
model	A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of InstrumentCapabilities

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ QueryInstrumentCapabilitiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<InstrumentCapabilities> > Lusid.Sdk.Api.IInstrumentsApiAsync.QueryInstrumentCapabilitiesWithHttpInfoAsync	(	LusidInstrument	lusidInstrument,
		string?	model = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies.

Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS

Exceptions

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

Parameters

lusidInstrument	The definition of the instrument.
model	A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (InstrumentCapabilities)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpdateInstrumentIdentifierAsync()

System.Threading.Tasks.Task<Instrument> Lusid.Sdk.Api.IInstrumentsApiAsync.UpdateInstrumentIdentifierAsync	(	string	identifierType,
		string	identifier,
		UpdateInstrumentIdentifierRequest	updateInstrumentIdentifierRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpdateInstrumentIdentifier: Update instrument identifier

Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
updateInstrumentIdentifierRequest	The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Instrument

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpdateInstrumentIdentifierWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Instrument> > Lusid.Sdk.Api.IInstrumentsApiAsync.UpdateInstrumentIdentifierWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		UpdateInstrumentIdentifierRequest	updateInstrumentIdentifierRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpdateInstrumentIdentifier: Update instrument identifier

Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not.

Exceptions

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

Parameters

identifierType	The unique identifier type to search, for example 'Figi'.
identifier	An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.
updateInstrumentIdentifierRequest	The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Instrument)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpsertInstrumentsAsync()

System.Threading.Tasks.Task<UpsertInstrumentsResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.UpsertInstrumentsAsync	(	Dictionary< string, InstrumentDefinition >	requestBody,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpsertInstruments: Upsert instruments

Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000.

Exceptions

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

Parameters

requestBody	The definitions of the instruments to create or update.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertInstrumentsResponse

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpsertInstrumentsPropertiesAsync()

System.Threading.Tasks.Task<UpsertInstrumentPropertiesResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.UpsertInstrumentsPropertiesAsync	(	List< UpsertInstrumentPropertyRequest >	upsertInstrumentPropertyRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpsertInstrumentsProperties: Upsert instruments properties

Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an effectiveFrom datetime from which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

upsertInstrumentPropertyRequest	A list of instruments and associated instrument properties to create or update.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertInstrumentPropertiesResponse

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpsertInstrumentsPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertInstrumentPropertiesResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.UpsertInstrumentsPropertiesWithHttpInfoAsync	(	List< UpsertInstrumentPropertyRequest >	upsertInstrumentPropertyRequest,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpsertInstrumentsProperties: Upsert instruments properties

Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an effectiveFrom datetime from which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

upsertInstrumentPropertyRequest	A list of instruments and associated instrument properties to create or update.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertInstrumentPropertiesResponse)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpsertInstrumentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertInstrumentsResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.UpsertInstrumentsWithHttpInfoAsync	(	Dictionary< string, InstrumentDefinition >	requestBody,
		string?	scope = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpsertInstruments: Upsert instruments

Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000.

Exceptions

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

Parameters

requestBody	The definitions of the instruments to create or update.
scope	The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertInstrumentsResponse)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

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/InstrumentsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BatchUpsertInstrumentPropertiesAsync()

◆ BatchUpsertInstrumentPropertiesWithHttpInfoAsync()

◆ DeleteInstrumentAsync()

◆ DeleteInstrumentPropertiesAsync()

◆ DeleteInstrumentPropertiesWithHttpInfoAsync()

◆ DeleteInstrumentsAsync()

◆ DeleteInstrumentsWithHttpInfoAsync()

◆ DeleteInstrumentWithHttpInfoAsync()

◆ GetAllPossibleFeaturesAsync()

◆ GetAllPossibleFeaturesWithHttpInfoAsync()

◆ GetExistingInstrumentCapabilitiesAsync()

◆ GetExistingInstrumentCapabilitiesWithHttpInfoAsync()

◆ GetExistingInstrumentModelsAsync()

◆ GetExistingInstrumentModelsWithHttpInfoAsync()

◆ GetInstrumentAsync()

◆ GetInstrumentIdentifierTypesAsync()

◆ GetInstrumentIdentifierTypesWithHttpInfoAsync()

◆ GetInstrumentPaymentDiaryAsync()

◆ GetInstrumentPaymentDiaryWithHttpInfoAsync()

◆ GetInstrumentPropertiesAsync()

◆ GetInstrumentPropertiesWithHttpInfoAsync()

◆ GetInstrumentPropertyTimeSeriesAsync()

◆ GetInstrumentPropertyTimeSeriesWithHttpInfoAsync()

◆ GetInstrumentRelationshipsAsync()

◆ GetInstrumentRelationshipsWithHttpInfoAsync()

◆ GetInstrumentsAsync()

◆ GetInstrumentsWithHttpInfoAsync()

◆ GetInstrumentWithHttpInfoAsync()

◆ ListInstrumentPropertiesAsync()

◆ ListInstrumentPropertiesWithHttpInfoAsync()

◆ ListInstrumentsAsync()

◆ ListInstrumentsWithHttpInfoAsync()

◆ QueryInstrumentCapabilitiesAsync()

◆ QueryInstrumentCapabilitiesWithHttpInfoAsync()

◆ UpdateInstrumentIdentifierAsync()

◆ UpdateInstrumentIdentifierWithHttpInfoAsync()

◆ UpsertInstrumentsAsync()

◆ UpsertInstrumentsPropertiesAsync()

◆ UpsertInstrumentsPropertiesWithHttpInfoAsync()

◆ UpsertInstrumentsWithHttpInfoAsync()