sdk.lusid.api.instruments_api.InstrumentsApi

class InstrumentsApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

delete_instrument

[EARLY ACCESS] Delete instrument # noqa: E501

delete_instrument_with_http_info

[EARLY ACCESS] Delete instrument # noqa: E501

get_instrument

Get instrument # noqa: E501

get_instrument_identifier_types

[EARLY ACCESS] Get instrument identifier types # noqa: E501

get_instrument_identifier_types_with_http_info

[EARLY ACCESS] Get instrument identifier types # noqa: E501

get_instrument_property_time_series

[EARLY ACCESS] Get instrument property time series # noqa: E501

get_instrument_property_time_series_with_http_info

[EARLY ACCESS] Get instrument property time series # noqa: E501

get_instrument_with_http_info

Get instrument # noqa: E501

get_instruments

Get instruments # noqa: E501

get_instruments_with_http_info

Get instruments # noqa: E501

list_instruments

[EARLY ACCESS] List instruments # noqa: E501

list_instruments_with_http_info

[EARLY ACCESS] List instruments # noqa: E501

update_instrument_identifier

[EARLY ACCESS] Update instrument identifier # noqa: E501

update_instrument_identifier_with_http_info

[EARLY ACCESS] Update instrument identifier # noqa: E501

upsert_instruments

Upsert instruments # noqa: E501

upsert_instruments_properties

Upsert instruments properties # noqa: E501

upsert_instruments_properties_with_http_info

Upsert instruments properties # noqa: E501

upsert_instruments_with_http_info

Upsert instruments # noqa: E501

delete_instrument(identifier_type, identifier, **kwargs)[source]

[EARLY ACCESS] Delete instrument # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_instrument(identifier_type, identifier, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to search, for example ‘Figi’. (required)

  • identifier (str) – An <i>identifierType</i> value to use to identify the instrument, for example ‘BBG000BLNNV0’. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

DeleteInstrumentResponse

delete_instrument_with_http_info(identifier_type, identifier, **kwargs)[source]

[EARLY ACCESS] Delete instrument # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_instrument_with_http_info(identifier_type, identifier, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to search, for example ‘Figi’. (required)

  • identifier (str) – An <i>identifierType</i> value to use to identify the instrument, for example ‘BBG000BLNNV0’. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DeleteInstrumentResponse, status_code(int), headers(HTTPHeaderDict))

get_instrument(identifier_type, identifier, **kwargs)[source]

Get instrument # noqa: E501

Retrieve the definition of a particular instrument, as identified by a particular unique identifier. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_instrument(identifier_type, identifier, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to use, for example ‘Figi’. (required)

  • identifier (str) – An <i>identifierType</i> value to use to identify the instrument, for example ‘BBG000BLNNV0’. (required)

  • effective_at (str) – The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.

  • as_at (datetime) – The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.

  • property_keys (list[str]) – A list of property keys from the ‘Instrument’ domain to decorate onto the instrument. These must have the format {domain}/{scope}/{code}, for example ‘Instrument/system/Name’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

Instrument

get_instrument_identifier_types(**kwargs)[source]

[EARLY ACCESS] Get instrument identifier types # noqa: E501

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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_instrument_identifier_types(async_req=True)
>>> result = thread.get()
Parameters
  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

ResourceListOfInstrumentIdTypeDescriptor

get_instrument_identifier_types_with_http_info(**kwargs)[source]

[EARLY ACCESS] Get instrument identifier types # noqa: E501

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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_instrument_identifier_types_with_http_info(async_req=True)
>>> result = thread.get()
Parameters
  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourceListOfInstrumentIdTypeDescriptor, status_code(int), headers(HTTPHeaderDict))

get_instrument_property_time_series(identifier_type, identifier, property_key, **kwargs)[source]

[EARLY ACCESS] Get instrument property time series # noqa: E501

