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

Inheritance diagram for Lusid.Sdk.Api.InstrumentsApi:

[legend]

Public Member Functions
	InstrumentsApi ()
	Initializes a new instance of the InstrumentsApi class. More...

	InstrumentsApi (String basePath)
	Initializes a new instance of the InstrumentsApi class. More...

	InstrumentsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the InstrumentsApi class using Configuration object More...

	InstrumentsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the InstrumentsApi class using a Configuration object and client instance. More...

String	GetBasePath ()
	Gets the base path of the API client. More...

DeleteInstrumentResponse	DeleteInstrument (string identifierType, string identifier)
	[EARLY ACCESS] Delete instrument 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. More...

Lusid.Sdk.Client.ApiResponse< DeleteInstrumentResponse >	DeleteInstrumentWithHttpInfo (string identifierType, string identifier)
	[EARLY ACCESS] Delete instrument 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. More...

async System.Threading.Tasks.Task< DeleteInstrumentResponse >	DeleteInstrumentAsync (string identifierType, string identifier, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete instrument 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeleteInstrumentResponse > >	DeleteInstrumentWithHttpInfoAsync (string identifierType, string identifier, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete instrument 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. More...

Instrument	GetInstrument (string identifierType, string identifier, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >))
	Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier. More...

Lusid.Sdk.Client.ApiResponse< Instrument >	GetInstrumentWithHttpInfo (string identifierType, string identifier, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >))
	Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier. More...

async System.Threading.Tasks.Task< Instrument >	GetInstrumentAsync (string identifierType, string identifier, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Instrument > >	GetInstrumentWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier. More...

ResourceListOfInstrumentIdTypeDescriptor	GetInstrumentIdentifierTypes ()
	[EARLY ACCESS] 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). More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfInstrumentIdTypeDescriptor >	GetInstrumentIdentifierTypesWithHttpInfo ()
	[EARLY ACCESS] 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). More...

async System.Threading.Tasks.Task< ResourceListOfInstrumentIdTypeDescriptor >	GetInstrumentIdentifierTypesAsync (System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] 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). More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfInstrumentIdTypeDescriptor > >	GetInstrumentIdentifierTypesWithHttpInfoAsync (System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] 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). More...

ResourceListOfPropertyInterval	GetInstrumentPropertyTimeSeries (string identifierType, string identifier, string propertyKey=default(string), string identifierEffectiveAt=default(string), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), string page=default(string), int? limit=default(int?))
	[EARLY ACCESS] Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyInterval >	GetInstrumentPropertyTimeSeriesWithHttpInfo (string identifierType, string identifier, string propertyKey=default(string), string identifierEffectiveAt=default(string), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), string page=default(string), int? limit=default(int?))
	[EARLY ACCESS] Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument. More...

async System.Threading.Tasks.Task< ResourceListOfPropertyInterval >	GetInstrumentPropertyTimeSeriesAsync (string identifierType, string identifier, string propertyKey=default(string), string identifierEffectiveAt=default(string), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), string page=default(string), int? limit=default(int?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyInterval > >	GetInstrumentPropertyTimeSeriesWithHttpInfoAsync (string identifierType, string identifier, string propertyKey=default(string), string identifierEffectiveAt=default(string), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), string page=default(string), int? limit=default(int?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument. More...

GetInstrumentsResponse	GetInstruments (string identifierType, List< string > requestBody, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >))
	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. More...

Lusid.Sdk.Client.ApiResponse< GetInstrumentsResponse >	GetInstrumentsWithHttpInfo (string identifierType, List< string > requestBody, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >))
	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. More...

async 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 >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< GetInstrumentsResponse > >	GetInstrumentsWithHttpInfoAsync (string identifierType, List< string > requestBody, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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. More...

PagedResourceListOfInstrument	ListInstruments (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), string page=default(string), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > instrumentPropertyKeys=default(List< string >))
	[EARLY ACCESS] 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. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfInstrument >	ListInstrumentsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), string page=default(string), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > instrumentPropertyKeys=default(List< string >))
	[EARLY ACCESS] 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. More...

async 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? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > instrumentPropertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfInstrument > >	ListInstrumentsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), string page=default(string), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > instrumentPropertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] 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. More...

