sdk.lusid.api.aggregation_api.AggregationApi
- class AggregationApi(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
[EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio.
[EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio.
[EARLY ACCESS] GetQueryableKeys: Query the set of supported "addresses" that can be queried from the aggregation endpoint.
[EARLY ACCESS] GetQueryableKeys: Query the set of supported "addresses" that can be queried from the aggregation endpoint.
GetValuation: Perform valuation for a list of portfolios and/or portfolio groups # noqa: E501
GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio # noqa: E501
GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio # noqa: E501
GetValuation: Perform valuation for a list of portfolios and/or portfolio groups # noqa: E501
- generate_configuration_recipe(scope, code, create_recipe_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio. # noqa: E501
Given a set of scopes, a portfolio Id and a basic recipe, this endpoint generates a configuration recipe with relevant rules that can value the instruments in the 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.generate_configuration_recipe(scope, code, create_recipe_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the portfolio (required)
code (str) – The code of the portfolio (required)
create_recipe_request (CreateRecipeRequest) – The request specifying the parameters to generating the recipe
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:
- generate_configuration_recipe_with_http_info(scope, code, create_recipe_request=None, **kwargs)[source]
[EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio. # noqa: E501
Given a set of scopes, a portfolio Id and a basic recipe, this endpoint generates a configuration recipe with relevant rules that can value the instruments in the 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.generate_configuration_recipe_with_http_info(scope, code, create_recipe_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the portfolio (required)
code (str) – The code of the portfolio (required)
create_recipe_request (CreateRecipeRequest) – The request specifying the parameters to generating the recipe
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(ConfigurationRecipe, status_code(int), headers(HTTPHeaderDict))
- get_queryable_keys(page=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetQueryableKeys: Query the set of supported “addresses” that can be queried from the aggregation endpoint. # noqa: E501
When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return. # 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_queryable_keys(page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
page (str) – The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
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:
- get_queryable_keys_with_http_info(page=None, limit=None, filter=None, **kwargs)[source]
[EARLY ACCESS] GetQueryableKeys: Query the set of supported “addresses” that can be queried from the aggregation endpoint. # noqa: E501
When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return. # 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_queryable_keys_with_http_info(page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
page (str) – The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
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(ResourceListOfAggregationQuery, status_code(int), headers(HTTPHeaderDict))
- get_valuation(valuation_request=None, async_req=None, **kwargs)[source]
GetValuation: Perform valuation for a list of portfolios and/or portfolio groups # noqa: E501
Perform valuation on specified list of portfolio and/or portfolio groups for a set of dates. # 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_valuation(valuation_request, async_req=True) >>> result = thread.get()
- Parameters:
valuation_request (ValuationRequest) – The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics
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:
- get_valuation_of_weighted_instruments(inline_valuation_request=None, async_req=None, **kwargs)[source]
GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio # noqa: E501
Perform valuation on the portfolio that is defined by the weighted set of instruments passed to the request. # 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_valuation_of_weighted_instruments(inline_valuation_request, async_req=True) >>> result = thread.get()
- Parameters:
inline_valuation_request (InlineValuationRequest) – The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics
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:
- get_valuation_of_weighted_instruments_with_http_info(inline_valuation_request=None, **kwargs)[source]
GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio # noqa: E501
Perform valuation on the portfolio that is defined by the weighted set of instruments passed to the request. # 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_valuation_of_weighted_instruments_with_http_info(inline_valuation_request, async_req=True) >>> result = thread.get()
- Parameters:
inline_valuation_request (InlineValuationRequest) – The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics
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(ListAggregationResponse, status_code(int), headers(HTTPHeaderDict))
- get_valuation_with_http_info(valuation_request=None, **kwargs)[source]
GetValuation: Perform valuation for a list of portfolios and/or portfolio groups # noqa: E501
Perform valuation on specified list of portfolio and/or portfolio groups for a set of dates. # 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_valuation_with_http_info(valuation_request, async_req=True) >>> result = thread.get()
- Parameters:
valuation_request (ValuationRequest) – The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics
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(ListAggregationResponse, status_code(int), headers(HTTPHeaderDict))