webull-openapi-python-sdk 1.0.0__py3-none-any.whl

webull/trade/request/get_tradeable_instruments_request.py

@@ -0,0 +1,27 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+from webull.core.request import ApiRequest
+
+
+class TradeableInstrumentRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trade/instrument/tradable/list", version='v2', method="GET", query_params={})
+
+    def set_last_instrument_id(self, last_security_id):
+        self.add_query_param("last_security_id", last_security_id)
+
+    def set_page_size(self, page_size):
+        self.add_query_param("page_size", page_size)

webull/trade/request/palce_order_request.py

@@ -0,0 +1,91 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+import inspect
+import json
+
+from webull.core.context.request_context_holder import RequestContextHolder
+from webull.core.request import ApiRequest
+
+class PlaceOrderRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trade/order/place", version='v2', method="POST", body_params={})
+        self._stock_order = {}
+        self.add_body_params("stock_order", self._stock_order)
+
+    def add_stock_order_params(self, k, v):
+        self._stock_order[k] = v
+
+    def set_category(self, category):
+        self.add_body_params("category", category)
+
+    def set_account_id(self, account_id):
+        self.add_body_params("account_id", account_id)
+
+    def set_client_order_id(self, client_order_id):
+        self.add_stock_order_params("client_order_id", client_order_id)
+
+    def set_side(self, side):
+        self.add_stock_order_params("side", side)
+
+    def set_tif(self, tif):
+        self.add_stock_order_params("tif", tif)
+
+    def set_extended_hours_trading(self, extended_hours_trading):
+        self.add_stock_order_params("extended_hours_trading", extended_hours_trading)
+
+    def set_instrument_id(self, instrument_id):
+        self.add_stock_order_params("instrument_id", instrument_id)
+
+    def set_order_type(self, order_type):
+        self.add_stock_order_params("order_type", order_type)
+
+    def set_limit_price(self, limit_price):
+        self.add_stock_order_params("limit_price", limit_price)
+
+    def set_qty(self, quantity):
+        self.add_stock_order_params("qty", quantity)
+
+    def set_stop_price(self, stop_price):
+        self.add_stock_order_params("stop_price", stop_price)
+
+    def set_trailing_type(self, trailing_type):
+        self.add_stock_order_params("trailing_type", trailing_type)
+
+    def set_trailing_stop_step(self, trailing_stop_step):
+        self.add_stock_order_params("trailing_stop_step", trailing_stop_step)
+
+    def set_stock_order(self, client_order_id,  instrument_id, qty, side, tif, extended_hours_trading,
+                        order_type, limit_price, stop_price, trailing_type,trailing_stop_step):
+        self._stock_order.update({k: v for k, v in locals().items() if v is not None and k != 'self'})
+
+    def add_custom_headers_from_context(self):
+        try:
+            headers_map = RequestContextHolder.get()
+            if not headers_map:
+                return
+            for key, value in headers_map.items():
+                self.add_header(key, value)
+        finally:
+            RequestContextHolder.clear()
+
+    def add_custom_headers(self, headers_map):
+        if not headers_map:
+            return
+        for key, value in headers_map.items():
+            self.add_header(key, value)
+
+
+

webull/trade/request/place_order_request_v2.py

@@ -0,0 +1,58 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+
+from webull.core.context.request_context_holder import RequestContextHolder
+from webull.core.request import ApiRequest
+
+class PlaceOrderRequestV2(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trade/order/place", version='v2', method="POST", body_params={})
+        self._stock_order = {}
+        self.add_body_params("stock_order", self._stock_order)
+
+    def add_stock_order_params(self, k, v):
+        self._stock_order[k] = v
+
+    def set_account_id(self, account_id):
+        self.add_body_params("account_id", account_id)
+
+    def set_close_contracts(self, close_contracts):
+        if isinstance(close_contracts, list) and all(isinstance(item, dict) for item in close_contracts):
+            self.add_stock_order_params("close_contracts", close_contracts)
+
+    def set_stock_order(self, stock_order):
+        self._stock_order.update({k: v for k, v in stock_order.items() if v is not None and k != 'self'})
+        if 'close_contracts' in stock_order and stock_order['close_contracts'] is not None:
+            self.set_close_contracts(stock_order['close_contracts'])
+
+    def add_custom_headers_from_context(self):
+        try:
+            headers_map = RequestContextHolder.get()
+            if not headers_map:
+                return
+            for key, value in headers_map.items():
+                self.add_header(key, value)
+        finally:
+            RequestContextHolder.clear()
+
+    def add_custom_headers(self, headers_map):
+        if not headers_map:
+            return
+        for key, value in headers_map.items():
+            self.add_header(key, value)
+
+
+

webull/trade/request/replace_order_request.py

@@ -0,0 +1,73 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+from webull.core.request import ApiRequest
+
+
+class ReplaceOrderRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trade/order/replace", version='v2', method="POST", body_params={})
+        self._stock_order = {}
+        self.add_body_params("stock_order", self._stock_order)
+
+    def add_stock_order_params(self, k, v):
+        self._stock_order[k] = v
+
+    def set_account_id(self, account_id):
+        self.add_body_params("account_id", account_id)
+
+    def set_client_order_id(self, client_order_id):
+        self.add_stock_order_params("client_order_id", client_order_id)
+
+    def set_side(self, side):
+        self.add_stock_order_params("side", side)
+
+    def set_tif(self, tif):
+        self.add_stock_order_params('tif', tif)
+
+    def set_extended_hours_trading(self, extended_hours_trading):
+        self.add_stock_order_params("extended_hours_trading", extended_hours_trading)
+
+    def set_instrument_id(self, instrument_id):
+        self.add_stock_order_params("instrument_id", instrument_id)
+
+    def set_order_type(self, order_type):
+        self.add_stock_order_params("order_type", order_type)
+
+    def set_limit_price(self, limit_price):
+        self.add_stock_order_params("limit_price", limit_price)
+
+    def set_qty(self, qty):
+        self.add_stock_order_params("qty", qty)
+
+    def set_stop_price(self, stop_price):
+        self.add_stock_order_params("stop_price", stop_price)
+
+    def set_trailing_type(self, trailing_type):
+        self.add_stock_order_params("trailing_type", trailing_type)
+
+    def set_trailing_stop_step(self, trailing_stop_step):
+        self.add_stock_order_params("trailing_stop_step", trailing_stop_step)
+
+    def set_stock_order(self, client_order_id, instrument_id, qty,  order_type, extended_hours_trading, side, tif,
+                        limit_price, stop_price, trailing_type, trailing_stop_step):
+        self._stock_order.update({k: v for k, v in locals().items() if v is not None and k != 'self'})
+
+
+
+
+
+
+

webull/trade/request/replace_order_request_v2.py

@@ -0,0 +1,38 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+from webull.core.request import ApiRequest
+
+
+class ReplaceOrderRequestV2(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/trade/order/replace", version='v2', method="POST", body_params={})
+        self._stock_order = {}
+        self.add_body_params("stock_order", self._stock_order)
+
+    def add_stock_order_params(self, k, v):
+        self._stock_order[k] = v
+
+    def set_account_id(self, account_id):
+        self.add_body_params("account_id", account_id)
+
+    def set_close_contracts(self, close_contracts):
+        if isinstance(close_contracts, list) and all(isinstance(item, dict) for item in close_contracts):
+            self.add_stock_order_params("close_contracts", close_contracts)
+
+    def set_stock_order(self, stock_order):
+        self._stock_order.update({k: v for k, v in stock_order.items() if v is not None and k != 'self'})
+        if 'close_contracts' in stock_order and stock_order['close_contracts'] is not None:
+            self.set_close_contracts(stock_order['close_contracts'])

webull/trade/request/v2/cancel_option_request.py

@@ -0,0 +1,28 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+
+from webull.core.request import ApiRequest
+
+
+class CancelOptionRequest(ApiRequest):
+    def __init__(self):
+        super().__init__("/openapi/account/orders/option/cancel", version='v2', method="POST", body_params={})
+
+    def set_client_order_id(self, client_order_id):
+        self.add_body_params("client_order_id", client_order_id)
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)

webull/trade/request/v2/cancel_order_request.py

@@ -0,0 +1,28 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+from webull.core.request import ApiRequest
+
+
+class CancelOrderRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/account/orders/cancel", version='v2', method="POST", body_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_client_order_id(self, client_order_id):
+        self.add_body_params("client_order_id", client_order_id)
+        

webull/trade/request/v2/get_account_balance_request.py

@@ -0,0 +1,28 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+from webull.core.request import ApiRequest
+
+
+class AccountBalanceRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/account/balance", version='v2', method="GET", query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_total_asset_currency(self, total_asset_currency="HKD"):
+        self.add_query_param("total_asset_currency", total_asset_currency)
+        

webull/trade/request/v2/get_account_list.py

@@ -0,0 +1,23 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+from webull.core.request import ApiRequest
+
+
+class GetAccountList(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/account/list", version='v2', method="GET", query_params={})
+
+        

webull/trade/request/v2/get_account_positions_request.py

@@ -0,0 +1,24 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+from webull.core.request import ApiRequest
+
+
+class AccountPositionsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/account/positions", version='v2', method="GET", query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)

webull/trade/request/v2/get_order_detail_request.py

@@ -0,0 +1,26 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from webull.core.request import ApiRequest
+
+
+class OrderDetailRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/account/orders/detail", version='v2', method="GET", query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_client_order_id(self, client_order_id):
+        self.add_query_param("client_order_id", client_order_id)

webull/trade/request/v2/get_order_history_request.py

@@ -0,0 +1,35 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from webull.core.request import ApiRequest
+
+
+class OrderHistoryRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/openapi/account/orders/history", version='v2', method="GET", query_params={})
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_page_size(self, page_size):
+        self.add_query_param("page_size", page_size)
+
+    def set_start_date(self, start_date):
+        self.add_query_param("start_date", start_date)
+
+    def set_end_date(self, end_date):
+        self.add_query_param("end_date", end_date)
+
+    def set_last_client_order_id(self, last_client_order_id):
+        self.add_query_param("last_client_order_id", last_client_order_id)

webull/trade/request/v2/palce_order_request.py

@@ -0,0 +1,87 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import json
+# coding=utf-8
+from typing import List
+
+from webull.core.context.request_context_holder import RequestContextHolder
+from webull.core.request import ApiRequest
+
+
+class CloseContract:
+    def __init__(self, contract_id: str, quantity: str):
+        self.contract_id = contract_id
+        self.quantity = quantity
+
+    def to_dict(self):
+        return {
+            "contract_id": self.contract_id,
+            "quantity": self.quantity
+        }
+
+class PlaceOrderRequest(ApiRequest):
+    def __init__(self):
+        super().__init__("/openapi/account/orders/place", version='v2', method="POST", body_params={})
+        self._new_orders = []
+        self._current_order = {}
+        self.add_body_params("new_orders", self._new_orders)
+
+    def add_new_order_params(self, key, value):
+        self._current_order[key] = value
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def set_close_contracts(self, close_contracts: List[CloseContract]):
+        if not isinstance(close_contracts, list):
+            raise TypeError("close_contracts must be a list of CloseContract objects.")
+        self.add_new_order_params("close_contracts", [contract.to_dict() for contract in close_contracts])
+
+    def set_new_orders(self, current_order):
+        self._current_order.update({k: v for k, v in current_order.items() if v is not None and k != 'self'})
+        if 'close_contracts' in current_order and current_order['close_contracts'] is not None:
+            self.set_close_contracts(current_order['close_contracts'])
+
+    def finalize_order(self):
+        if self._current_order:
+            self._new_orders.append(self._current_order)
+            self._current_order = {}
+        else:
+            raise ValueError("No order fields have been set.")
+
+    def add_custom_headers_from_order(self, new_orders):
+        if not new_orders:
+            return
+
+        if not isinstance(new_orders, (list, tuple)):
+            market = new_orders.get("market")
+            category = market + "_" + "STOCK"
+            if category is not None:
+                self.add_header("category", category)
+
+    def add_custom_headers_from_context(self):
+        try:
+            headers_map = RequestContextHolder.get()
+            if not headers_map:
+                return
+            for key, value in headers_map.items():
+                self.add_header(key, value)
+        finally:
+            RequestContextHolder.clear()
+
+    def add_custom_headers(self, headers_map):
+        if not headers_map:
+            return
+        for key, value in headers_map.items():
+            self.add_header(key, value)

webull/trade/request/v2/place_option_request.py

@@ -0,0 +1,64 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import json
+
+from webull.core.context.request_context_holder import RequestContextHolder
+# coding=utf-8
+
+from webull.core.request import ApiRequest
+
+
+class PlaceOptionRequest(ApiRequest):
+    def __init__(self):
+        super().__init__("/openapi/account/orders/option/place", version='v2', method="POST", body_params={})
+
+    def set_new_orders(self, new_orders):
+        self.add_body_params("new_orders", new_orders)
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)
+
+    def add_custom_headers_from_order(self, new_orders):
+
+        if not new_orders:
+            return
+
+        if isinstance(new_orders, list) and new_orders[0]:
+            first_order = new_orders[0]
+            orders_list = first_order.get("orders", [])
+            if isinstance(orders_list, list):
+                for sub_order in orders_list:
+                    if (sub_order and isinstance(sub_order, dict)
+                            and sub_order.get("instrument_type") == "OPTION"):
+                        instrument_type = sub_order.get("instrument_type")
+                        market = sub_order.get("market")
+                        category = market + "_" + instrument_type
+                        if category is not None:
+                            self.add_header("category", category)
+
+    def add_custom_headers_from_context(self):
+        try:
+            headers_map = RequestContextHolder.get()
+            if not headers_map:
+                return
+            for key, value in headers_map.items():
+                self.add_header(key, value)
+        finally:
+            RequestContextHolder.clear()
+
+    def add_custom_headers(self, headers_map):
+        if not headers_map:
+            return
+        for key, value in headers_map.items():
+            self.add_header(key, value)

webull/trade/request/v2/preview_option_request.py

@@ -0,0 +1,28 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+
+from webull.core.request import ApiRequest
+
+
+class PreviewOptionRequest(ApiRequest):
+    def __init__(self):
+        super().__init__("/openapi/account/orders/option/preview", version='v2', method="POST", body_params={})
+
+    def set_new_orders(self, new_orders):
+        self.add_body_params("new_orders", new_orders)
+
+    def set_account_id(self, account_id):
+        self.add_query_param("account_id", account_id)