LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
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... | |
BatchUpsertInstrumentPropertiesResponse | BatchUpsertInstrumentProperties (Dictionary< string, UpsertInstrumentPropertyRequest > requestBody, string? scope=default(string?), DateTimeOrCutLabel? identifierEffectiveAt=default(DateTimeOrCutLabel?), string? successMode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
BatchUpsertInstrumentProperties: Batch upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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< BatchUpsertInstrumentPropertiesResponse > | BatchUpsertInstrumentPropertiesWithHttpInfo (Dictionary< string, UpsertInstrumentPropertyRequest > requestBody, string? scope=default(string?), DateTimeOrCutLabel? identifierEffectiveAt=default(DateTimeOrCutLabel?), string? successMode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
BatchUpsertInstrumentProperties: Batch upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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< BatchUpsertInstrumentPropertiesResponse > | BatchUpsertInstrumentPropertiesAsync (Dictionary< string, UpsertInstrumentPropertyRequest > requestBody, string? scope=default(string?), DateTimeOrCutLabel? identifierEffectiveAt=default(DateTimeOrCutLabel?), string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
BatchUpsertInstrumentProperties: Batch upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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< BatchUpsertInstrumentPropertiesResponse > > | BatchUpsertInstrumentPropertiesWithHttpInfoAsync (Dictionary< string, UpsertInstrumentPropertyRequest > requestBody, string? scope=default(string?), DateTimeOrCutLabel? identifierEffectiveAt=default(DateTimeOrCutLabel?), string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
BatchUpsertInstrumentProperties: Batch upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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... | |
AddBusinessDaysToDateResponse | CalculateSettlementDate (string identifierType, string identifier, DateTimeOrCutLabel? transactionDate=default(DateTimeOrCutLabel?), string? scope=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime. More... | |
Lusid.Sdk.Client.ApiResponse< AddBusinessDaysToDateResponse > | CalculateSettlementDateWithHttpInfo (string identifierType, string identifier, DateTimeOrCutLabel? transactionDate=default(DateTimeOrCutLabel?), string? scope=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime. More... | |
async System.Threading.Tasks.Task< AddBusinessDaysToDateResponse > | CalculateSettlementDateAsync (string identifierType, string identifier, DateTimeOrCutLabel? transactionDate=default(DateTimeOrCutLabel?), string? scope=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AddBusinessDaysToDateResponse > > | CalculateSettlementDateWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel? transactionDate=default(DateTimeOrCutLabel?), string? scope=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime. More... | |
DeleteInstrumentResponse | DeleteInstrument (string identifierType, string identifier, string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
DeleteInstrument: Soft delete a single instrument Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument. More... | |
Lusid.Sdk.Client.ApiResponse< DeleteInstrumentResponse > | DeleteInstrumentWithHttpInfo (string identifierType, string identifier, string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
DeleteInstrument: Soft delete a single instrument Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument. More... | |
async System.Threading.Tasks.Task< DeleteInstrumentResponse > | DeleteInstrumentAsync (string identifierType, string identifier, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
DeleteInstrument: Soft delete a single instrument Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeleteInstrumentResponse > > | DeleteInstrumentWithHttpInfoAsync (string identifierType, string identifier, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
DeleteInstrument: Soft delete a single instrument Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument. More... | |
DeleteInstrumentPropertiesResponse | DeleteInstrumentProperties (string identifierType, string identifier, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. More... | |
Lusid.Sdk.Client.ApiResponse< DeleteInstrumentPropertiesResponse > | DeleteInstrumentPropertiesWithHttpInfo (string identifierType, string identifier, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. More... | |
async System.Threading.Tasks.Task< DeleteInstrumentPropertiesResponse > | DeleteInstrumentPropertiesAsync (string identifierType, string identifier, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeleteInstrumentPropertiesResponse > > | DeleteInstrumentPropertiesWithHttpInfoAsync (string identifierType, string identifier, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. More... | |
DeleteInstrumentsResponse | DeleteInstruments (List< string > requestBody, string? deleteMode=default(string?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
DeleteInstruments: Soft or hard delete multiple instruments Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000. More... | |
Lusid.Sdk.Client.ApiResponse< DeleteInstrumentsResponse > | DeleteInstrumentsWithHttpInfo (List< string > requestBody, string? deleteMode=default(string?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
DeleteInstruments: Soft or hard delete multiple instruments Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000. More... | |
async System.Threading.Tasks.Task< DeleteInstrumentsResponse > | DeleteInstrumentsAsync (List< string > requestBody, string? deleteMode=default(string?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
DeleteInstruments: Soft or hard delete multiple instruments Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeleteInstrumentsResponse > > | DeleteInstrumentsWithHttpInfoAsync (List< string > requestBody, string? deleteMode=default(string?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
DeleteInstruments: Soft or hard delete multiple instruments Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000. More... | |
Dictionary< string, List< string > > | GetAllPossibleFeatures (string instrumentType, int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. Provides all possible instrument features an instrument of a given type can provide. More... | |
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< string > > > | GetAllPossibleFeaturesWithHttpInfo (string instrumentType, int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. Provides all possible instrument features an instrument of a given type can provide. More... | |
async System.Threading.Tasks.Task< Dictionary< string, List< string > > > | GetAllPossibleFeaturesAsync (string instrumentType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. Provides all possible instrument features an instrument of a given type can provide. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< string > > > > | GetAllPossibleFeaturesWithHttpInfoAsync (string instrumentType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. Provides all possible instrument features an instrument of a given type can provide. More... | |
InstrumentCapabilities | GetExistingInstrumentCapabilities (string identifier, string? model=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More... | |
Lusid.Sdk.Client.ApiResponse< InstrumentCapabilities > | GetExistingInstrumentCapabilitiesWithHttpInfo (string identifier, string? model=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More... | |
async System.Threading.Tasks.Task< InstrumentCapabilities > | GetExistingInstrumentCapabilitiesAsync (string identifier, string? model=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< InstrumentCapabilities > > | GetExistingInstrumentCapabilitiesWithHttpInfoAsync (string identifier, string? model=default(string?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More... | |
InstrumentModels | GetExistingInstrumentModels (string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. Get the supported pricing models of a single instrument. More... | |
Lusid.Sdk.Client.ApiResponse< InstrumentModels > | GetExistingInstrumentModelsWithHttpInfo (string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. Get the supported pricing models of a single instrument. More... | |
async System.Threading.Tasks.Task< InstrumentModels > | GetExistingInstrumentModelsAsync (string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. Get the supported pricing models of a single instrument. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< InstrumentModels > > | GetExistingInstrumentModelsWithHttpInfoAsync (string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? instrumentScope=default(string?), string? recipeScope=default(string?), string? recipeCode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. Get the supported pricing models of a single instrument. More... | |
Instrument | GetInstrument (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstrument: 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 >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstrument: 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 >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstrument: 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 >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstrument: Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier. More... | |
ResourceListOfInstrumentIdTypeDescriptor | GetInstrumentIdentifierTypes (int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstrumentIdentifierTypes: Get instrument identifier types Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values). More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfInstrumentIdTypeDescriptor > | GetInstrumentIdentifierTypesWithHttpInfo (int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstrumentIdentifierTypes: Get instrument identifier types Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values). More... | |
async System.Threading.Tasks.Task< ResourceListOfInstrumentIdTypeDescriptor > | GetInstrumentIdentifierTypesAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstrumentIdentifierTypes: Get instrument identifier types Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values). More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfInstrumentIdTypeDescriptor > > | GetInstrumentIdentifierTypesWithHttpInfoAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstrumentIdentifierTypes: Get instrument identifier types Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values). More... | |
InstrumentPaymentDiary | GetInstrumentPaymentDiary (string identifierType, string identifier, string recipeScope, string recipeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary Get the payment diary of a single instrument. More... | |
Lusid.Sdk.Client.ApiResponse< InstrumentPaymentDiary > | GetInstrumentPaymentDiaryWithHttpInfo (string identifierType, string identifier, string recipeScope, string recipeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary Get the payment diary of a single instrument. More... | |
async System.Threading.Tasks.Task< InstrumentPaymentDiary > | GetInstrumentPaymentDiaryAsync (string identifierType, string identifier, string recipeScope, string recipeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary Get the payment diary of a single instrument. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< InstrumentPaymentDiary > > | GetInstrumentPaymentDiaryWithHttpInfoAsync (string identifierType, string identifier, string recipeScope, string recipeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary Get the payment diary of a single instrument. More... | |
InstrumentProperties | GetInstrumentProperties (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstrumentProperties: Get instrument properties List all the properties of a particular instrument, as identified by a particular unique identifier. More... | |
Lusid.Sdk.Client.ApiResponse< InstrumentProperties > | GetInstrumentPropertiesWithHttpInfo (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstrumentProperties: Get instrument properties List all the properties of a particular instrument, as identified by a particular unique identifier. More... | |
async System.Threading.Tasks.Task< InstrumentProperties > | GetInstrumentPropertiesAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstrumentProperties: Get instrument properties List all the properties of a particular instrument, as identified by a particular unique identifier. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< InstrumentProperties > > | GetInstrumentPropertiesWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstrumentProperties: Get instrument properties List all the properties of a particular instrument, as identified by a particular unique identifier. More... | |
ResourceListOfPropertyInterval | GetInstrumentPropertyTimeSeries (string identifierType, string identifier, string propertyKey, string? identifierEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstrumentPropertyTimeSeries: 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, string? identifierEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstrumentPropertyTimeSeries: 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, string? identifierEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstrumentPropertyTimeSeries: 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, string? identifierEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstrumentPropertyTimeSeries: Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument. More... | |
ResourceListOfRelationship | GetInstrumentRelationships (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships Get relationships for a particular Instrument. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > | GetInstrumentRelationshipsWithHttpInfo (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships Get relationships for a particular Instrument. More... | |
async System.Threading.Tasks.Task< ResourceListOfRelationship > | GetInstrumentRelationshipsAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships Get relationships for a particular Instrument. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > > | GetInstrumentRelationshipsWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships Get relationships for a particular Instrument. More... | |
GetInstrumentsResponse | GetInstruments (string identifierType, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstruments: Get instruments Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead. 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 >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetInstruments: Get instruments Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead. 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 >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstruments: Get instruments Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead. 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 >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
GetInstruments: Get instruments Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead. More... | |
ResourceListOfProperty | ListInstrumentProperties (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) List all the properties of a particular instrument, as identified by a particular unique identifier. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfProperty > | ListInstrumentPropertiesWithHttpInfo (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) List all the properties of a particular instrument, as identified by a particular unique identifier. More... | |
async System.Threading.Tasks.Task< ResourceListOfProperty > | ListInstrumentPropertiesAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) List all the properties of a particular instrument, as identified by a particular unique identifier. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfProperty > > | ListInstrumentPropertiesWithHttpInfoAsync (string identifierType, string identifier, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) List all the properties of a particular instrument, as identified by a particular unique identifier. More... | |
PagedResourceListOfInstrument | ListInstruments (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? instrumentPropertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
ListInstruments: List instruments List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000. 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? limit=default(int?), string? filter=default(string?), List< string >? instrumentPropertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null) |
ListInstruments: List instruments List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000. 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? limit=default(int?), string? filter=default(string?), List< string >? instrumentPropertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
ListInstruments: List instruments List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000. 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? limit=default(int?), string? filter=default(string?), List< string >? instrumentPropertyKeys=default(List< string >?), string? scope=default(string?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
ListInstruments: List instruments List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000. More... | |
InstrumentCapabilities | QueryInstrumentCapabilities (LusidInstrument lusidInstrument, string? model=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More... | |
Lusid.Sdk.Client.ApiResponse< InstrumentCapabilities > | QueryInstrumentCapabilitiesWithHttpInfo (LusidInstrument lusidInstrument, string? model=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More... | |
async System.Threading.Tasks.Task< InstrumentCapabilities > | QueryInstrumentCapabilitiesAsync (LusidInstrument lusidInstrument, string? model=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< InstrumentCapabilities > > | QueryInstrumentCapabilitiesWithHttpInfoAsync (LusidInstrument lusidInstrument, string? model=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS More... | |
Instrument | UpdateInstrumentIdentifier (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpdateInstrumentIdentifier: Update instrument identifier Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not. More... | |
Lusid.Sdk.Client.ApiResponse< Instrument > | UpdateInstrumentIdentifierWithHttpInfo (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpdateInstrumentIdentifier: Update instrument identifier Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not. More... | |
async System.Threading.Tasks.Task< Instrument > | UpdateInstrumentIdentifierAsync (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
UpdateInstrumentIdentifier: Update instrument identifier Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Instrument > > | UpdateInstrumentIdentifierWithHttpInfoAsync (string identifierType, string identifier, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
UpdateInstrumentIdentifier: Update instrument identifier Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not. More... | |
UpsertInstrumentsResponse | UpsertInstruments (Dictionary< string, InstrumentDefinition > requestBody, string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertInstruments: Upsert instruments Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000. More... | |
Lusid.Sdk.Client.ApiResponse< UpsertInstrumentsResponse > | UpsertInstrumentsWithHttpInfo (Dictionary< string, InstrumentDefinition > requestBody, string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertInstruments: Upsert instruments Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000. More... | |
async System.Threading.Tasks.Task< UpsertInstrumentsResponse > | UpsertInstrumentsAsync (Dictionary< string, InstrumentDefinition > requestBody, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
UpsertInstruments: Upsert instruments Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertInstrumentsResponse > > | UpsertInstrumentsWithHttpInfoAsync (Dictionary< string, InstrumentDefinition > requestBody, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
UpsertInstruments: Upsert instruments Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000. More... | |
UpsertInstrumentPropertiesResponse | UpsertInstrumentsProperties (List< UpsertInstrumentPropertyRequest > upsertInstrumentPropertyRequest, string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertInstrumentsProperties: Upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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, string? scope=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertInstrumentsProperties: Upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
UpsertInstrumentsProperties: Upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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, string? scope=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
UpsertInstrumentsProperties: Upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the InstrumentsApi class.
|
inline |
Initializes a new instance of the InstrumentsApi class.
|
inline |
Initializes a new instance of the InstrumentsApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the InstrumentsApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
inline |
BatchUpsertInstrumentProperties: Batch upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | A list of instruments and associated instrument properties to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
identifierEffectiveAt | The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified. (optional) |
successMode | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
BatchUpsertInstrumentProperties: Batch upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | A list of instruments and associated instrument properties to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
identifierEffectiveAt | The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified. (optional) |
successMode | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
BatchUpsertInstrumentProperties: Batch upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | A list of instruments and associated instrument properties to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
identifierEffectiveAt | The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified. (optional) |
successMode | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
BatchUpsertInstrumentProperties: Batch upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | A list of instruments and associated instrument properties to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
identifierEffectiveAt | The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified. (optional) |
successMode | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (optional, default to "Partial") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | An identifier type attached to the Instrument. |
identifier | The identifier value. |
transactionDate | The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
asAt | The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | An identifier type attached to the Instrument. |
identifier | The identifier value. |
transactionDate | The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
asAt | The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | An identifier type attached to the Instrument. |
identifier | The identifier value. |
transactionDate | The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
asAt | The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | An identifier type attached to the Instrument. |
identifier | The identifier value. |
transactionDate | The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
asAt | The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
DeleteInstrument: Soft delete a single instrument Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
DeleteInstrument: Soft delete a single instrument Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
requestBody | A list of property keys from the 'Instruments' domain whose properties to delete. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
requestBody | A list of property keys from the 'Instruments' domain whose properties to delete. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
requestBody | A list of property keys from the 'Instruments' domain whose properties to delete. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
requestBody | A list of property keys from the 'Instruments' domain whose properties to delete. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
DeleteInstruments: Soft or hard delete multiple instruments Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The list of lusidInstrumentId's to delete. |
deleteMode | The delete mode to use (defaults to 'Soft'). (optional) |
scope | The scope in which the instruments lie. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
DeleteInstruments: Soft or hard delete multiple instruments Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The list of lusidInstrumentId's to delete. |
deleteMode | The delete mode to use (defaults to 'Soft'). (optional) |
scope | The scope in which the instruments lie. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
DeleteInstruments: Soft or hard delete multiple instruments Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The list of lusidInstrumentId's to delete. |
deleteMode | The delete mode to use (defaults to 'Soft'). (optional) |
scope | The scope in which the instruments lie. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
DeleteInstruments: Soft or hard delete multiple instruments Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The list of lusidInstrumentId's to delete. |
deleteMode | The delete mode to use (defaults to 'Soft'). (optional) |
scope | The scope in which the instruments lie. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
DeleteInstrument: Soft delete a single instrument Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
DeleteInstrument: Soft delete a single instrument Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. Provides all possible instrument features an instrument of a given type can provide.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
instrumentType | A lusid instrument type e.g. Bond, FxOption. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. Provides all possible instrument features an instrument of a given type can provide.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
instrumentType | A lusid instrument type e.g. Bond, FxOption. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. Provides all possible instrument features an instrument of a given type can provide.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
instrumentType | A lusid instrument type e.g. Bond, FxOption. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. Provides all possible instrument features an instrument of a given type can provide.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
instrumentType | A lusid instrument type e.g. Bond, FxOption. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
Gets the base path of the API client.
The base path
|
inline |
[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifier | A lusid instrument id identifying the instrument. |
model | A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional) |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
instrumentScope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeScope | The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeCode | A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifier | A lusid instrument id identifying the instrument. |
model | A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional) |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
instrumentScope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeScope | The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeCode | A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifier | A lusid instrument id identifying the instrument. |
model | A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional) |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
instrumentScope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeScope | The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeCode | A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifier | A lusid instrument id identifying the instrument. |
model | A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional) |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
instrumentScope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeScope | The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeCode | A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. Get the supported pricing models of a single instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifier | A lusid instrument id identifying the instrument. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
instrumentScope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeScope | The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeCode | A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. Get the supported pricing models of a single instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifier | A lusid instrument id identifying the instrument. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
instrumentScope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeScope | The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeCode | A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. Get the supported pricing models of a single instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifier | A lusid instrument id identifying the instrument. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
instrumentScope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeScope | The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeCode | A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. Get the supported pricing models of a single instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifier | A lusid instrument id identifying the instrument. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
instrumentScope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeScope | The scope in which the recipe lies. When not supplied the scope is 'default'. (optional, default to "default") |
recipeCode | A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstrument: Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to use, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
propertyKeys | A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstrument: Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to use, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
propertyKeys | A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstrumentIdentifierTypes: Get instrument identifier types Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstrumentIdentifierTypes: Get instrument identifier types Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstrumentIdentifierTypes: Get instrument identifier types Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstrumentIdentifierTypes: Get instrument identifier types Retrieve a list of all valid instrument identifier types and whether they are unique or not. An instrument must have a value for at least one unique identifier type (it can have more than one unique type and value). In addition, a value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. An instrument can have values for multiple non-unique identifier types (or it can have zero non-unique types and values).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary Get the payment diary of a single instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The identifier being supplied e.g. "Figi". |
identifier | The value of the identifier for the requested instrument. |
recipeScope | The scope of the valuation recipe being used to generate the payment diary |
recipeCode | The code of the valuation recipe being used to generate the payment diary |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary Get the payment diary of a single instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The identifier being supplied e.g. "Figi". |
identifier | The value of the identifier for the requested instrument. |
recipeScope | The scope of the valuation recipe being used to generate the payment diary |
recipeCode | The code of the valuation recipe being used to generate the payment diary |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary Get the payment diary of a single instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The identifier being supplied e.g. "Figi". |
identifier | The value of the identifier for the requested instrument. |
recipeScope | The scope of the valuation recipe being used to generate the payment diary |
recipeCode | The code of the valuation recipe being used to generate the payment diary |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary Get the payment diary of a single instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The identifier being supplied e.g. "Figi". |
identifier | The value of the identifier for the requested instrument. |
recipeScope | The scope of the valuation recipe being used to generate the payment diary |
recipeCode | The code of the valuation recipe being used to generate the payment diary |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstrumentProperties: Get instrument properties List all the properties of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstrumentProperties: Get instrument properties List all the properties of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstrumentProperties: Get instrument properties List all the properties of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstrumentProperties: Get instrument properties List all the properties of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstrumentPropertyTimeSeries: Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
propertyKey | The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. |
identifierEffectiveAt | The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied. (optional) |
filter | Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
page | The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional) |
limit | When paginating, limit the results to this number. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstrumentPropertyTimeSeries: Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
propertyKey | The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. |
identifierEffectiveAt | The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied. (optional) |
filter | Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
page | The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional) |
limit | When paginating, limit the results to this number. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstrumentPropertyTimeSeries: Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
propertyKey | The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. |
identifierEffectiveAt | The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied. (optional) |
filter | Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
page | The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional) |
limit | When paginating, limit the results to this number. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstrumentPropertyTimeSeries: Get instrument property time series Retrieve the complete time series (history) for a particular property of an instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
propertyKey | The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. |
identifierEffectiveAt | The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied. (optional) |
filter | Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
page | The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional) |
limit | When paginating, limit the results to this number. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships Get relationships for a particular Instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | An identifier type attached to the Instrument. |
identifier | The identifier value. |
effectiveAt | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
scope | The entity scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships Get relationships for a particular Instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | An identifier type attached to the Instrument. |
identifier | The identifier value. |
effectiveAt | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
scope | The entity scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships Get relationships for a particular Instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | An identifier type attached to the Instrument. |
identifier | The identifier value. |
effectiveAt | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
scope | The entity scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships Get relationships for a particular Instrument.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | An identifier type attached to the Instrument. |
identifier | The identifier value. |
effectiveAt | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
scope | The entity scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstruments: Get instruments Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to use, for example 'Figi'. |
requestBody | A list of one or more <i>identifierType</i> values to use to identify instruments. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified. (optional) |
propertyKeys | A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstruments: Get instruments Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to use, for example 'Figi'. |
requestBody | A list of one or more <i>identifierType</i> values to use to identify instruments. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified. (optional) |
propertyKeys | A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstruments: Get instruments Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to use, for example 'Figi'. |
requestBody | A list of one or more <i>identifierType</i> values to use to identify instruments. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified. (optional) |
propertyKeys | A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstruments: Get instruments Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to use, for example 'Figi'. |
requestBody | A list of one or more <i>identifierType</i> values to use to identify instruments. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified. (optional) |
propertyKeys | A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
GetInstrument: Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to use, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
propertyKeys | A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
GetInstrument: Get instrument Retrieve the definition of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to use, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified. (optional) |
propertyKeys | A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) List all the properties of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional) |
page | The pagination token to use to continue listing commands; this value is returned from the previous call. (optional) |
limit | When paginating, limit the results per page to this number. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) List all the properties of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional) |
page | The pagination token to use to continue listing commands; this value is returned from the previous call. (optional) |
limit | When paginating, limit the results per page to this number. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) List all the properties of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional) |
page | The pagination token to use to continue listing commands; this value is returned from the previous call. (optional) |
limit | When paginating, limit the results per page to this number. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) List all the properties of a particular instrument, as identified by a particular unique identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
effectiveAt | The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified. (optional) |
page | The pagination token to use to continue listing commands; this value is returned from the previous call. (optional) |
limit | When paginating, limit the results per page to this number. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
ListInstruments: List instruments List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified. (optional) |
effectiveAt | The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified. (optional) |
page | The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the results to this number. (optional) |
filter | Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional, default to "State eq 'Active'") |
instrumentPropertyKeys | A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
ListInstruments: List instruments List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified. (optional) |
effectiveAt | The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified. (optional) |
page | The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the results to this number. (optional) |
filter | Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional, default to "State eq 'Active'") |
instrumentPropertyKeys | A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
ListInstruments: List instruments List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified. (optional) |
effectiveAt | The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified. (optional) |
page | The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the results to this number. (optional) |
filter | Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional, default to "State eq 'Active'") |
instrumentPropertyKeys | A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
ListInstruments: List instruments List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified. (optional) |
effectiveAt | The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified. (optional) |
page | The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the results to this number. (optional) |
filter | Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional, default to "State eq 'Active'") |
instrumentPropertyKeys | A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'. (optional) |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
lusidInstrument | The definition of the instrument. |
model | A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
lusidInstrument | The definition of the instrument. |
model | A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
lusidInstrument | The definition of the instrument. |
model | A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
lusidInstrument | The definition of the instrument. |
model | A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
UpdateInstrumentIdentifier: Update instrument identifier Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
updateInstrumentIdentifierRequest | The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
UpdateInstrumentIdentifier: Update instrument identifier Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
updateInstrumentIdentifierRequest | The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
UpdateInstrumentIdentifier: Update instrument identifier Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
updateInstrumentIdentifierRequest | The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
UpdateInstrumentIdentifier: Update instrument identifier Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
identifierType | The unique identifier type to search, for example 'Figi'. |
identifier | An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'. |
updateInstrumentIdentifierRequest | The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
UpsertInstruments: Upsert instruments Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The definitions of the instruments to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
UpsertInstruments: Upsert instruments Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The definitions of the instruments to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
UpsertInstrumentsProperties: Upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
upsertInstrumentPropertyRequest | A list of instruments and associated instrument properties to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
UpsertInstrumentsProperties: Upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
upsertInstrumentPropertyRequest | A list of instruments and associated instrument properties to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
UpsertInstrumentsProperties: Upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
upsertInstrumentPropertyRequest | A list of instruments and associated instrument properties to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
UpsertInstrumentsProperties: Upsert instruments properties Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
upsertInstrumentPropertyRequest | A list of instruments and associated instrument properties to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
inline |
UpsertInstruments: Upsert instruments Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The definitions of the instruments to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiSync.
|
inline |
UpsertInstruments: Upsert instruments Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The definitions of the instruments to create or update. |
scope | The scope in which the instrument lies. When not supplied the scope is 'default'. (optional, default to "default") |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IInstrumentsApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.