sdk.lusid.api.quotes_api.QuotesApi

class QuotesApi(api_client=None)

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

Do not edit the class manually.

Methods

delete_quote_access_metadata_rule	[EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule # noqa: E501
delete_quote_access_metadata_rule_with_http_info	[EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule # noqa: E501
delete_quotes	DeleteQuotes: Delete quotes # noqa: E501
delete_quotes_with_http_info	DeleteQuotes: Delete quotes # noqa: E501
get_quotes	[EARLY ACCESS] GetQuotes: Get quotes # noqa: E501
get_quotes_access_metadata_rule	[EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule # noqa: E501
get_quotes_access_metadata_rule_with_http_info	[EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule # noqa: E501
get_quotes_with_http_info	[EARLY ACCESS] GetQuotes: Get quotes # noqa: E501
list_quotes	[DEPRECATED] ListQuotes: List quotes # noqa: E501
list_quotes_access_metadata_rules	[EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope # noqa: E501
list_quotes_access_metadata_rules_with_http_info	[EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope # noqa: E501
list_quotes_for_scope	ListQuotesForScope: List quotes for scope # noqa: E501
list_quotes_for_scope_with_http_info	ListQuotesForScope: List quotes for scope # noqa: E501
list_quotes_with_http_info	[DEPRECATED] ListQuotes: List quotes # noqa: E501
upsert_quote_access_metadata_rule	[EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule.
upsert_quote_access_metadata_rule_with_http_info	[EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule.
upsert_quotes	UpsertQuotes: Upsert quotes # noqa: E501
upsert_quotes_with_http_info	UpsertQuotes: Upsert quotes # noqa: E501

delete_quote_access_metadata_rule(scope, provider=None, price_source=None, instrument_id_type=None, instrument_id=None, quote_type=None, field=None, effective_at=None, async_req=None, **kwargs)

[EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule # noqa: E501

Delete the Quote Access Metadata Rule that exactly matches the provided identifier parts # 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_quote_access_metadata_rule(scope, provider, price_source, instrument_id_type, instrument_id, quote_type, field, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Quote Access Metadata Rule to retrieve. (required)

• provider (str) – The Provider of the rule

• price_source (str) – The PriceSource of the rule

• instrument_id_type (str) – The InstrumentIdType of the rule

• instrument_id (str) – The InstrumentId of the rule

• quote_type (str) – The QuoteType of the rule

• field (str) – The Field of the rule

• effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found

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

QuoteAccessMetadataRule

delete_quote_access_metadata_rule_with_http_info(scope, provider=None, price_source=None, instrument_id_type=None, instrument_id=None, quote_type=None, field=None, effective_at=None, **kwargs)

[EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule # noqa: E501

Delete the Quote Access Metadata Rule that exactly matches the provided identifier parts # 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_quote_access_metadata_rule_with_http_info(scope, provider, price_source, instrument_id_type, instrument_id, quote_type, field, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Quote Access Metadata Rule to retrieve. (required)

• provider (str) – The Provider of the rule

• price_source (str) – The PriceSource of the rule

• instrument_id_type (str) – The InstrumentIdType of the rule

• instrument_id (str) – The InstrumentId of the rule

• quote_type (str) – The QuoteType of the rule

• field (str) – The Field of the rule

• effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found

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

delete_quotes(scope, request_body=None, async_req=None, **kwargs)

DeleteQuotes: Delete quotes # noqa: E501

Delete one or more specified quotes from a single scope. A quote is identified by its unique id which includes information about the type of quote as well as the exact effective datetime (to the microsecond) from which it became valid. In the request each quote 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 quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote 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_quotes(scope, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the quotes to delete. (required)

• request_body (Dict[str, QuoteId]) – The quotes to delete keyed by a unique correlation id.

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

AnnulQuotesResponse

delete_quotes_with_http_info(scope, request_body=None, **kwargs)

DeleteQuotes: Delete quotes # noqa: E501

Delete one or more specified quotes from a single scope. A quote is identified by its unique id which includes information about the type of quote as well as the exact effective datetime (to the microsecond) from which it became valid. In the request each quote 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 quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote 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_quotes_with_http_info(scope, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the quotes to delete. (required)

• request_body (Dict[str, QuoteId]) – The quotes to delete keyed by a unique correlation id.

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

get_quotes(scope, effective_at=None, as_at=None, max_age=None, request_body=None, async_req=None, **kwargs)

[EARLY ACCESS] GetQuotes: Get quotes # noqa: E501

Get one or more quotes from a single scope. Each quote can be identified by its time invariant quote series id. For each quote series id LUSID will return the most recent quote 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 a quote from the specified effective datetime. LUSID will return the most recent quote within this window. In the request each quote series 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 quote in the response. The response will return three collections. One, the successfully retrieved quotes. Two, those that had a valid quote series id but could not be found. Three, those that failed because LUSID could not construct a valid quote series id from the request. For the quotes that failed or could not be found a reason will be provided explaining why the quote could not be retrieved. It is important to always check the failed and not found sets for any unsuccessful results. The maximum number of quotes that this method can get per request is 2,000. # 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_quotes(scope, effective_at, as_at, max_age, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the quotes to retrieve. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote 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 or cut label to generate a effective datetime window inside which a quote must exist to be retrieved.

• request_body (Dict[str, QuoteSeriesId]) – The time invariant quote series ids of the quotes to retrieve. These need to be keyed by a unique correlation id allowing the retrieved quote to be identified in the response.

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

GetQuotesResponse

get_quotes_access_metadata_rule(scope, provider=None, price_source=None, instrument_id_type=None, instrument_id=None, quote_type=None, field=None, effective_at=None, as_at=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule # noqa: E501

Get a specific quote access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule # 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_quotes_access_metadata_rule(scope, provider, price_source, instrument_id_type, instrument_id, quote_type, field, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Quote Access Metadata Rule to retrieve. (required)

• provider (str) – The Provider of the rule

• price_source (str) – The PriceSource of the rule

• instrument_id_type (str) – The InstrumentIdType of the rule

• instrument_id (str) – The InstrumentId of the rule

• quote_type (str) – The QuoteType of the rule

• field (str) – The Field of the rule

• effective_at (str) – The effective date of the rule

• as_at (datetime) – The asAt datetime at which to retrieve the access metadata rule. Defaults to return the latest version 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:

QuoteAccessMetadataRule

get_quotes_access_metadata_rule_with_http_info(scope, provider=None, price_source=None, instrument_id_type=None, instrument_id=None, quote_type=None, field=None, effective_at=None, as_at=None, **kwargs)

[EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule # noqa: E501

Get a specific quote access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule # 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_quotes_access_metadata_rule_with_http_info(scope, provider, price_source, instrument_id_type, instrument_id, quote_type, field, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Quote Access Metadata Rule to retrieve. (required)

• provider (str) – The Provider of the rule

• price_source (str) – The PriceSource of the rule

• instrument_id_type (str) – The InstrumentIdType of the rule

• instrument_id (str) – The InstrumentId of the rule

• quote_type (str) – The QuoteType of the rule

• field (str) – The Field of the rule

• effective_at (str) – The effective date of the rule

• as_at (datetime) – The asAt datetime at which to retrieve the access metadata rule. Defaults to return the latest version 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(QuoteAccessMetadataRule, status_code(int), headers(HTTPHeaderDict))

get_quotes_with_http_info(scope, effective_at=None, as_at=None, max_age=None, request_body=None, **kwargs)

[EARLY ACCESS] GetQuotes: Get quotes # noqa: E501

Get one or more quotes from a single scope. Each quote can be identified by its time invariant quote series id. For each quote series id LUSID will return the most recent quote 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 a quote from the specified effective datetime. LUSID will return the most recent quote within this window. In the request each quote series 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 quote in the response. The response will return three collections. One, the successfully retrieved quotes. Two, those that had a valid quote series id but could not be found. Three, those that failed because LUSID could not construct a valid quote series id from the request. For the quotes that failed or could not be found a reason will be provided explaining why the quote could not be retrieved. It is important to always check the failed and not found sets for any unsuccessful results. The maximum number of quotes that this method can get per request is 2,000. # 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_quotes_with_http_info(scope, effective_at, as_at, max_age, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the quotes to retrieve. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote 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 or cut label to generate a effective datetime window inside which a quote must exist to be retrieved.

• request_body (Dict[str, QuoteSeriesId]) – The time invariant quote series ids of the quotes to retrieve. These need to be keyed by a unique correlation id allowing the retrieved quote to be identified in the response.

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

list_quotes(scope, as_at=None, page=None, limit=None, filter=None, async_req=None, **kwargs)

[DEPRECATED] ListQuotes: List quotes # noqa: E501

List all the quotes from a single scope at the specified date/time Please use M:Finbourne.WebApi.Controllers.QuotesController.ListQuotesForScope(System.String,System.Nullable{System.DateTimeOffset},System.String,System.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit 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_quotes(scope, as_at, page, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the quotes to list. (required)

• as_at (datetime) – The asAt datetime at which to list the quotes. Defaults to latest if not specified.

• page (str) – The pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.

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

ResourceListOfQuote

list_quotes_access_metadata_rules(scope, as_at=None, async_req=None, **kwargs)

[EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope # noqa: E501

Get all the quote access metadata rules in the specified 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_quotes_access_metadata_rules(scope, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Quote Access Metadata Rule to retrieve. (required)

• as_at (datetime) – The asAt datetime at which to retrieve the access metadata rule. Defaults to return the latest version 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:

ResourceListOfQuoteAccessMetadataRule

list_quotes_access_metadata_rules_with_http_info(scope, as_at=None, **kwargs)

[EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope # noqa: E501

Get all the quote access metadata rules in the specified 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_quotes_access_metadata_rules_with_http_info(scope, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Quote Access Metadata Rule to retrieve. (required)

• as_at (datetime) – The asAt datetime at which to retrieve the access metadata rule. Defaults to return the latest version 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(ResourceListOfQuoteAccessMetadataRule, status_code(int), headers(HTTPHeaderDict))

list_quotes_for_scope(scope, as_at=None, page=None, limit=None, filter=None, async_req=None, **kwargs)

ListQuotesForScope: List quotes for scope # noqa: E501

List all the quotes from a single scope at the specified date/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.list_quotes_for_scope(scope, as_at, page, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the quotes to list. (required)

• as_at (datetime) – The asAt datetime at which to list the quotes. Defaults to latest if not specified.

• page (str) – The pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.

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

ResourceListOfQuote

list_quotes_for_scope_with_http_info(scope, as_at=None, page=None, limit=None, filter=None, **kwargs)

ListQuotesForScope: List quotes for scope # noqa: E501

List all the quotes from a single scope at the specified date/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.list_quotes_for_scope_with_http_info(scope, as_at, page, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the quotes to list. (required)

• as_at (datetime) – The asAt datetime at which to list the quotes. Defaults to latest if not specified.

• page (str) – The pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.

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

list_quotes_with_http_info(scope, as_at=None, page=None, limit=None, filter=None, **kwargs)

[DEPRECATED] ListQuotes: List quotes # noqa: E501

List all the quotes from a single scope at the specified date/time Please use M:Finbourne.WebApi.Controllers.QuotesController.ListQuotesForScope(System.String,System.Nullable{System.DateTimeOffset},System.String,System.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit 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_quotes_with_http_info(scope, as_at, page, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the quotes to list. (required)

• as_at (datetime) – The asAt datetime at which to list the quotes. Defaults to latest if not specified.

• page (str) – The pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.

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

upsert_quote_access_metadata_rule(scope, upsert_quote_access_metadata_rule_request, effective_at=None, effective_until=None, async_req=None, **kwargs)

[EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule. This creates or updates the data in LUSID. # noqa: E501

Update or insert one Quote Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Quote Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a key can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched # 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_quote_access_metadata_rule(scope, upsert_quote_access_metadata_rule_request, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope to use when updating or inserting the Quote Access Metadata Rule. (required)

• upsert_quote_access_metadata_rule_request (UpsertQuoteAccessMetadataRuleRequest) – The Quote Access Metadata Rule to update or insert (required)

• effective_at (str) – The date this rule will effective from

• effective_until (datetime) – The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date of the Access Metadata

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

QuoteAccessMetadataRule

upsert_quote_access_metadata_rule_with_http_info(scope, upsert_quote_access_metadata_rule_request, effective_at=None, effective_until=None, **kwargs)

[EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule. This creates or updates the data in LUSID. # noqa: E501

Update or insert one Quote Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Quote Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a key can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched # 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_quote_access_metadata_rule_with_http_info(scope, upsert_quote_access_metadata_rule_request, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope to use when updating or inserting the Quote Access Metadata Rule. (required)

• upsert_quote_access_metadata_rule_request (UpsertQuoteAccessMetadataRuleRequest) – The Quote Access Metadata Rule to update or insert (required)

• effective_at (str) – The date this rule will effective from

• effective_until (datetime) – The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date of the Access Metadata

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

upsert_quotes(scope, request_body=None, async_req=None, **kwargs)

UpsertQuotes: Upsert quotes # noqa: E501

Update or insert one or more quotes in a single scope. A quote will be updated if it already exists and inserted if it does not. In the request each quote 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 updated or inserted quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. The maximum number of quotes that this method can upsert per request is 2,000. # 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_quotes(scope, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope to use when updating or inserting the quotes. (required)

• request_body (Dict[str, UpsertQuoteRequest]) – The quotes to update or insert keyed by a unique correlation id.

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

UpsertQuotesResponse

upsert_quotes_with_http_info(scope, request_body=None, **kwargs)

UpsertQuotes: Upsert quotes # noqa: E501

Update or insert one or more quotes in a single scope. A quote will be updated if it already exists and inserted if it does not. In the request each quote 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 updated or inserted quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. The maximum number of quotes that this method can upsert per request is 2,000. # 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_quotes_with_http_info(scope, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope to use when updating or inserting the quotes. (required)

• request_body (Dict[str, UpsertQuoteRequest]) – The quotes to update or insert keyed by a unique correlation id.

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