Retrieve the complete time series (history) for a particular property of an instrument. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_instrument_property_time_series(identifier_type, identifier, property_key, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to search, for example ‘Figi’. (required)

  • identifier (str) – An <i>identifierType</i> value to use to identify the instrument, for example ‘BBG000BLNNV0’. (required)

  • property_key (str) – 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’. (required)

  • identifier_effective_at (str) – The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.

  • as_at (datetime) – The asAt datetime at which to retrieve the instrument’s property history. Defaults to returning the current datetime if not supplied.

  • filter (str) – Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.

  • page (str) – 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.

  • limit (int) – When paginating, limit the results to this number.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

ResourceListOfPropertyInterval

get_instrument_property_time_series_with_http_info(identifier_type, identifier, property_key, **kwargs)[source]

[EARLY ACCESS] Get instrument property time series # noqa: E501

Retrieve the complete time series (history) for a particular property of an instrument. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_instrument_property_time_series_with_http_info(identifier_type, identifier, property_key, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to search, for example ‘Figi’. (required)

  • identifier (str) – An <i>identifierType</i> value to use to identify the instrument, for example ‘BBG000BLNNV0’. (required)

  • property_key (str) – 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’. (required)

  • identifier_effective_at (str) – The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.

  • as_at (datetime) – The asAt datetime at which to retrieve the instrument’s property history. Defaults to returning the current datetime if not supplied.

  • filter (str) – Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.

  • page (str) – 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.

  • limit (int) – When paginating, limit the results to this number.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourceListOfPropertyInterval, status_code(int), headers(HTTPHeaderDict))

get_instrument_with_http_info(identifier_type, identifier, **kwargs)[source]

Get instrument # noqa: E501

Retrieve the definition of a particular instrument, as identified by a particular unique identifier. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_instrument_with_http_info(identifier_type, identifier, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to use, for example ‘Figi’. (required)

  • identifier (str) – An <i>identifierType</i> value to use to identify the instrument, for example ‘BBG000BLNNV0’. (required)

  • effective_at (str) – The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.

  • as_at (datetime) – The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.

  • property_keys (list[str]) – A list of property keys from the ‘Instrument’ domain to decorate onto the instrument. These must have the format {domain}/{scope}/{code}, for example ‘Instrument/system/Name’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Instrument, status_code(int), headers(HTTPHeaderDict))

get_instruments(identifier_type, request_body, **kwargs)[source]

Get instruments # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_instruments(identifier_type, request_body, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to use, for example ‘Figi’. (required)

  • request_body (list[str]) – A list of one or more <i>identifierType</i> values to use to identify instruments. (required)

  • effective_at (str) – The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.

  • as_at (datetime) – The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.

  • property_keys (list[str]) – A list of property keys from the ‘Instrument’ domain to decorate onto the instrument. These must have the format {domain}/{scope}/{code}, for example ‘Instrument/system/Name’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

GetInstrumentsResponse

get_instruments_with_http_info(identifier_type, request_body, **kwargs)[source]

Get instruments # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_instruments_with_http_info(identifier_type, request_body, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to use, for example ‘Figi’. (required)

  • request_body (list[str]) – A list of one or more <i>identifierType</i> values to use to identify instruments. (required)

  • effective_at (str) – The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.

  • as_at (datetime) – The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.

  • property_keys (list[str]) – A list of property keys from the ‘Instrument’ domain to decorate onto the instrument. These must have the format {domain}/{scope}/{code}, for example ‘Instrument/system/Name’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(GetInstrumentsResponse, status_code(int), headers(HTTPHeaderDict))

list_instruments(**kwargs)[source]

[EARLY ACCESS] List instruments # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_instruments(async_req=True)
>>> result = thread.get()
Parameters
  • as_at (datetime) – The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.

  • effective_at (str) – The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.

  • page (str) – The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. Also, a <i>start</i> value cannot be provided. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.

  • sort_by (list[str]) – Order results by particular fields. Use the ‘-‘ sign to denote descending order, for example ‘-MyFieldName’.

  • start (int) – When paginating, skip this number of results.

  • limit (int) – When paginating, limit the results to this number.

  • filter (str) – 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.

  • instrument_property_keys (list[str]) – A list of property keys from the ‘Instrument’ domain to decorate onto instruments. These must have the format {domain}/{scope}/{code}, for example ‘Instrument/system/Name’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

PagedResourceListOfInstrument

list_instruments_with_http_info(**kwargs)[source]

[EARLY ACCESS] List instruments # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_instruments_with_http_info(async_req=True)
>>> result = thread.get()
Parameters
  • as_at (datetime) – The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.

  • effective_at (str) – The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.

  • page (str) – The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. Also, a <i>start</i> value cannot be provided. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.

  • sort_by (list[str]) – Order results by particular fields. Use the ‘-‘ sign to denote descending order, for example ‘-MyFieldName’.

  • start (int) – When paginating, skip this number of results.

  • limit (int) – When paginating, limit the results to this number.

  • filter (str) – 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.

  • instrument_property_keys (list[str]) – A list of property keys from the ‘Instrument’ domain to decorate onto instruments. These must have the format {domain}/{scope}/{code}, for example ‘Instrument/system/Name’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PagedResourceListOfInstrument, status_code(int), headers(HTTPHeaderDict))

update_instrument_identifier(identifier_type, identifier, update_instrument_identifier_request, **kwargs)[source]

[EARLY ACCESS] Update instrument identifier # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_instrument_identifier(identifier_type, identifier, update_instrument_identifier_request, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to search, for example ‘Figi’. (required)

  • identifier (str) – An <i>identifierType</i> value to use to identify the instrument, for example ‘BBG000BLNNV0’. (required)

  • update_instrument_identifier_request (UpdateInstrumentIdentifierRequest) – The identifier to update or delete. This need not be the same value as the ‘identifier’ parameter used to retrieve the instrument. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

Instrument

update_instrument_identifier_with_http_info(identifier_type, identifier, update_instrument_identifier_request, **kwargs)[source]

[EARLY ACCESS] Update instrument identifier # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_instrument_identifier_with_http_info(identifier_type, identifier, update_instrument_identifier_request, async_req=True)
>>> result = thread.get()
Parameters
  • identifier_type (str) – The unique identifier type to search, for example ‘Figi’. (required)

  • identifier (str) – An <i>identifierType</i> value to use to identify the instrument, for example ‘BBG000BLNNV0’. (required)

  • update_instrument_identifier_request (UpdateInstrumentIdentifierRequest) – The identifier to update or delete. This need not be the same value as the ‘identifier’ parameter used to retrieve the instrument. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Instrument, status_code(int), headers(HTTPHeaderDict))

upsert_instruments(request_body, **kwargs)[source]

Upsert instruments # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_instruments(request_body, async_req=True)
>>> result = thread.get()
Parameters
  • request_body (dict(str, InstrumentDefinition)) – The definitions of the instruments to create or update. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

UpsertInstrumentsResponse

upsert_instruments_properties(upsert_instrument_property_request, **kwargs)[source]

Upsert instruments properties # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_instruments_properties(upsert_instrument_property_request, async_req=True)
>>> result = thread.get()
Parameters
  • upsert_instrument_property_request (list[UpsertInstrumentPropertyRequest]) – A list of instruments and associated instrument properties to create or update. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

UpsertInstrumentPropertiesResponse

upsert_instruments_properties_with_http_info(upsert_instrument_property_request, **kwargs)[source]

Upsert instruments properties # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_instruments_properties_with_http_info(upsert_instrument_property_request, async_req=True)
>>> result = thread.get()
Parameters
  • upsert_instrument_property_request (list[UpsertInstrumentPropertyRequest]) – A list of instruments and associated instrument properties to create or update. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(UpsertInstrumentPropertiesResponse, status_code(int), headers(HTTPHeaderDict))

upsert_instruments_with_http_info(request_body, **kwargs)[source]

Upsert instruments # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_instruments_with_http_info(request_body, async_req=True)
>>> result = thread.get()
Parameters
  • request_body (dict(str, InstrumentDefinition)) – The definitions of the instruments to create or update. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(UpsertInstrumentsResponse, status_code(int), headers(HTTPHeaderDict))