Instrument	UpdateInstrumentIdentifier (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest)
	[EARLY ACCESS] 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. More...

Lusid.Sdk.Client.ApiResponse< Instrument >	UpdateInstrumentIdentifierWithHttpInfo (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest)
	[EARLY ACCESS] 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. More...

async System.Threading.Tasks.Task< Instrument >	UpdateInstrumentIdentifierAsync (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Instrument > >	UpdateInstrumentIdentifierWithHttpInfoAsync (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] 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. More...

UpsertInstrumentsResponse	UpsertInstruments (Dictionary< string, InstrumentDefinition > requestBody)
	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. More...

Lusid.Sdk.Client.ApiResponse< UpsertInstrumentsResponse >	UpsertInstrumentsWithHttpInfo (Dictionary< string, InstrumentDefinition > requestBody)
	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. More...

async System.Threading.Tasks.Task< UpsertInstrumentsResponse >	UpsertInstrumentsAsync (Dictionary< string, InstrumentDefinition > requestBody, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertInstrumentsResponse > >	UpsertInstrumentsWithHttpInfoAsync (Dictionary< string, InstrumentDefinition > requestBody, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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. More...

UpsertInstrumentPropertiesResponse	UpsertInstrumentsProperties (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest)
	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 <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

Lusid.Sdk.Client.ApiResponse< UpsertInstrumentPropertiesResponse >	UpsertInstrumentsPropertiesWithHttpInfo (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest)
	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 <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

async System.Threading.Tasks.Task< UpsertInstrumentPropertiesResponse >	UpsertInstrumentsPropertiesAsync (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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 <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertInstrumentPropertiesResponse > >	UpsertInstrumentsPropertiesWithHttpInfoAsync (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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 <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

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

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

Constructor & Destructor Documentation

◆ InstrumentsApi() [1/4]

Lusid.Sdk.Api.InstrumentsApi.InstrumentsApi ( )

inline

Initializes a new instance of the InstrumentsApi class.

Returns

◆ InstrumentsApi() [2/4]

Lusid.Sdk.Api.InstrumentsApi.InstrumentsApi ( String basePath )

inline

Initializes a new instance of the InstrumentsApi class.

Returns

◆ InstrumentsApi() [3/4]

Lusid.Sdk.Api.InstrumentsApi.InstrumentsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the InstrumentsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ InstrumentsApi() [4/4]

Lusid.Sdk.Api.InstrumentsApi.InstrumentsApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the InstrumentsApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ DeleteInstrument()

DeleteInstrumentResponse Lusid.Sdk.Api.InstrumentsApi.DeleteInstrument	(	string	identifierType,
		string	identifier
	)

inline

[EARLY ACCESS] Delete instrument 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'.

Returns: DeleteInstrumentResponse

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ DeleteInstrumentAsync()

async System.Threading.Tasks.Task<DeleteInstrumentResponse> Lusid.Sdk.Api.InstrumentsApi.DeleteInstrumentAsync	(	string	identifierType,
		string	identifier,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Delete instrument 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'.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeleteInstrumentResponse

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ DeleteInstrumentWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeleteInstrumentResponse> Lusid.Sdk.Api.InstrumentsApi.DeleteInstrumentWithHttpInfo	(	string	identifierType,
		string	identifier
	)

inline

[EARLY ACCESS] Delete instrument 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'.

Returns: ApiResponse of DeleteInstrumentResponse

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ DeleteInstrumentWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeleteInstrumentResponse> > Lusid.Sdk.Api.InstrumentsApi.DeleteInstrumentWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Delete instrument 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'.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeleteInstrumentResponse)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ GetBasePath()

String Lusid.Sdk.Api.InstrumentsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetInstrument()

Instrument Lusid.Sdk.Api.InstrumentsApi.GetInstrument	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List<string>)`
	)

inline

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. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)

Returns: Instrument

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ GetInstrumentAsync()

async System.Threading.Tasks.Task<Instrument> Lusid.Sdk.Api.InstrumentsApi.GetInstrumentAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List<string>)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Instrument

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ GetInstrumentIdentifierTypes()

ResourceListOfInstrumentIdTypeDescriptor Lusid.Sdk.Api.InstrumentsApi.GetInstrumentIdentifierTypes ( )

inline

[EARLY ACCESS] 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

Returns: ResourceListOfInstrumentIdTypeDescriptor

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ GetInstrumentIdentifierTypesAsync()

async System.Threading.Tasks.Task<ResourceListOfInstrumentIdTypeDescriptor> Lusid.Sdk.Api.InstrumentsApi.GetInstrumentIdentifierTypesAsync ( System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken) )

inline

[EARLY ACCESS] 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

cancellationToken Cancellation Token to cancel the request.

Returns: Task of ResourceListOfInstrumentIdTypeDescriptor

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ GetInstrumentIdentifierTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfInstrumentIdTypeDescriptor> Lusid.Sdk.Api.InstrumentsApi.GetInstrumentIdentifierTypesWithHttpInfo ( )

inline

[EARLY ACCESS] 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

Returns: ApiResponse of ResourceListOfInstrumentIdTypeDescriptor

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ GetInstrumentIdentifierTypesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfInstrumentIdTypeDescriptor> > Lusid.Sdk.Api.InstrumentsApi.GetInstrumentIdentifierTypesWithHttpInfoAsync ( System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken) )

inline

[EARLY ACCESS] 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

cancellationToken Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfInstrumentIdTypeDescriptor)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ GetInstrumentPropertyTimeSeries()

ResourceListOfPropertyInterval Lusid.Sdk.Api.InstrumentsApi.GetInstrumentPropertyTimeSeries	(	string	identifierType,
		string	identifier,
		string	propertyKey = `default(string)`,
		string	identifierEffectiveAt = `default(string)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		string	page = `default(string)`,
		int?	limit = `default(int?)`
	)

inline

[EARLY ACCESS] 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'. (optional)
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)

Returns: ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ GetInstrumentPropertyTimeSeriesAsync()

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

inline

[EARLY ACCESS] 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'. (optional)
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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ GetInstrumentPropertyTimeSeriesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.InstrumentsApi.GetInstrumentPropertyTimeSeriesWithHttpInfo	(	string	identifierType,
		string	identifier,
		string	propertyKey = `default(string)`,
		string	identifierEffectiveAt = `default(string)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	filter = `default(string)`,
		string	page = `default(string)`,
		int?	limit = `default(int?)`
	)

inline

[EARLY ACCESS] 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'. (optional)
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)

Returns: ApiResponse of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ GetInstrumentPropertyTimeSeriesWithHttpInfoAsync()

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

inline

[EARLY ACCESS] 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'. (optional)
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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPropertyInterval)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ GetInstruments()

GetInstrumentsResponse Lusid.Sdk.Api.InstrumentsApi.GetInstruments	(	string	identifierType,
		List< string >	requestBody,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List<string>)`
	)

inline

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 the instrument. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)

Returns: GetInstrumentsResponse

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ GetInstrumentsAsync()

async System.Threading.Tasks.Task<GetInstrumentsResponse> Lusid.Sdk.Api.InstrumentsApi.GetInstrumentsAsync	(	string	identifierType,
		List< string >	requestBody,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List<string>)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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 the instrument. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of GetInstrumentsResponse

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ GetInstrumentsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GetInstrumentsResponse> Lusid.Sdk.Api.InstrumentsApi.GetInstrumentsWithHttpInfo	(	string	identifierType,
		List< string >	requestBody,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List<string>)`
	)

inline

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 the instrument. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)

Returns: ApiResponse of GetInstrumentsResponse

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ GetInstrumentsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<GetInstrumentsResponse> > Lusid.Sdk.Api.InstrumentsApi.GetInstrumentsWithHttpInfoAsync	(	string	identifierType,
		List< string >	requestBody,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List<string>)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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 the instrument. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (GetInstrumentsResponse)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ GetInstrumentWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Instrument> Lusid.Sdk.Api.InstrumentsApi.GetInstrumentWithHttpInfo	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List<string>)`
	)

inline

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. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)

