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

Inheritance diagram for Lusid.Sdk.Api.IInstrumentsApiAsync:

Public Member Functions
System.Threading.Tasks.Task< DeleteInstrumentResponse >	DeleteInstrumentAsync (string identifierType, string identifier, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete instrument More...

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

System.Threading.Tasks.Task< ResourceListOfInstrumentIdTypeDescriptor >	GetInstrumentIdentifierTypesAsync (System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get instrument identifier types More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfInstrumentIdTypeDescriptor > >	GetInstrumentIdentifierTypesWithHttpInfoAsync (System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get instrument identifier types More...

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 More...

System.Threading.Tasks.Task< 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 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 >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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 >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Get instruments 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? 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 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? 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 More...

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 More...

System.Threading.Tasks.Task< ApiResponse< Instrument > >	UpdateInstrumentIdentifierWithHttpInfoAsync (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Update instrument identifier More...

System.Threading.Tasks.Task< UpsertInstrumentsResponse >	UpsertInstrumentsAsync (Dictionary< string, InstrumentDefinition > requestBody, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert instruments More...

System.Threading.Tasks.Task< ApiResponse< UpsertInstrumentsResponse > >	UpsertInstrumentsWithHttpInfoAsync (Dictionary< string, InstrumentDefinition > requestBody, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert instruments More...

System.Threading.Tasks.Task< UpsertInstrumentPropertiesResponse >	UpsertInstrumentsPropertiesAsync (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Upsert instruments properties More...

System.Threading.Tasks.Task< ApiResponse< UpsertInstrumentPropertiesResponse > >	UpsertInstrumentsPropertiesWithHttpInfoAsync (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	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

◆ DeleteInstrumentAsync()

System.Threading.Tasks.Task<DeleteInstrumentResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ DeleteInstrumentWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeleteInstrumentResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.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.

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)

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

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

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentIdentifierTypesAsync()

System.Threading.Tasks.Task<ResourceListOfInstrumentIdTypeDescriptor> Lusid.Sdk.Api.IInstrumentsApiAsync.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).

Exceptions

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

Parameters

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 ( 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).

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)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentPropertyTimeSeriesAsync()

System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.IInstrumentsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ GetInstrumentPropertyTimeSeriesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPropertyInterval> > Lusid.Sdk.Api.IInstrumentsApiAsync.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.

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)

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 >)`,
		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.

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

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 >)`,
		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.

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)

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

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)

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?	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.

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

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?	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.

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)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpdateInstrumentIdentifierAsync()

System.Threading.Tasks.Task<Instrument> Lusid.Sdk.Api.IInstrumentsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpdateInstrumentIdentifierWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Instrument> > Lusid.Sdk.Api.IInstrumentsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpsertInstrumentsAsync()

System.Threading.Tasks.Task<UpsertInstrumentsResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpsertInstrumentsPropertiesAsync()

System.Threading.Tasks.Task<UpsertInstrumentPropertiesResponse> Lusid.Sdk.Api.IInstrumentsApiAsync.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 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

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpsertInstrumentsPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertInstrumentPropertiesResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.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 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)

Implemented in Lusid.Sdk.Api.InstrumentsApi.

◆ UpsertInstrumentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertInstrumentsResponse> > Lusid.Sdk.Api.IInstrumentsApiAsync.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.

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)

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/stable/sdk/Lusid.Sdk/Api/InstrumentsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteInstrumentAsync()

◆ DeleteInstrumentWithHttpInfoAsync()

◆ GetInstrumentAsync()

◆ GetInstrumentIdentifierTypesAsync()

◆ GetInstrumentIdentifierTypesWithHttpInfoAsync()

◆ GetInstrumentPropertyTimeSeriesAsync()

◆ GetInstrumentPropertyTimeSeriesWithHttpInfoAsync()

◆ GetInstrumentsAsync()

◆ GetInstrumentsWithHttpInfoAsync()

◆ GetInstrumentWithHttpInfoAsync()

◆ ListInstrumentsAsync()

◆ ListInstrumentsWithHttpInfoAsync()

◆ UpdateInstrumentIdentifierAsync()

◆ UpdateInstrumentIdentifierWithHttpInfoAsync()

◆ UpsertInstrumentsAsync()

◆ UpsertInstrumentsPropertiesAsync()

◆ UpsertInstrumentsPropertiesWithHttpInfoAsync()

◆ UpsertInstrumentsWithHttpInfoAsync()