sdk.lusid.api.portfolios_api.PortfoliosApi

class PortfoliosApi(api_client=None)

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

Do not edit the class manually.

Methods

delete_key_from_portfolio_access_metadata	[EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule # noqa: E501
delete_key_from_portfolio_access_metadata_with_http_info	[EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule # noqa: E501
delete_portfolio	DeletePortfolio: Delete portfolio # noqa: E501
delete_portfolio_properties	DeletePortfolioProperties: Delete portfolio properties # noqa: E501
delete_portfolio_properties_with_http_info	DeletePortfolioProperties: Delete portfolio properties # noqa: E501
delete_portfolio_returns	[EARLY ACCESS] DeletePortfolioReturns: Delete Returns # noqa: E501
delete_portfolio_returns_with_http_info	[EARLY ACCESS] DeletePortfolioReturns: Delete Returns # noqa: E501
delete_portfolio_with_http_info	DeletePortfolio: Delete portfolio # noqa: E501
get_aggregated_returns_dispersion_metrics	[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric # noqa: E501
get_aggregated_returns_dispersion_metrics_with_http_info	[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric # noqa: E501
get_composite_breakdown	[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated # noqa: E501
get_composite_breakdown_with_http_info	[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated # noqa: E501
get_portfolio	GetPortfolio: Get portfolio # noqa: E501
get_portfolio_aggregate_returns	[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint).
get_portfolio_aggregate_returns_with_http_info	[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint).
get_portfolio_aggregated_returns	[EARLY ACCESS] GetPortfolioAggregatedReturns: Aggregated Returns # noqa: E501
get_portfolio_aggregated_returns_with_http_info	[EARLY ACCESS] GetPortfolioAggregatedReturns: Aggregated Returns # noqa: E501
get_portfolio_commands	GetPortfolioCommands: Get portfolio commands # noqa: E501
get_portfolio_commands_with_http_info	GetPortfolioCommands: Get portfolio commands # noqa: E501
get_portfolio_metadata	[EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio # noqa: E501
get_portfolio_metadata_with_http_info	[EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio # noqa: E501
get_portfolio_properties	GetPortfolioProperties: Get portfolio properties # noqa: E501
get_portfolio_properties_with_http_info	GetPortfolioProperties: Get portfolio properties # noqa: E501
get_portfolio_property_time_series	[EARLY ACCESS] GetPortfolioPropertyTimeSeries: Get portfolio property time series # noqa: E501
get_portfolio_property_time_series_with_http_info	[EARLY ACCESS] GetPortfolioPropertyTimeSeries: Get portfolio property time series # noqa: E501
get_portfolio_relations	[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations # noqa: E501
get_portfolio_relations_with_http_info	[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations # noqa: E501
get_portfolio_relationships	[EARLY ACCESS] GetPortfolioRelationships: Get portfolio relationships # noqa: E501
get_portfolio_relationships_with_http_info	[EARLY ACCESS] GetPortfolioRelationships: Get portfolio relationships # noqa: E501
get_portfolio_returns	[EARLY ACCESS] GetPortfolioReturns: Get Returns # noqa: E501
get_portfolio_returns_with_http_info	[EARLY ACCESS] GetPortfolioReturns: Get Returns # noqa: E501
get_portfolio_with_http_info	GetPortfolio: Get portfolio # noqa: E501
get_portfolios_access_metadata_by_key	[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object # noqa: E501
get_portfolios_access_metadata_by_key_with_http_info	[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object # noqa: E501
list_portfolio_properties	[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties # noqa: E501
list_portfolio_properties_with_http_info	[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties # noqa: E501
list_portfolios	ListPortfolios: List portfolios # noqa: E501
list_portfolios_for_scope	ListPortfoliosForScope: List portfolios for scope # noqa: E501
list_portfolios_for_scope_with_http_info	ListPortfoliosForScope: List portfolios for scope # noqa: E501
list_portfolios_with_http_info	ListPortfolios: List portfolios # noqa: E501
patch_portfolio	[EARLY ACCESS] PatchPortfolio: Patch portfolio.
patch_portfolio_access_metadata	[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio.
patch_portfolio_access_metadata_with_http_info	[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio.
patch_portfolio_with_http_info	[EARLY ACCESS] PatchPortfolio: Patch portfolio.
update_portfolio	UpdatePortfolio: Update portfolio # noqa: E501
update_portfolio_with_http_info	UpdatePortfolio: Update portfolio # noqa: E501
upsert_portfolio_access_metadata	[EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey.
upsert_portfolio_access_metadata_with_http_info	[EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey.
upsert_portfolio_properties	UpsertPortfolioProperties: Upsert portfolio properties # noqa: E501
upsert_portfolio_properties_with_http_info	UpsertPortfolioProperties: Upsert portfolio properties # noqa: E501
upsert_portfolio_returns	[EARLY ACCESS] UpsertPortfolioReturns: Upsert Returns # noqa: E501
upsert_portfolio_returns_with_http_info	[EARLY ACCESS] UpsertPortfolioReturns: Upsert Returns # noqa: E501

delete_key_from_portfolio_access_metadata(scope, code, metadata_key, effective_at=None, effective_until=None, async_req=None, **kwargs)

[EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule # noqa: E501

Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts # 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_key_from_portfolio_access_metadata(scope, code, metadata_key, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Quote Access Metadata Rule to retrieve. (required)

• code (str) – Portfolio code (required)

• metadata_key (str) – The metadataKey identifying the access metadata entry to delete (required)

• effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found

• effective_until (datetime) – The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date of the Access Metadata

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

• _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:

DeletedEntityResponse

delete_key_from_portfolio_access_metadata_with_http_info(scope, code, metadata_key, effective_at=None, effective_until=None, **kwargs)

[EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule # noqa: E501

Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts # 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_key_from_portfolio_access_metadata_with_http_info(scope, code, metadata_key, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Quote Access Metadata Rule to retrieve. (required)

• code (str) – Portfolio code (required)

• metadata_key (str) – The metadataKey identifying the access metadata entry to delete (required)

• effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found

• effective_until (datetime) – The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date of the Access Metadata

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_portfolio(scope, code, async_req=None, **kwargs)

DeletePortfolio: Delete portfolio # noqa: E501

Delete a particular portfolio. The deletion will take effect from the portfolio’s creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion. # 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_portfolio(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• _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:

DeletedEntityResponse

delete_portfolio_properties(scope, code, property_keys, effective_at=None, async_req=None, **kwargs)

DeletePortfolioProperties: Delete portfolio properties # noqa: E501

Delete one or more properties from a particular portfolio. 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. # 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_portfolio_properties(scope, code, property_keys, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• property_keys (List[str]) – The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’. Each property must be from the ‘Portfolio’ domain. (required)

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

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

• _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:

DeletedEntityResponse

delete_portfolio_properties_with_http_info(scope, code, property_keys, effective_at=None, **kwargs)

DeletePortfolioProperties: Delete portfolio properties # noqa: E501

Delete one or more properties from a particular portfolio. 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. # 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_portfolio_properties_with_http_info(scope, code, property_keys, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• property_keys (List[str]) – The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’. Each property must be from the ‘Portfolio’ domain. (required)

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

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_portfolio_returns(scope, code, return_scope, return_code, from_effective_at, to_effective_at, period=None, async_req=None, **kwargs)

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns # noqa: E501

Cancel one or more Returns which exist into the specified portfolio. # 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_portfolio_returns(scope, code, return_scope, return_code, from_effective_at, to_effective_at, period, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• return_scope (str) – The scope of the Returns. (required)

• return_code (str) – The code of the Returns. (required)

• from_effective_at (str) – The start date from which to delete the Returns. (required)

• to_effective_at (str) – The end date from which to delete the Returns. (required)

• period (str) – The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily.

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

• _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:

DeletedEntityResponse

delete_portfolio_returns_with_http_info(scope, code, return_scope, return_code, from_effective_at, to_effective_at, period=None, **kwargs)

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns # noqa: E501

Cancel one or more Returns which exist into the specified portfolio. # 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_portfolio_returns_with_http_info(scope, code, return_scope, return_code, from_effective_at, to_effective_at, period, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• return_scope (str) – The scope of the Returns. (required)

• return_code (str) – The code of the Returns. (required)

• from_effective_at (str) – The start date from which to delete the Returns. (required)

• to_effective_at (str) – The end date from which to delete the Returns. (required)

• period (str) – The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_portfolio_with_http_info(scope, code, **kwargs)

DeletePortfolio: Delete portfolio # noqa: E501

Delete a particular portfolio. The deletion will take effect from the portfolio’s creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion. # 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_portfolio_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

get_aggregated_returns_dispersion_metrics(scope, code, aggregated_returns_dispersion_request, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric # noqa: E501

Calculate the dispersion metric with the Aggregate Returns which are on the specified portfolio. This works only for composites which have at least 6 constituents for a full year in. # 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_aggregated_returns_dispersion_metrics(scope, code, aggregated_returns_dispersion_request, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• aggregated_returns_dispersion_request (AggregatedReturnsDispersionRequest) – The request used in the AggregatedReturnsDispersionMetric. (required)

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

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

• _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:

CompositeDispersionResponse

get_aggregated_returns_dispersion_metrics_with_http_info(scope, code, aggregated_returns_dispersion_request, as_at=None, **kwargs)

[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric # noqa: E501

Calculate the dispersion metric with the Aggregate Returns which are on the specified portfolio. This works only for composites which have at least 6 constituents for a full year in. # 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_aggregated_returns_dispersion_metrics_with_http_info(scope, code, aggregated_returns_dispersion_request, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• aggregated_returns_dispersion_request (AggregatedReturnsDispersionRequest) – The request used in the AggregatedReturnsDispersionMetric. (required)

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(CompositeDispersionResponse, status_code(int), headers(HTTPHeaderDict))

get_composite_breakdown(scope, code, composite_breakdown_request, from_effective_at=None, to_effective_at=None, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated # noqa: E501

Calculate the Composite Returns and return this with the constituents which are included in this calculation # 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_composite_breakdown(scope, code, composite_breakdown_request, from_effective_at, to_effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• composite_breakdown_request (CompositeBreakdownRequest) – The request used in the GetCompositeBreakdown. (required)

• from_effective_at (str) – The start date from which to calculate the Returns.

• to_effective_at (str) – The end date for which to calculate the Returns.

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

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

• _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:

CompositeBreakdownResponse

get_composite_breakdown_with_http_info(scope, code, composite_breakdown_request, from_effective_at=None, to_effective_at=None, as_at=None, **kwargs)

[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated # noqa: E501

Calculate the Composite Returns and return this with the constituents which are included in this calculation # 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_composite_breakdown_with_http_info(scope, code, composite_breakdown_request, from_effective_at, to_effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• composite_breakdown_request (CompositeBreakdownRequest) – The request used in the GetCompositeBreakdown. (required)

• from_effective_at (str) – The start date from which to calculate the Returns.

• to_effective_at (str) – The end date for which to calculate the Returns.

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(CompositeBreakdownResponse, status_code(int), headers(HTTPHeaderDict))

get_portfolio(scope, code, effective_at=None, as_at=None, property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)

GetPortfolio: Get portfolio # noqa: E501

Retrieve the definition of a particular portfolio. # 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_portfolio(scope, code, effective_at, as_at, property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

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

• property_keys (List[str]) – A list of property keys from the ‘Portfolio’ domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.

• relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.

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

• _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:

Portfolio

get_portfolio_aggregate_returns(scope, code, return_scope, return_code, recipe_id_scope=None, recipe_id_code=None, from_effective_at=None, to_effective_at=None, composite_method=None, period=None, output_frequency=None, metrics=None, as_at=None, alternative_inc_date=None, async_req=None, **kwargs)

[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). # noqa: E501

Aggregate Returns which are on the specified portfolio. # 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_portfolio_aggregate_returns(scope, code, return_scope, return_code, recipe_id_scope, recipe_id_code, from_effective_at, to_effective_at, composite_method, period, output_frequency, metrics, as_at, alternative_inc_date, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• return_scope (str) – The scope of the Returns. (required)

• return_code (str) – The code of the Returns. (required)

• recipe_id_scope (str) – The Recipe Scope for getting the fx rates

• recipe_id_code (str) – The Recipe Code for getting the fx rates

• from_effective_at (str) – The start date from which to calculate the Returns.

• to_effective_at (str) – The end date for which to calculate the Returns.

• composite_method (str) – The method used to calculate the Portfolio performance: Equal/Asset.

• period (str) – The type of the returns used to calculate the aggregation result: Daily/Monthly.

• output_frequency (str) – The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.

• metrics (List[str]) – Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics.

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

• alternative_inc_date (str) – The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property.

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

• _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:

ResourceListOfAggregatedReturn

get_portfolio_aggregate_returns_with_http_info(scope, code, return_scope, return_code, recipe_id_scope=None, recipe_id_code=None, from_effective_at=None, to_effective_at=None, composite_method=None, period=None, output_frequency=None, metrics=None, as_at=None, alternative_inc_date=None, **kwargs)

[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). # noqa: E501

Aggregate Returns which are on the specified portfolio. # 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_portfolio_aggregate_returns_with_http_info(scope, code, return_scope, return_code, recipe_id_scope, recipe_id_code, from_effective_at, to_effective_at, composite_method, period, output_frequency, metrics, as_at, alternative_inc_date, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• return_scope (str) – The scope of the Returns. (required)

• return_code (str) – The code of the Returns. (required)

• recipe_id_scope (str) – The Recipe Scope for getting the fx rates

• recipe_id_code (str) – The Recipe Code for getting the fx rates

• from_effective_at (str) – The start date from which to calculate the Returns.

• to_effective_at (str) – The end date for which to calculate the Returns.

• composite_method (str) – The method used to calculate the Portfolio performance: Equal/Asset.

• period (str) – The type of the returns used to calculate the aggregation result: Daily/Monthly.

• output_frequency (str) – The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.

• metrics (List[str]) – Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics.

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

• alternative_inc_date (str) – The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfAggregatedReturn, status_code(int), headers(HTTPHeaderDict))

get_portfolio_aggregated_returns(scope, code, aggregated_returns_request, from_effective_at=None, to_effective_at=None, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioAggregatedReturns: Aggregated Returns # noqa: E501

Aggregate Returns which are on the specified portfolio. # 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_portfolio_aggregated_returns(scope, code, aggregated_returns_request, from_effective_at, to_effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• aggregated_returns_request (AggregatedReturnsRequest) – The request used in the AggregatedReturns. (required)

• from_effective_at (str) – The start date from which to calculate the Returns.

• to_effective_at (str) – The end date for which to calculate the Returns.

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

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

• _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:

AggregatedReturnsResponse

get_portfolio_aggregated_returns_with_http_info(scope, code, aggregated_returns_request, from_effective_at=None, to_effective_at=None, as_at=None, **kwargs)

[EARLY ACCESS] GetPortfolioAggregatedReturns: Aggregated Returns # noqa: E501

Aggregate Returns which are on the specified portfolio. # 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_portfolio_aggregated_returns_with_http_info(scope, code, aggregated_returns_request, from_effective_at, to_effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• aggregated_returns_request (AggregatedReturnsRequest) – The request used in the AggregatedReturns. (required)

• from_effective_at (str) – The start date from which to calculate the Returns.

• to_effective_at (str) – The end date for which to calculate the Returns.

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(AggregatedReturnsResponse, status_code(int), headers(HTTPHeaderDict))

get_portfolio_commands(scope, code, from_as_at=None, to_as_at=None, filter=None, page=None, limit=None, async_req=None, **kwargs)

GetPortfolioCommands: Get portfolio commands # noqa: E501

Get all the commands that modified a particular portfolio, including any input transactions. # 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_portfolio_commands(scope, code, from_as_at, to_as_at, filter, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• from_as_at (datetime) – The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.

• to_as_at (datetime) – The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.

• filter (str) – Expression to filter the results. For example, to filter on the User ID, specify “userId.id eq ‘string’”. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.

• page (str) – The pagination token to use to continue listing commands; this value is returned from the previous call.

• limit (int) – When paginating, limit the results to this number. Defaults to 500 if not specified.

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

• _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:

ResourceListOfProcessedCommand

get_portfolio_commands_with_http_info(scope, code, from_as_at=None, to_as_at=None, filter=None, page=None, limit=None, **kwargs)

GetPortfolioCommands: Get portfolio commands # noqa: E501

Get all the commands that modified a particular portfolio, including any input transactions. # 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_portfolio_commands_with_http_info(scope, code, from_as_at, to_as_at, filter, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• from_as_at (datetime) – The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.

• to_as_at (datetime) – The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.

• filter (str) – Expression to filter the results. For example, to filter on the User ID, specify “userId.id eq ‘string’”. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.

• page (str) – The pagination token to use to continue listing commands; this value is returned from the previous call.

• limit (int) – When paginating, limit the results to this number. Defaults to 500 if not specified.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfProcessedCommand, status_code(int), headers(HTTPHeaderDict))

get_portfolio_metadata(scope, code, effective_at=None, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio # noqa: E501

Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio # 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_portfolio_metadata(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Access Metadata Rule to retrieve. (required)

• code (str) – Portfolio code (required)

• effective_at (str) – The effectiveAt datetime at which to retrieve the access metadata rule.

• as_at (datetime) – The asAt datetime at which to retrieve the portfolio access metadata.

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

• _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:

Dict[str, List[AccessMetadataValue]]

get_portfolio_metadata_with_http_info(scope, code, effective_at=None, as_at=None, **kwargs)

[EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio # noqa: E501

Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio # 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_portfolio_metadata_with_http_info(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Access Metadata Rule to retrieve. (required)

• code (str) – Portfolio code (required)

• effective_at (str) – The effectiveAt datetime at which to retrieve the access metadata rule.

• as_at (datetime) – The asAt datetime at which to retrieve the portfolio access metadata.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))

get_portfolio_properties(scope, code, effective_at=None, as_at=None, async_req=None, **kwargs)

GetPortfolioProperties: Get portfolio properties # noqa: E501

List all the properties of a particular portfolio. # 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_portfolio_properties(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• as_at (datetime) – The asAt datetime at which to list the portfolio’s properties. Defaults to returning the latest version of each property if not specified.

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

• _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:

PortfolioProperties

get_portfolio_properties_with_http_info(scope, code, effective_at=None, as_at=None, **kwargs)

GetPortfolioProperties: Get portfolio properties # noqa: E501

List all the properties of a particular portfolio. # 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_portfolio_properties_with_http_info(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• as_at (datetime) – The asAt datetime at which to list the portfolio’s properties. Defaults to returning the latest version of each property if not specified.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(PortfolioProperties, status_code(int), headers(HTTPHeaderDict))

get_portfolio_property_time_series(scope, code, property_key, portfolio_effective_at=None, as_at=None, filter=None, page=None, limit=None, async_req=None, **kwargs)

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

Show the complete time series (history) for a particular portfolio 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.get_portfolio_property_time_series(scope, code, property_key, portfolio_effective_at, as_at, filter, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• property_key (str) – The property key of the property whose history to show. This must be from the ‘Portfolio’ domain and in the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’. (required)

• portfolio_effective_at (str) – The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to show the 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 filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request.

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

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

• _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_portfolio_property_time_series_with_http_info(scope, code, property_key, portfolio_effective_at=None, as_at=None, filter=None, page=None, limit=None, **kwargs)

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

Show the complete time series (history) for a particular portfolio 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.get_portfolio_property_time_series_with_http_info(scope, code, property_key, portfolio_effective_at, as_at, filter, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• property_key (str) – The property key of the property whose history to show. This must be from the ‘Portfolio’ domain and in the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’. (required)

• portfolio_effective_at (str) – The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to show the 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 filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request.

• 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 ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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_portfolio_relations(scope, code, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations # noqa: E501

Get relations for a particular portfolio. # 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_portfolio_relations(scope, code, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• as_at (datetime) – The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.

• filter (str) – Expression to filter the relations. Provide a null or empty string for this field until further notice.

• identifier_types (List[str]) – Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the ‘Person’ or ‘LegalEntity’ domains and have the format {domain}/{scope}/{code}, for example ‘Person/CompanyDetails/Role’. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array.

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

• _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:

ResourceListOfRelation

get_portfolio_relations_with_http_info(scope, code, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations # noqa: E501

Get relations for a particular portfolio. # 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_portfolio_relations_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• as_at (datetime) – The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified.

• filter (str) – Expression to filter the relations. Provide a null or empty string for this field until further notice.

• identifier_types (List[str]) – Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the ‘Person’ or ‘LegalEntity’ domains and have the format {domain}/{scope}/{code}, for example ‘Person/CompanyDetails/Role’. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfRelation, status_code(int), headers(HTTPHeaderDict))

get_portfolio_relationships(scope, code, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioRelationships: Get portfolio relationships # noqa: E501

Get relationships for a particular portfolio. # 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_portfolio_relationships(scope, code, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• as_at (datetime) – The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.

• filter (str) – Expression to filter the relationships. Provide a null or empty string for this field until further notice.

• identifier_types (List[str]) – 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.

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

• _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:

ResourceListOfRelationship

get_portfolio_relationships_with_http_info(scope, code, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)

[EARLY ACCESS] GetPortfolioRelationships: Get portfolio relationships # noqa: E501

Get relationships for a particular portfolio. # 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_portfolio_relationships_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• as_at (datetime) – The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified.

• filter (str) – Expression to filter the relationships. Provide a null or empty string for this field until further notice.

• identifier_types (List[str]) – 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.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfRelationship, status_code(int), headers(HTTPHeaderDict))

get_portfolio_returns(scope, code, return_scope, return_code, from_effective_at=None, to_effective_at=None, period=None, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioReturns: Get Returns # noqa: E501

Get Returns which are on the specified portfolio. # 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_portfolio_returns(scope, code, return_scope, return_code, from_effective_at, to_effective_at, period, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• return_scope (str) – The scope of the Returns. (required)

• return_code (str) – The code of the Returns. (required)

• from_effective_at (str) – The start date from which to get the Returns.

• to_effective_at (str) – The end date from which to get the Returns.

• period (str) – Show the Returns on a Daily or Monthly period. Defaults to Daily.

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

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

• _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:

ResourceListOfPerformanceReturn

get_portfolio_returns_with_http_info(scope, code, return_scope, return_code, from_effective_at=None, to_effective_at=None, period=None, as_at=None, **kwargs)

[EARLY ACCESS] GetPortfolioReturns: Get Returns # noqa: E501

Get Returns which are on the specified portfolio. # 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_portfolio_returns_with_http_info(scope, code, return_scope, return_code, from_effective_at, to_effective_at, period, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• return_scope (str) – The scope of the Returns. (required)

• return_code (str) – The code of the Returns. (required)

• from_effective_at (str) – The start date from which to get the Returns.

• to_effective_at (str) – The end date from which to get the Returns.

• period (str) – Show the Returns on a Daily or Monthly period. Defaults to Daily.

• as_at (datetime) – The asAt datetime at which to retrieve the Returns. Defaults to the latest.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfPerformanceReturn, status_code(int), headers(HTTPHeaderDict))

get_portfolio_with_http_info(scope, code, effective_at=None, as_at=None, property_keys=None, relationship_definition_ids=None, **kwargs)

GetPortfolio: Get portfolio # noqa: E501

Retrieve the definition of a particular portfolio. # 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_portfolio_with_http_info(scope, code, effective_at, as_at, property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

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

• property_keys (List[str]) – A list of property keys from the ‘Portfolio’ domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.

• relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(Portfolio, status_code(int), headers(HTTPHeaderDict))

get_portfolios_access_metadata_by_key(scope, code, metadata_key, effective_at=None, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object # noqa: E501

Get a specific portfolio access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule # 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_portfolios_access_metadata_by_key(scope, code, metadata_key, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Access Metadata Rule to retrieve. (required)

• code (str) – The code of the portfolio (required)

• metadata_key (str) – Key of the metadata to retrieve (required)

• effective_at (str) – The effective date of the rule

• as_at (datetime) – The asAt datetime at which to retrieve the portfolio access metadata.

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

• _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:

List[AccessMetadataValue]

get_portfolios_access_metadata_by_key_with_http_info(scope, code, metadata_key, effective_at=None, as_at=None, **kwargs)

[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object # noqa: E501

Get a specific portfolio access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule # 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_portfolios_access_metadata_by_key_with_http_info(scope, code, metadata_key, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Access Metadata Rule to retrieve. (required)

• code (str) – The code of the portfolio (required)

• metadata_key (str) – Key of the metadata to retrieve (required)

• effective_at (str) – The effective date of the rule

• as_at (datetime) – The asAt datetime at which to retrieve the portfolio access metadata.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(List[AccessMetadataValue], status_code(int), headers(HTTPHeaderDict))

list_portfolio_properties(scope, code, effective_at=None, as_at=None, page=None, limit=None, async_req=None, **kwargs)

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties # noqa: E501

List all the properties of a particular portfolio. # 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_portfolio_properties(scope, code, effective_at, as_at, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• as_at (datetime) – The asAt datetime at which to list the portfolio’s properties. Defaults to returning the latest version of each property if not specified.

• page (str) – The pagination token to use to continue listing commands; this value is returned from the previous call.

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

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

• _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:

ResourceListOfProperty

list_portfolio_properties_with_http_info(scope, code, effective_at=None, as_at=None, page=None, limit=None, **kwargs)

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties # noqa: E501

List all the properties of a particular portfolio. # 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_portfolio_properties_with_http_info(scope, code, effective_at, as_at, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

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

• as_at (datetime) – The asAt datetime at which to list the portfolio’s properties. Defaults to returning the latest version of each property if not specified.

• page (str) – The pagination token to use to continue listing commands; this value is returned from the previous call.

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

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfProperty, status_code(int), headers(HTTPHeaderDict))

list_portfolios(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, query=None, property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)

ListPortfolios: List portfolios # noqa: E501

List all the portfolios matching particular criteria. # 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_portfolios(effective_at, as_at, page, limit, filter, sort_by, query, property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

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

• as_at (datetime) – The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.

• page (str) – The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.

• limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.

• filter (str) – Expression to filter the results. For example, to filter on the transaction type, specify “type eq ‘Transaction’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.

• query (str) – Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of ‘LUID_PPA8HI6M’ or a Figi of ‘BBG000BLNNH6’, specify “instrument.identifiers in ((‘LusidInstrumentId’, ‘LUID_PPA8HI6M’), (‘Figi’, ‘BBG000BLNNH6’))”.

• property_keys (List[str]) – A list of property keys from the ‘Portfolio’ domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.

• relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.

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

• _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:

ResourceListOfPortfolio

list_portfolios_for_scope(scope, effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)

ListPortfoliosForScope: List portfolios for scope # noqa: E501

List all the portfolios in a particular scope. # 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_portfolios_for_scope(scope, effective_at, as_at, page, limit, filter, sort_by, property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope whose portfolios to list. (required)

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

• as_at (datetime) – The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.

• page (str) – The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.

• limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.

• filter (str) – Expression to filter the results. For example, to return only transactions with a transaction type of ‘Buy’, specify “type eq ‘Buy’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.

• property_keys (List[str]) – A list of property keys from the ‘Portfolio’ domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.

• relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.

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

• _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:

ResourceListOfPortfolio

list_portfolios_for_scope_with_http_info(scope, effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, relationship_definition_ids=None, **kwargs)

ListPortfoliosForScope: List portfolios for scope # noqa: E501

List all the portfolios in a particular scope. # 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_portfolios_for_scope_with_http_info(scope, effective_at, as_at, page, limit, filter, sort_by, property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope whose portfolios to list. (required)

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

• as_at (datetime) – The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.

• page (str) – The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.

• limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.

• filter (str) – Expression to filter the results. For example, to return only transactions with a transaction type of ‘Buy’, specify “type eq ‘Buy’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.

• property_keys (List[str]) – A list of property keys from the ‘Portfolio’ domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.

• relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfPortfolio, status_code(int), headers(HTTPHeaderDict))

list_portfolios_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, query=None, property_keys=None, relationship_definition_ids=None, **kwargs)

ListPortfolios: List portfolios # noqa: E501

List all the portfolios matching particular criteria. # 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_portfolios_with_http_info(effective_at, as_at, page, limit, filter, sort_by, query, property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

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

• as_at (datetime) – The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified.

• page (str) – The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.

• limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.

• filter (str) – Expression to filter the results. For example, to filter on the transaction type, specify “type eq ‘Transaction’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.

• query (str) – Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of ‘LUID_PPA8HI6M’ or a Figi of ‘BBG000BLNNH6’, specify “instrument.identifiers in ((‘LusidInstrumentId’, ‘LUID_PPA8HI6M’), (‘Figi’, ‘BBG000BLNNH6’))”.

• property_keys (List[str]) – A list of property keys from the ‘Portfolio’ domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.

• relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfPortfolio, status_code(int), headers(HTTPHeaderDict))

patch_portfolio(scope, code, operation, async_req=None, **kwargs)

[EARLY ACCESS] PatchPortfolio: Patch portfolio. # noqa: E501

Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: CreationDate, InstrumentScopes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_portfolio(scope, code, operation, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• operation (List[Operation]) – The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902. (required)

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

• _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:

Portfolio

patch_portfolio_access_metadata(scope, code, access_metadata_operation, effective_at=None, effective_until=None, async_req=None, **kwargs)

[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. # noqa: E501

Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only ‘add’ is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_portfolio_access_metadata(scope, code, access_metadata_operation, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Access Metadata Rule. (required)

• code (str) – Portfolio code (required)

• access_metadata_operation (List[AccessMetadataOperation]) – The Json Patch document (required)

• effective_at (str) – The date this rule will effective from

• effective_until (datetime) – The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date of the Access Metadata

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

• _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:

Dict[str, List[AccessMetadataValue]]

patch_portfolio_access_metadata_with_http_info(scope, code, access_metadata_operation, effective_at=None, effective_until=None, **kwargs)

[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. # noqa: E501

Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only ‘add’ is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_portfolio_access_metadata_with_http_info(scope, code, access_metadata_operation, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Access Metadata Rule. (required)

• code (str) – Portfolio code (required)

• access_metadata_operation (List[AccessMetadataOperation]) – The Json Patch document (required)

• effective_at (str) – The date this rule will effective from

• effective_until (datetime) – The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date of the Access Metadata

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))

patch_portfolio_with_http_info(scope, code, operation, **kwargs)

[EARLY ACCESS] PatchPortfolio: Patch portfolio. # noqa: E501

Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: CreationDate, InstrumentScopes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_portfolio_with_http_info(scope, code, operation, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• operation (List[Operation]) – The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902. (required)

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(Portfolio, status_code(int), headers(HTTPHeaderDict))

update_portfolio(scope, code, update_portfolio_request, effective_at=None, async_req=None, **kwargs)

UpdatePortfolio: Update portfolio # noqa: E501

Update the definition of a particular portfolio. Note that not all elements of a portfolio definition are modifiable due to the potential implications for data already stored. # 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_portfolio(scope, code, update_portfolio_request, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• update_portfolio_request (UpdatePortfolioRequest) – The updated portfolio definition. (required)

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

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

• _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:

Portfolio

update_portfolio_with_http_info(scope, code, update_portfolio_request, effective_at=None, **kwargs)

UpdatePortfolio: Update portfolio # noqa: E501

Update the definition of a particular portfolio. Note that not all elements of a portfolio definition are modifiable due to the potential implications for data already stored. # 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_portfolio_with_http_info(scope, code, update_portfolio_request, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• update_portfolio_request (UpdatePortfolioRequest) – The updated portfolio definition. (required)

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

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(Portfolio, status_code(int), headers(HTTPHeaderDict))

upsert_portfolio_access_metadata(scope, code, metadata_key, upsert_portfolio_access_metadata_request, effective_at=None, effective_until=None, async_req=None, **kwargs)

[EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. # noqa: E501

Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Portfolio Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched # 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_portfolio_access_metadata(scope, code, metadata_key, upsert_portfolio_access_metadata_request, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope to use when updating or inserting the Portfolio Access Metadata Rule. (required)

• code (str) – Portfolio code (required)

• metadata_key (str) – Key of the access metadata to upsert (required)

• upsert_portfolio_access_metadata_request (UpsertPortfolioAccessMetadataRequest) – The Portfolio Access Metadata Rule to update or insert (required)

• effective_at (str) – The date this rule will effective from

• effective_until (datetime) – The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date of the Access Metadata

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

• _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:

ResourceListOfAccessMetadataValueOf

upsert_portfolio_access_metadata_with_http_info(scope, code, metadata_key, upsert_portfolio_access_metadata_request, effective_at=None, effective_until=None, **kwargs)

[EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. # noqa: E501

Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Portfolio Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched # 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_portfolio_access_metadata_with_http_info(scope, code, metadata_key, upsert_portfolio_access_metadata_request, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope to use when updating or inserting the Portfolio Access Metadata Rule. (required)

• code (str) – Portfolio code (required)

• metadata_key (str) – Key of the access metadata to upsert (required)

• upsert_portfolio_access_metadata_request (UpsertPortfolioAccessMetadataRequest) – The Portfolio Access Metadata Rule to update or insert (required)

• effective_at (str) – The date this rule will effective from

• effective_until (datetime) – The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date of the Access Metadata

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(ResourceListOfAccessMetadataValueOf, status_code(int), headers(HTTPHeaderDict))

upsert_portfolio_properties(scope, code, request_body, async_req=None, **kwargs)

UpsertPortfolioProperties: Upsert portfolio properties # noqa: E501

Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the ‘Portfolio’ domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it 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_portfolio_properties(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• request_body (Dict[str, ModelProperty]) – The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’. (required)

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

• _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:

PortfolioProperties

upsert_portfolio_properties_with_http_info(scope, code, request_body, **kwargs)

UpsertPortfolioProperties: Upsert portfolio properties # noqa: E501

Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the ‘Portfolio’ domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it 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_portfolio_properties_with_http_info(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio. (required)

• code (str) – The code of the portfolio. Together with the scope this uniquely identifies the portfolio. (required)

• request_body (Dict[str, ModelProperty]) – The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’. (required)

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(PortfolioProperties, status_code(int), headers(HTTPHeaderDict))

upsert_portfolio_returns(scope, code, return_scope, return_code, performance_return, async_req=None, **kwargs)

[EARLY ACCESS] UpsertPortfolioReturns: Upsert Returns # noqa: E501

Update or insert returns into the specified portfolio. # 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_portfolio_returns(scope, code, return_scope, return_code, performance_return, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• return_scope (str) – The scope of the Returns. (required)

• return_code (str) – The code of the Returns. (required)

• performance_return (List[PerformanceReturn]) – This contains the Returns which need to be upsert. (required)

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

• _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:

UpsertReturnsResponse

upsert_portfolio_returns_with_http_info(scope, code, return_scope, return_code, performance_return, **kwargs)

[EARLY ACCESS] UpsertPortfolioReturns: Upsert Returns # noqa: E501

Update or insert returns into the specified portfolio. # 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_portfolio_returns_with_http_info(scope, code, return_scope, return_code, performance_return, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio. (required)

• code (str) – The code of the Portfolio. (required)

• return_scope (str) – The scope of the Returns. (required)

• return_code (str) – The code of the Returns. (required)

• performance_return (List[PerformanceReturn]) – This contains the Returns which need to be upsert. (required)

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

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _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(UpsertReturnsResponse, status_code(int), headers(HTTPHeaderDict))