Returns: ApiResponse of Instrument

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ GetInstrumentWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Instrument> > Lusid.Sdk.Api.InstrumentsApi.GetInstrumentWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List<string>)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Instrument)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ ListInstruments()

PagedResourceListOfInstrument Lusid.Sdk.Api.InstrumentsApi.ListInstruments	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		string	page = `default(string)`,
		List< string >	sortBy = `default(List<string>)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	instrumentPropertyKeys = `default(List<string>)`
	)

inline

[EARLY ACCESS] 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. Also, a <i>start</i> value cannot be provided. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional)
sortBy	Order results by particular fields. Use the '-' sign to denote descending order, for example '-MyFieldName'. (optional)
start	When paginating, skip this number of results. (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. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)

Returns: PagedResourceListOfInstrument

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ ListInstrumentsAsync()

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

inline

[EARLY ACCESS] 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. Also, a <i>start</i> value cannot be provided. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional)
sortBy	Order results by particular fields. Use the '-' sign to denote descending order, for example '-MyFieldName'. (optional)
start	When paginating, skip this number of results. (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. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfInstrument

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ ListInstrumentsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfInstrument> Lusid.Sdk.Api.InstrumentsApi.ListInstrumentsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		string	page = `default(string)`,
		List< string >	sortBy = `default(List<string>)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	instrumentPropertyKeys = `default(List<string>)`
	)

