sdk.lusid.api.reference_portfolio_api.ReferencePortfolioApi

class ReferencePortfolioApi(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

`create_reference_portfolio`	CreateReferencePortfolio: Create reference portfolio # noqa: E501
`create_reference_portfolio_with_http_info`	CreateReferencePortfolio: Create reference portfolio # noqa: E501
`get_reference_portfolio_constituents`	GetReferencePortfolioConstituents: Get reference portfolio constituents # noqa: E501
`get_reference_portfolio_constituents_with_http_info`	GetReferencePortfolioConstituents: Get reference portfolio constituents # noqa: E501
`list_constituents_adjustments`	ListConstituentsAdjustments: List constituents adjustments # noqa: E501
`list_constituents_adjustments_with_http_info`	ListConstituentsAdjustments: List constituents adjustments # noqa: E501
`upsert_reference_portfolio_constituent_properties`	[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties # noqa: E501
`upsert_reference_portfolio_constituent_properties_with_http_info`	[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties # noqa: E501
`upsert_reference_portfolio_constituents`	UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents # noqa: E501
`upsert_reference_portfolio_constituents_with_http_info`	UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents # noqa: E501

create_reference_portfolio(scope, create_reference_portfolio_request, async_req=None, **kwargs)[source]

CreateReferencePortfolio: Create reference portfolio # noqa: E501

Create a reference portfolio 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.create_reference_portfolio(scope, create_reference_portfolio_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope in which to create the reference portfolio. (required)
create_reference_portfolio_request (CreateReferencePortfolioRequest) – The definition of the reference portfolio. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

Portfolio

create_reference_portfolio_with_http_info(scope, create_reference_portfolio_request, **kwargs)[source]

CreateReferencePortfolio: Create reference portfolio # noqa: E501

Create a reference portfolio 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.create_reference_portfolio_with_http_info(scope, create_reference_portfolio_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope in which to create the reference portfolio. (required)
create_reference_portfolio_request (CreateReferencePortfolioRequest) – The definition of the reference 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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_reference_portfolio_constituents(scope, code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)[source]

GetReferencePortfolioConstituents: Get reference portfolio constituents # noqa: E501

Get constituents from a reference portfolio at a particular effective time. # 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_reference_portfolio_constituents(scope, code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the reference portfolio. (required)
code (str) – The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
effective_at (str) – The effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified.
property_keys (List[str]) – A list of property keys from the ‘Instrument’ or ‘ReferenceHolding’ domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. ‘Instrument/system/Name’ or ‘ReferenceHolding/strategy/quantsignal’. Defaults to return all available instrument and reference holding properties if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

GetReferencePortfolioConstituentsResponse

get_reference_portfolio_constituents_with_http_info(scope, code, effective_at=None, as_at=None, property_keys=None, **kwargs)[source]

GetReferencePortfolioConstituents: Get reference portfolio constituents # noqa: E501

Get constituents from a reference portfolio at a particular effective time. # 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_reference_portfolio_constituents_with_http_info(scope, code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the reference portfolio. (required)
code (str) – The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
effective_at (str) – The effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified.
property_keys (List[str]) – A list of property keys from the ‘Instrument’ or ‘ReferenceHolding’ domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. ‘Instrument/system/Name’ or ‘ReferenceHolding/strategy/quantsignal’. Defaults to return all available instrument and reference holding properties 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GetReferencePortfolioConstituentsResponse, status_code(int), headers(HTTPHeaderDict))

list_constituents_adjustments(scope, code, from_effective_at, to_effective_at, as_at_time=None, async_req=None, **kwargs)[source]

ListConstituentsAdjustments: List constituents adjustments # noqa: E501

List adjustments made to constituents in a reference 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_constituents_adjustments(scope, code, from_effective_at, to_effective_at, as_at_time, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the reference portfolio. (required)
code (str) – The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
from_effective_at (str) – Events between this time (inclusive) and the toEffectiveAt are returned. (required)
to_effective_at (str) – Events between this time (inclusive) and the fromEffectiveAt are returned. (required)
as_at_time (datetime) – The asAt time for which the result is valid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

ResourceListOfConstituentsAdjustmentHeader

list_constituents_adjustments_with_http_info(scope, code, from_effective_at, to_effective_at, as_at_time=None, **kwargs)[source]

ListConstituentsAdjustments: List constituents adjustments # noqa: E501

List adjustments made to constituents in a reference 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_constituents_adjustments_with_http_info(scope, code, from_effective_at, to_effective_at, as_at_time, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the reference portfolio. (required)
code (str) – The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
from_effective_at (str) – Events between this time (inclusive) and the toEffectiveAt are returned. (required)
to_effective_at (str) – Events between this time (inclusive) and the fromEffectiveAt are returned. (required)
as_at_time (datetime) – The asAt time for which the result is valid.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(ResourceListOfConstituentsAdjustmentHeader, status_code(int), headers(HTTPHeaderDict))

upsert_reference_portfolio_constituent_properties(scope, code, upsert_reference_portfolio_constituent_properties_request, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties # noqa: E501

Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated. # 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_reference_portfolio_constituent_properties(scope, code, upsert_reference_portfolio_constituent_properties_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the reference portfolio. (required)
code (str) – The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
upsert_reference_portfolio_constituent_properties_request (UpsertReferencePortfolioConstituentPropertiesRequest) – The request to modify properties for the constituent. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

UpsertReferencePortfolioConstituentPropertiesResponse

upsert_reference_portfolio_constituent_properties_with_http_info(scope, code, upsert_reference_portfolio_constituent_properties_request, **kwargs)[source]

[EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties # noqa: E501

Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated. # 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_reference_portfolio_constituent_properties_with_http_info(scope, code, upsert_reference_portfolio_constituent_properties_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the reference portfolio. (required)
code (str) – The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
upsert_reference_portfolio_constituent_properties_request (UpsertReferencePortfolioConstituentPropertiesRequest) – The request to modify properties for the constituent. (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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(UpsertReferencePortfolioConstituentPropertiesResponse, status_code(int), headers(HTTPHeaderDict))

upsert_reference_portfolio_constituents(scope, code, upsert_reference_portfolio_constituents_request, async_req=None, **kwargs)[source]

UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents # noqa: E501

Add constituents to a reference 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_reference_portfolio_constituents(scope, code, upsert_reference_portfolio_constituents_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the reference portfolio. (required)
code (str) – The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
upsert_reference_portfolio_constituents_request (UpsertReferencePortfolioConstituentsRequest) – The constituents to upload to the reference portfolio. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

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

Return type:

UpsertReferencePortfolioConstituentsResponse

upsert_reference_portfolio_constituents_with_http_info(scope, code, upsert_reference_portfolio_constituents_request, **kwargs)[source]

UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents # noqa: E501

Add constituents to a reference 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_reference_portfolio_constituents_with_http_info(scope, code, upsert_reference_portfolio_constituents_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the reference portfolio. (required)
code (str) – The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. (required)
upsert_reference_portfolio_constituents_request (UpsertReferencePortfolioConstituentsRequest) – The constituents to upload to the reference 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(UpsertReferencePortfolioConstituentsResponse, status_code(int), headers(HTTPHeaderDict))