sdk.lusid.api.corporate_action_sources_api.CorporateActionSourcesApi
- class CorporateActionSourcesApi(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] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source.
[EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source.
[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source # noqa: E501
[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source # noqa: E501
[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source.
[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source.
[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions # noqa: E501
[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions # noqa: E501
[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source.
[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source.
[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source.
[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source.
[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source.
[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source.
[EARLY ACCESS] ListCorporateActionSources: List corporate action sources # noqa: E501
[EARLY ACCESS] ListCorporateActionSources: List corporate action sources # noqa: E501
[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source.
[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source.
- batch_upsert_corporate_actions(scope, code, upsert_corporate_action_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. # noqa: E501
Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,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.batch_upsert_corporate_actions(scope, code, upsert_corporate_action_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of corporate action source (required)
code (str) – The code of the corporate action source (required)
upsert_corporate_action_request (List[UpsertCorporateActionRequest]) – The corporate action definitions
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:
- batch_upsert_corporate_actions_with_http_info(scope, code, upsert_corporate_action_request=None, **kwargs)[source]
[EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. # noqa: E501
Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,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.batch_upsert_corporate_actions_with_http_info(scope, code, upsert_corporate_action_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of corporate action source (required)
code (str) – The code of the corporate action source (required)
upsert_corporate_action_request (List[UpsertCorporateActionRequest]) – The corporate action definitions
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(UpsertCorporateActionsResponse, status_code(int), headers(HTTPHeaderDict))
- create_corporate_action_source(create_corporate_action_source_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source # noqa: E501
Create a corporate action source. # 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_corporate_action_source(create_corporate_action_source_request, async_req=True) >>> result = thread.get()
- Parameters:
create_corporate_action_source_request (CreateCorporateActionSourceRequest) – The corporate action source definition (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:
- create_corporate_action_source_with_http_info(create_corporate_action_source_request, **kwargs)[source]
[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source # noqa: E501
Create a corporate action source. # 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_corporate_action_source_with_http_info(create_corporate_action_source_request, async_req=True) >>> result = thread.get()
- Parameters:
create_corporate_action_source_request (CreateCorporateActionSourceRequest) – The corporate action source definition (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(CorporateActionSource, status_code(int), headers(HTTPHeaderDict))
- delete_corporate_action_source(scope, code, async_req=None, **kwargs)[source]
[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. # noqa: E501
Deletes a single corporate action source # 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_corporate_action_source(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source to be deleted (required)
code (str) – The code of the corporate action source to be deleted (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_corporate_action_source_with_http_info(scope, code, **kwargs)[source]
[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. # noqa: E501
Deletes a single corporate action source # 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_corporate_action_source_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source to be deleted (required)
code (str) – The code of the corporate action source to be deleted (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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- delete_corporate_actions(scope, code, corporate_action_ids, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions # noqa: E501
Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,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.delete_corporate_actions(scope, code, corporate_action_ids, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source (required)
code (str) – The code of the corporate action source (required)
corporate_action_ids (List[str]) – The IDs of the corporate actions to delete (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_corporate_actions_with_http_info(scope, code, corporate_action_ids, **kwargs)[source]
[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions # noqa: E501
Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,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.delete_corporate_actions_with_http_info(scope, code, corporate_action_ids, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source (required)
code (str) – The code of the corporate action source (required)
corporate_action_ids (List[str]) – The IDs of the corporate actions to delete (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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- delete_instrument_events(scope, code, instrument_event_ids, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. # noqa: E501
Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,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.delete_instrument_events(scope, code, instrument_event_ids, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source (required)
code (str) – The code of the corporate action source (required)
instrument_event_ids (List[str]) – The IDs of the instrument events to delete (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_instrument_events_with_http_info(scope, code, instrument_event_ids, **kwargs)[source]
[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. # noqa: E501
Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,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.delete_instrument_events_with_http_info(scope, code, instrument_event_ids, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source (required)
code (str) – The code of the corporate action source (required)
instrument_event_ids (List[str]) – The IDs of the instrument events to delete (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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- get_corporate_actions(scope, code, from_effective_at=None, to_effective_at=None, as_at=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. # noqa: E501
Get corporate actions from a particular corporate action source. # 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_corporate_actions(scope, code, from_effective_at, to_effective_at, as_at, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source. (required)
code (str) – The code of the corporate action source. (required)
from_effective_at (str) – Optional. The start effective date of the data range.
to_effective_at (str) – Optional. The end effective date of the data range.
as_at (datetime) – Optional. The AsAt date of the data.
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the results to this number.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Announcement Date, use “announcementDate eq ‘2020-03-06’” 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_corporate_actions_with_http_info(scope, code, from_effective_at=None, to_effective_at=None, as_at=None, sort_by=None, limit=None, filter=None, **kwargs)[source]
[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. # noqa: E501
Get corporate actions from a particular corporate action source. # 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_corporate_actions_with_http_info(scope, code, from_effective_at, to_effective_at, as_at, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source. (required)
code (str) – The code of the corporate action source. (required)
from_effective_at (str) – Optional. The start effective date of the data range.
to_effective_at (str) – Optional. The end effective date of the data range.
as_at (datetime) – Optional. The AsAt date of the data.
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the results to this number.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Announcement Date, use “announcementDate eq ‘2020-03-06’” 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(ResourceListOfCorporateAction, status_code(int), headers(HTTPHeaderDict))
- get_instrument_events(scope, code, as_at=None, limit=None, page=None, filter=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. # noqa: E501
Retrieves extrinsic corporate actions out of a corporate actions source # 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_instrument_events(scope, code, as_at, limit, page, filter, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source. (required)
code (str) – The code of the corporate action source. (required)
as_at (datetime) – Optional. The AsAt date of the data.
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, asAt, filter and limit must not be modified.
filter (str) – Optional. Expression to filter the result set.
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_instrument_events_with_http_info(scope, code, as_at=None, limit=None, page=None, filter=None, **kwargs)[source]
[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. # noqa: E501
Retrieves extrinsic corporate actions out of a corporate actions source # 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_instrument_events_with_http_info(scope, code, as_at, limit, page, filter, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source. (required)
code (str) – The code of the corporate action source. (required)
as_at (datetime) – Optional. The AsAt date of the data.
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, asAt, filter and limit must not be modified.
filter (str) – Optional. Expression to filter the result set.
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(PagedResourceListOfInstrumentEventHolder, status_code(int), headers(HTTPHeaderDict))
- list_corporate_action_sources(as_at=None, sort_by=None, limit=None, filter=None, page=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListCorporateActionSources: List corporate action sources # noqa: E501
Gets a list of all corporate action sources # 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_corporate_action_sources(as_at, sort_by, limit, filter, page, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. The AsAt date of the data
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Display Name, use “displayName eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
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, the filter, asAt, and limit must not be modified.
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_corporate_action_sources_with_http_info(as_at=None, sort_by=None, limit=None, filter=None, page=None, **kwargs)[source]
[EARLY ACCESS] ListCorporateActionSources: List corporate action sources # noqa: E501
Gets a list of all corporate action sources # 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_corporate_action_sources_with_http_info(as_at, sort_by, limit, filter, page, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. The AsAt date of the data
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Display Name, use “displayName eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
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, the filter, asAt, and limit must not be modified.
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(PagedResourceListOfCorporateActionSource, status_code(int), headers(HTTPHeaderDict))
- upsert_instrument_events(scope, code, upsert_instrument_event_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. # noqa: E501
Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,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_instrument_events(scope, code, upsert_instrument_event_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source. (required)
code (str) – The code of the corporate action source. (required)
upsert_instrument_event_request (List[UpsertInstrumentEventRequest]) – The instrument event definitions.
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_instrument_events_with_http_info(scope, code, upsert_instrument_event_request=None, **kwargs)[source]
[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. # noqa: E501
Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,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_instrument_events_with_http_info(scope, code, upsert_instrument_event_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the corporate action source. (required)
code (str) – The code of the corporate action source. (required)
upsert_instrument_event_request (List[UpsertInstrumentEventRequest]) – The instrument event definitions.
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(UpsertInstrumentEventsResponse, status_code(int), headers(HTTPHeaderDict))