inline

[EARLY ACCESS] 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. Also, a <i>start</i> value cannot be provided. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional)
sortBy	Order results by particular fields. Use the '-' sign to denote descending order, for example '-MyFieldName'. (optional)
start	When paginating, skip this number of results. (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. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)

Returns: ApiResponse of PagedResourceListOfInstrument

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ ListInstrumentsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfInstrument> > Lusid.Sdk.Api.InstrumentsApi.ListInstrumentsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel	effectiveAt = `default(DateTimeOrCutLabel)`,
		string	page = `default(string)`,
		List< string >	sortBy = `default(List<string>)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	instrumentPropertyKeys = `default(List<string>)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] 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. Also, a <i>start</i> value cannot be provided. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional)
sortBy	Order results by particular fields. Use the '-' sign to denote descending order, for example '-MyFieldName'. (optional)
start	When paginating, skip this number of results. (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. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfInstrument)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ UpdateInstrumentIdentifier()

Instrument Lusid.Sdk.Api.InstrumentsApi.UpdateInstrumentIdentifier	(	string	identifierType,
		string	identifier,
		UpdateInstrumentIdentifierRequest	updateInstrumentIdentifierRequest
	)

inline

[EARLY ACCESS] 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.

Returns: Instrument

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ UpdateInstrumentIdentifierAsync()

async System.Threading.Tasks.Task<Instrument> Lusid.Sdk.Api.InstrumentsApi.UpdateInstrumentIdentifierAsync	(	string	identifierType,
		string	identifier,
		UpdateInstrumentIdentifierRequest	updateInstrumentIdentifierRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] 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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Instrument

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ UpdateInstrumentIdentifierWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Instrument> Lusid.Sdk.Api.InstrumentsApi.UpdateInstrumentIdentifierWithHttpInfo	(	string	identifierType,
		string	identifier,
		UpdateInstrumentIdentifierRequest	updateInstrumentIdentifierRequest
	)

inline

[EARLY ACCESS] 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.

Returns: ApiResponse of Instrument

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ UpdateInstrumentIdentifierWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Instrument> > Lusid.Sdk.Api.InstrumentsApi.UpdateInstrumentIdentifierWithHttpInfoAsync	(	string	identifierType,
		string	identifier,
		UpdateInstrumentIdentifierRequest	updateInstrumentIdentifierRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] 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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Instrument)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ UpsertInstruments()

UpsertInstrumentsResponse Lusid.Sdk.Api.InstrumentsApi.UpsertInstruments ( Dictionary< string, InstrumentDefinition > requestBody )

inline

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.

Returns: UpsertInstrumentsResponse

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ UpsertInstrumentsAsync()

