sdk.lusid.api.entities_api.EntitiesApi

class EntitiesApi(api_client=None)[source]

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

Do not edit the class manually.

Methods

`get_portfolio_by_entity_unique_id`	[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
`get_portfolio_by_entity_unique_id_with_http_info`	[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
`get_portfolio_changes`	[EARLY ACCESS] GetPortfolioChanges: Get the next change to each portfolio in a scope.
`get_portfolio_changes_with_http_info`	[EARLY ACCESS] GetPortfolioChanges: Get the next change to each portfolio in a scope.

get_portfolio_by_entity_unique_id(entity_unique_id, effective_at=None, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501

Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to 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.get_portfolio_by_entity_unique_id(entity_unique_id, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

entity_unique_id (str) – The universally unique identifier of the portfolio definition. (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.
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:

PortfolioEntity

get_portfolio_by_entity_unique_id_with_http_info(entity_unique_id, effective_at=None, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501

Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to 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.get_portfolio_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

entity_unique_id (str) – The universally unique identifier of the portfolio definition. (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.
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(PortfolioEntity, status_code(int), headers(HTTPHeaderDict))

get_portfolio_changes(scope, effective_at, as_at=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetPortfolioChanges: Get the next change to each portfolio in a scope. # noqa: E501

Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). # 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_changes(scope, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope (required)
effective_at (str) – The effective date of the origin. (required)
as_at (datetime) – The as-at date of the origin.
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:

ResourceListOfChange

get_portfolio_changes_with_http_info(scope, effective_at, as_at=None, **kwargs)[source]

[EARLY ACCESS] GetPortfolioChanges: Get the next change to each portfolio in a scope. # noqa: E501

Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). # 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_changes_with_http_info(scope, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope (required)
effective_at (str) – The effective date of the origin. (required)
as_at (datetime) – The as-at date of the origin.
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(ResourceListOfChange, status_code(int), headers(HTTPHeaderDict))