sdk.lusid.api.order_management_api.OrderManagementApi
- class OrderManagementApi(api_client=None)[source]
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Methods
[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source.
[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source.
[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders # noqa: E501
[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders # noqa: E501
[EARLY ACCESS] MoveOrders: Move orders to new or existing block # noqa: E501
[EARLY ACCESS] MoveOrders: Move orders to new or existing block # noqa: E501
[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests.
[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests.
[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service # noqa: E501
[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service # noqa: E501
- book_transactions(book_transactions_request, apply_fees_and_commission=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source. # noqa: E501
Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.book_transactions(book_transactions_request, apply_fees_and_commission, async_req=True) >>> result = thread.get()
- Parameters:
book_transactions_request (BookTransactionsRequest) – The allocations to create transactions for (required)
apply_fees_and_commission (bool) – Whether to apply fees and commissions to transactions (default: true)
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:
- book_transactions_with_http_info(book_transactions_request, apply_fees_and_commission=None, **kwargs)[source]
[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source. # noqa: E501
Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.book_transactions_with_http_info(book_transactions_request, apply_fees_and_commission, async_req=True) >>> result = thread.get()
- Parameters:
book_transactions_request (BookTransactionsRequest) – The allocations to create transactions for (required)
apply_fees_and_commission (bool) – Whether to apply fees and commissions to transactions (default: true)
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(BookTransactionsResponse, status_code(int), headers(HTTPHeaderDict))
- create_orders(block_and_orders_create_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders # noqa: E501
Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_orders(block_and_orders_create_request, async_req=True) >>> result = thread.get()
- Parameters:
block_and_orders_create_request (BlockAndOrdersCreateRequest) – The collection of block and orders requests. (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_orders_with_http_info(block_and_orders_create_request, **kwargs)[source]
[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders # noqa: E501
Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_orders_with_http_info(block_and_orders_create_request, async_req=True) >>> result = thread.get()
- Parameters:
block_and_orders_create_request (BlockAndOrdersCreateRequest) – The collection of block and orders requests. (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(ResourceListOfBlockAndOrders, status_code(int), headers(HTTPHeaderDict))
- move_orders(move_orders_to_different_blocks_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] MoveOrders: Move orders to new or existing block # noqa: E501
Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.move_orders(move_orders_to_different_blocks_request, async_req=True) >>> result = thread.get()
- Parameters:
move_orders_to_different_blocks_request (MoveOrdersToDifferentBlocksRequest) – The collection of order and destination block ids. (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:
- move_orders_with_http_info(move_orders_to_different_blocks_request, **kwargs)[source]
[EARLY ACCESS] MoveOrders: Move orders to new or existing block # noqa: E501
Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.move_orders_with_http_info(move_orders_to_different_blocks_request, async_req=True) >>> result = thread.get()
- Parameters:
move_orders_to_different_blocks_request (MoveOrdersToDifferentBlocksRequest) – The collection of order and destination block ids. (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(ResourceListOfMovedOrderToDifferentBlockResponse, status_code(int), headers(HTTPHeaderDict))
- place_blocks(place_blocks_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. # noqa: E501
The referenced block’s existence will be verified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.place_blocks(place_blocks_request, async_req=True) >>> result = thread.get()
- Parameters:
place_blocks_request (PlaceBlocksRequest) – The request containing the blocks to the placed.
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:
- place_blocks_with_http_info(place_blocks_request=None, **kwargs)[source]
[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. # noqa: E501
The referenced block’s existence will be verified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.place_blocks_with_http_info(place_blocks_request, async_req=True) >>> result = thread.get()
- Parameters:
place_blocks_request (PlaceBlocksRequest) – The request containing the blocks to the placed.
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(ResourceListOfPlacement, status_code(int), headers(HTTPHeaderDict))
- run_allocation_service(resource_id, allocation_algorithm=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service # noqa: E501
This will allocate executions for a given list of placements back to their originating orders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_allocation_service(resource_id, allocation_algorithm, async_req=True) >>> result = thread.get()
- Parameters:
resource_id (List[ResourceId]) – The List of Placement IDs for which you wish to allocate executions. (required)
allocation_algorithm (str) – A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. “PR-FIFO”. This defaults to “PR-FIFO”.
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:
- run_allocation_service_with_http_info(resource_id, allocation_algorithm=None, **kwargs)[source]
[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service # noqa: E501
This will allocate executions for a given list of placements back to their originating orders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_allocation_service_with_http_info(resource_id, allocation_algorithm, async_req=True) >>> result = thread.get()
- Parameters:
resource_id (List[ResourceId]) – The List of Placement IDs for which you wish to allocate executions. (required)
allocation_algorithm (str) – A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. “PR-FIFO”. This defaults to “PR-FIFO”.
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(AllocationServiceRunResponse, status_code(int), headers(HTTPHeaderDict))