async System.Threading.Tasks.Task<UpsertInstrumentsResponse> Lusid.Sdk.Api.InstrumentsApi.UpsertInstrumentsAsync	(	Dictionary< string, InstrumentDefinition >	requestBody,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertInstrumentsResponse

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ UpsertInstrumentsProperties()

UpsertInstrumentPropertiesResponse Lusid.Sdk.Api.InstrumentsApi.UpsertInstrumentsProperties ( List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest )

inline

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.

Returns: UpsertInstrumentPropertiesResponse

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ UpsertInstrumentsPropertiesAsync()

async System.Threading.Tasks.Task<UpsertInstrumentPropertiesResponse> Lusid.Sdk.Api.InstrumentsApi.UpsertInstrumentsPropertiesAsync	(	List< UpsertInstrumentPropertyRequest >	upsertInstrumentPropertyRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertInstrumentPropertiesResponse

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ UpsertInstrumentsPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertInstrumentPropertiesResponse> Lusid.Sdk.Api.InstrumentsApi.UpsertInstrumentsPropertiesWithHttpInfo ( List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest )

inline

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.

Returns: ApiResponse of UpsertInstrumentPropertiesResponse

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ UpsertInstrumentsPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertInstrumentPropertiesResponse> > Lusid.Sdk.Api.InstrumentsApi.UpsertInstrumentsPropertiesWithHttpInfoAsync	(	List< UpsertInstrumentPropertyRequest >	upsertInstrumentPropertyRequest,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertInstrumentPropertiesResponse)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

◆ UpsertInstrumentsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertInstrumentsResponse> Lusid.Sdk.Api.InstrumentsApi.UpsertInstrumentsWithHttpInfo ( Dictionary< string, InstrumentDefinition > requestBody )

inline

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.

Returns: ApiResponse of UpsertInstrumentsResponse

Implements Lusid.Sdk.Api.IInstrumentsApiSync.

◆ UpsertInstrumentsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertInstrumentsResponse> > Lusid.Sdk.Api.InstrumentsApi.UpsertInstrumentsWithHttpInfoAsync	(	Dictionary< string, InstrumentDefinition >	requestBody,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertInstrumentsResponse)

Implements Lusid.Sdk.Api.IInstrumentsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.InstrumentsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.InstrumentsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.InstrumentsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.InstrumentsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentsApi() [1/4]

◆ InstrumentsApi() [2/4]

◆ InstrumentsApi() [3/4]

◆ InstrumentsApi() [4/4]

Member Function Documentation

◆ DeleteInstrument()

◆ DeleteInstrumentAsync()

◆ DeleteInstrumentWithHttpInfo()

◆ DeleteInstrumentWithHttpInfoAsync()

◆ GetBasePath()

◆ GetInstrument()

◆ GetInstrumentAsync()

◆ GetInstrumentIdentifierTypes()

◆ GetInstrumentIdentifierTypesAsync()

◆ GetInstrumentIdentifierTypesWithHttpInfo()

◆ GetInstrumentIdentifierTypesWithHttpInfoAsync()

◆ GetInstrumentPropertyTimeSeries()

◆ GetInstrumentPropertyTimeSeriesAsync()

◆ GetInstrumentPropertyTimeSeriesWithHttpInfo()

◆ GetInstrumentPropertyTimeSeriesWithHttpInfoAsync()

◆ GetInstruments()

◆ GetInstrumentsAsync()

◆ GetInstrumentsWithHttpInfo()

◆ GetInstrumentsWithHttpInfoAsync()

◆ GetInstrumentWithHttpInfo()

◆ GetInstrumentWithHttpInfoAsync()

◆ ListInstruments()

◆ ListInstrumentsAsync()

◆ ListInstrumentsWithHttpInfo()

◆ ListInstrumentsWithHttpInfoAsync()

◆ UpdateInstrumentIdentifier()

◆ UpdateInstrumentIdentifierAsync()

◆ UpdateInstrumentIdentifierWithHttpInfo()

◆ UpdateInstrumentIdentifierWithHttpInfoAsync()

◆ UpsertInstruments()

◆ UpsertInstrumentsAsync()

◆ UpsertInstrumentsProperties()

◆ UpsertInstrumentsPropertiesAsync()

◆ UpsertInstrumentsPropertiesWithHttpInfo()

◆ UpsertInstrumentsPropertiesWithHttpInfoAsync()

◆ UpsertInstrumentsWithHttpInfo()

◆ UpsertInstrumentsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory