sdk.lusid.api.instrument_events_api.InstrumentEventsApi

class InstrumentEventsApi(api_client=None)

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

Do not edit the class manually.

Methods

query_bucketed_cash_flows	[EXPERIMENTAL] QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.
query_bucketed_cash_flows_with_http_info	[EXPERIMENTAL] QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.
query_cash_flows	[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.
query_cash_flows_with_http_info	[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.
query_instrument_events	[EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.
query_instrument_events_with_http_info	[EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.
query_trade_tickets	[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query.
query_trade_tickets_with_http_info	[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query.

query_bucketed_cash_flows(query_bucketed_cash_flows_request=None, async_req=None, **kwargs)

[EXPERIMENTAL] QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501

Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_bucketed_cash_flows(query_bucketed_cash_flows_request, async_req=True)
>>> result = thread.get()

Parameters:

• query_bucketed_cash_flows_request (QueryBucketedCashFlowsRequest) – The Query Information.

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

BucketedCashFlowResponse

query_bucketed_cash_flows_with_http_info(query_bucketed_cash_flows_request=None, **kwargs)

[EXPERIMENTAL] QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501

Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_bucketed_cash_flows_with_http_info(query_bucketed_cash_flows_request, async_req=True)
>>> result = thread.get()

Parameters:

• query_bucketed_cash_flows_request (QueryBucketedCashFlowsRequest) – The Query Information.

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

query_cash_flows(limit=None, page=None, query_cash_flows_request=None, async_req=None, **kwargs)

[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501

Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_cash_flows(limit, page, query_cash_flows_request, async_req=True)
>>> result = thread.get()

Parameters:

• limit (int) – Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.

• page (str) – Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.

• query_cash_flows_request (QueryCashFlowsRequest) – The filter parameters used to retrieve instrument events.

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

ResourceListOfInstrumentCashFlow

query_cash_flows_with_http_info(limit=None, page=None, query_cash_flows_request=None, **kwargs)

[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501

Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_cash_flows_with_http_info(limit, page, query_cash_flows_request, async_req=True)
>>> result = thread.get()

Parameters:

• limit (int) – Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.

• page (str) – Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.

• query_cash_flows_request (QueryCashFlowsRequest) – The filter parameters used to retrieve instrument events.

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

query_instrument_events(limit=None, page=None, query_instrument_events_request=None, async_req=None, **kwargs)

[EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501

Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_instrument_events(limit, page, query_instrument_events_request, async_req=True)
>>> result = thread.get()

Parameters:

• limit (int) – Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.

• page (str) – Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.

• query_instrument_events_request (QueryInstrumentEventsRequest) – The filter parameters used to retrieve instrument events.

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

ResourceListOfInstrumentEventHolder

query_instrument_events_with_http_info(limit=None, page=None, query_instrument_events_request=None, **kwargs)

[EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501

Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_instrument_events_with_http_info(limit, page, query_instrument_events_request, async_req=True)
>>> result = thread.get()

Parameters:

• limit (int) – Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.

• page (str) – Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.

• query_instrument_events_request (QueryInstrumentEventsRequest) – The filter parameters used to retrieve instrument events.

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

query_trade_tickets(limit=None, page=None, query_trade_tickets_request=None, async_req=None, **kwargs)

[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. # noqa: E501

Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. These trade tickets are derived from events that involve transition of instrument states, such as transitions on exercise or default of an instrument. The trade tickets are to allow the new position to be created given the existing portfolio configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_trade_tickets(limit, page, query_trade_tickets_request, async_req=True)
>>> result = thread.get()

Parameters:

• limit (int) – Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.

• page (str) – Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.

• query_trade_tickets_request (QueryTradeTicketsRequest) – The filter parameters used to retrieve instrument events.

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

ResourceListOfPortfolioTradeTicket

query_trade_tickets_with_http_info(limit=None, page=None, query_trade_tickets_request=None, **kwargs)

[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. # noqa: E501

Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. These trade tickets are derived from events that involve transition of instrument states, such as transitions on exercise or default of an instrument. The trade tickets are to allow the new position to be created given the existing portfolio configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_trade_tickets_with_http_info(limit, page, query_trade_tickets_request, async_req=True)
>>> result = thread.get()

Parameters:

• limit (int) – Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.

• page (str) – Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.

• query_trade_tickets_request (QueryTradeTicketsRequest) – The filter parameters used to retrieve instrument events.

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