sdk.lusid.api.complex_market_data_api.ComplexMarketDataApi
- class ComplexMarketDataApi(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
[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present.
[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present.
[EARLY ACCESS] GetComplexMarketData: Get complex market data # noqa: E501
[EARLY ACCESS] GetComplexMarketData: Get complex market data # noqa: E501
[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData # noqa: E501
[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData # noqa: E501
[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items.
[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items.
- delete_complex_market_data(scope, request_body, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. # noqa: E501
Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results. # 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_complex_market_data(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the complex market data to delete. (required)
request_body (Dict[str, ComplexMarketDataId]) – The complex market data Ids to delete, each keyed by a unique correlation 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:
- delete_complex_market_data_with_http_info(scope, request_body, **kwargs)[source]
[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. # noqa: E501
Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results. # 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_complex_market_data_with_http_info(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the complex market data to delete. (required)
request_body (Dict[str, ComplexMarketDataId]) – The complex market data Ids to delete, each keyed by a unique correlation 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(AnnulStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
- get_complex_market_data(scope, request_body, effective_at=None, as_at=None, max_age=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetComplexMarketData: Get complex market data # noqa: E501
Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results. # 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_complex_market_data(scope, request_body, effective_at, as_at, max_age, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the complex market data to retrieve. (required)
request_body (Dict[str, ComplexMarketDataId]) – The time invariant set of complex data identifiers to retrieve the data for. These need to be keyed by a unique correlation id allowing the retrieved item to be identified in the response. (required)
effective_at (str) – The effective datetime at which to retrieve the complex market data. Defaults to the current LUSID system datetime if not specified. Must match the Effective at of each ComplexMarketDataId given in the request body.
as_at (datetime) – The asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified.
max_age (str) – The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a complex market data item must exist to be retrieved.
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_complex_market_data_with_http_info(scope, request_body, effective_at=None, as_at=None, max_age=None, **kwargs)[source]
[EARLY ACCESS] GetComplexMarketData: Get complex market data # noqa: E501
Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results. # 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_complex_market_data_with_http_info(scope, request_body, effective_at, as_at, max_age, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the complex market data to retrieve. (required)
request_body (Dict[str, ComplexMarketDataId]) – The time invariant set of complex data identifiers to retrieve the data for. These need to be keyed by a unique correlation id allowing the retrieved item to be identified in the response. (required)
effective_at (str) – The effective datetime at which to retrieve the complex market data. Defaults to the current LUSID system datetime if not specified. Must match the Effective at of each ComplexMarketDataId given in the request body.
as_at (datetime) – The asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified.
max_age (str) – The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a complex market data item must exist to be retrieved.
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(GetComplexMarketDataResponse, status_code(int), headers(HTTPHeaderDict))
- list_complex_market_data(as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData # noqa: E501
List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that 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_complex_market_data(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the ComplexMarketData. Defaults to latest 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:
- list_complex_market_data_with_http_info(as_at=None, **kwargs)[source]
[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData # noqa: E501
List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that 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_complex_market_data_with_http_info(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the ComplexMarketData. Defaults to latest 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(ResourceListOfListComplexMarketDataWithMetaDataResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_complex_market_data(scope, request_body, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. # noqa: E501
Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. # 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_complex_market_data(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to use when updating or inserting the complex market data. (required)
request_body (Dict[str, UpsertComplexMarketDataRequest]) – The set of complex market data items to update or insert keyed by a unique correlation 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:
- upsert_complex_market_data_with_http_info(scope, request_body, **kwargs)[source]
[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. # noqa: E501
Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. # 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_complex_market_data_with_http_info(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to use when updating or inserting the complex market data. (required)
request_body (Dict[str, UpsertComplexMarketDataRequest]) – The set of complex market data items to update or insert keyed by a unique correlation 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(UpsertStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))