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

webull/data/request/get_historical_bars_request.py

@@ -0,0 +1,43 @@
+# 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 GetHistoricalBarsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/bars", version='v2', method="GET", query_params={})
+
+    def set_symbol(self, symbol):
+        self.add_query_param("symbol", symbol)
+
+    def set_category(self, category):
+        self.add_query_param("category", category)
+
+    def set_timespan(self, timespan):
+        self.add_query_param("timespan", timespan)
+
+    def set_count(self, count='200'):
+        self.add_query_param("count", count)
+
+    def set_real_time_required(self, real_time_required):
+        if real_time_required:
+            self.add_query_param("real_time_required", real_time_required)
+
+    def set_trading_sessions(self, trading_sessions):
+        if trading_sessions:
+            if isinstance(trading_sessions, list):
+                self.add_query_param("trading_sessions", ','.join(trading_sessions))
+            else:
+                self.add_query_param("trading_sessions", trading_sessions)

webull/data/request/get_instruments_request.py

@@ -0,0 +1,30 @@
+# 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 GetInstrumentsRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/instrument/list", version='v2', method="GET", query_params={})
+
+    def set_symbols(self, symbols):
+        if isinstance(symbols, str):
+            self.add_query_param("symbols", symbols)
+        elif isinstance(symbols, list):
+            self.add_query_param("symbols", ",".join(symbols))
+    
+    def set_category(self, category):
+        self.add_query_param("category", category)

webull/data/request/get_quotes_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.
+
+# coding=utf-8
+
+from webull.core.request import ApiRequest
+
+class GetQuotesRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/quotes", version='v2', method="GET", query_params={})
+
+    def set_symbol(self, symbol):
+        self.add_query_param("symbol", symbol)
+    
+    def set_category(self, category):
+        self.add_query_param("category", category)
+
+    def set_depth(self, depth):
+        if depth:
+            self.add_query_param("depth", depth)
+
+    def set_overnight_required(self, overnight_required):
+        if overnight_required:
+            self.add_query_param("overnight_required", overnight_required)

webull/data/request/get_snapshot_request.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 GetSnapshotRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/snapshot", version='v2', method="GET", query_params={})
+
+    def set_symbols(self, symbols):
+        if isinstance(symbols, str):
+            self.add_query_param("symbols", symbols)
+        elif isinstance(symbols, list):
+            self.add_query_param("symbols", ",".join(symbols))
+    
+    def set_category(self, category):
+        self.add_query_param("category", category)
+
+    def set_extend_hour_required(self, extend_hour_required):
+        if extend_hour_required:
+            self.add_query_param("extend_hour_required", extend_hour_required)
+
+    def set_overnight_required(self, overnight_required):
+        if overnight_required:
+            self.add_query_param("overnight_required", overnight_required)

webull/data/request/get_tick_request.py

@@ -0,0 +1,37 @@
+# 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 GetTickRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/tick", version='v2', method="GET", query_params={})
+
+    def set_symbol(self, symbol):
+        self.add_query_param("symbol", symbol)
+    
+    def set_category(self, category):
+        self.add_query_param("category", category)
+
+    def set_count(self, count):
+        self.add_query_param("count", count)
+
+    def set_trading_sessions(self, trading_sessions):
+        if trading_sessions:
+            if isinstance(trading_sessions, list):
+                self.add_query_param("trading_sessions", ','.join(trading_sessions))
+            else:
+                self.add_query_param("trading_sessions", trading_sessions)

webull/data/request/subscribe_request.py

@@ -0,0 +1,43 @@
+# 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 SubscribeRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/streaming/subscribe", version='v2', method="POST", query_params={})
+        self.set_body_params({})
+
+    def set_session_id(self, session_id):
+        self.add_body_params("session_id", session_id)
+
+    def set_symbols(self, symbols):
+        self.add_body_params("symbols", symbols)
+
+    def set_category(self, category):
+        self.add_body_params("category", category)
+
+    def set_sub_types(self, sub_types):
+        self.add_body_params("sub_types", sub_types)
+
+    def set_depth(self, depth):
+        if depth:
+            self.add_body_params("depth", depth)
+
+    def set_overnight_required(self, overnight_required):
+        if overnight_required:
+            self.add_body_params("overnight_required", overnight_required)

webull/data/request/unsubscribe_request.py

@@ -0,0 +1,42 @@
+# 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 UnsubcribeRequest(ApiRequest):
+    def __init__(self):
+        ApiRequest.__init__(self, "/market-data/streaming/unsubscribe", version='v2', method="POST", query_params={})
+        self.set_body_params({})
+
+    def set_session_id(self, session_id):
+        self.add_body_params("session_id", session_id)
+
+    def set_symbols(self, symbols):
+        if symbols:
+            self.add_body_params("symbols", symbols)
+
+    def set_category(self, category):
+        if category:
+            self.add_body_params("category", category)
+
+    def set_sub_types(self, sub_types):
+        if sub_types:
+            self.add_body_params("sub_types", sub_types)
+
+    def set_unsubscribe_all(self, unsubscribe_all):
+        if unsubscribe_all is not None:
+            self.add_body_params("unsubscribe_all", unsubscribe_all)

webull/trade/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "1.0.0"
+

webull/trade/common/account_type.py

@@ -0,0 +1,22 @@
+# 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.common.easy_enum import EasyEnum
+
+
+class AccountType(EasyEnum):
+    MARGIN = (1, "MARGIN")
+    CASH = (2, "CASH")
+

webull/trade/common/category.py

@@ -0,0 +1,29 @@
+# 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.common.easy_enum import EasyEnum
+
+
+class Category(EasyEnum):
+    US_STOCK = (1, 'US STOCK')
+    US_OPTION = (2, 'US OPTION')
+    HK_STOCK = (3, 'HK STOCK')
+    CRYPTO = (4, 'CRYPTO')
+    US_ETF = (5, 'US ETF')
+    HK_ETF = (6, 'HK ETF')
+    CN_STOCK = (7, "CN STOCK")
+    NFT = (8, "NFT")
+    US_CFDONSTOCK = (8, "US CFDON STOCK")

webull/trade/common/combo_ticker_type.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.common.easy_enum import EasyEnum
+
+
+class ComboTickerType(EasyEnum):
+    OPTION = (1, 'Option')
+    CRYPTO = (2, 'Crypto')
+    STOCK = (3, 'Stock')

webull/trade/common/combo_type.py

@@ -0,0 +1,31 @@
+# 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.common.easy_enum import EasyEnum
+
+
+class ComboType(EasyEnum):
+    MASTER = (1, 'Master order')
+    STOP_LOSS_PROFIT = (2, 'Stop loss Profit')
+    STOP_LOSS = (3, 'Stop loss')
+    STOP_PROFIT = (4, 'Stop profit')
+    OTO = (5, 'One trigger others')
+    OCO = (6, 'One cancel others')
+    OTOCO = (7, "OTO + OCO")
+    NORMAL = (8, "Normal order")
+    BROKEN = (9, "Broken order")
+    BROKEN_INT = (10, "Broken order integer part")
+    BROKEN_DEC = (11, "Broken order fractional part")

webull/trade/common/currency.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.common.easy_enum import EasyEnum
+
+
+class Currency(EasyEnum):
+    CNH = (1, "CNH")
+    CAD = (2, "CAD")
+    HKD = (3, "HKD")
+    USD = (4, "USD")
+

webull/trade/common/forbid_reason.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.common.easy_enum import EasyEnum
+
+
+class ForbidReason(EasyEnum):
+    DELISTED = (1, "delisting")
+    REVERSE_SPLIT = (2, "a reverse stock split")
+    STOCK_SPLIT = (3, "a stock split")
+    TO_OTC = (4, "Exchange changed to OTC")
+    NAME_CHANGE = (5, "name change")
+    IPO_DELAY = (6, "delayed listing")
+    INSTRUMENT_TYPE_ERROR = (7, "wrong symbol type")
+    OTHER = (8, "other")

webull/trade/common/instrument_type.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.common.easy_enum import EasyEnum
+
+
+class InstrumentType(EasyEnum):
+    STOCK = (1, "STOCK")
+    ETF = (2, "ETF")
+    UNIT = (3, "UNIT")
+    WARRANT = (4, "WARRANT")
+    RIGHT = (5, "RIGHT")
+    CALL_OPTION = (6, "CALL_OPTION")
+    PUT_OPTION = (7, "PUT_OPTION")

webull/trade/common/markets.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.
+
+from webull.core.common.easy_enum import EasyEnum
+
+
+class Markets(EasyEnum):
+
+    # US market
+    US = (1, "US")
+
+    # HK market
+    HK = (2, "HK")
+
+    # JP market
+    JP = (3, "JP")

webull/trade/common/order_entrust_type.py

@@ -0,0 +1,21 @@
+# 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.common.easy_enum import EasyEnum
+
+
+class OrderEntrustType(EasyEnum):
+    QTY = (1, "quantity")
+    AMOUNT = (2, "amount")

webull/trade/common/order_side.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.common.easy_enum import EasyEnum
+
+
+class OrderSide(EasyEnum):
+    BUY = (1, "BUY")
+    SELL = (2, "SELL")
+    SHORT = (3, "SHORT")
+

webull/trade/common/order_status.py

@@ -0,0 +1,25 @@
+# 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.common.easy_enum import EasyEnum
+
+
+class OrderStatus(EasyEnum):
+    SUBMITTED = (1, "SUBMITTED")
+    CANCELLED = (2, "CANCELLED")
+    FAILED = (3, "FAILED")
+    FILLED = (4, "FILLED")
+    PARTIAL_FILLED = (5, "PARTIAL FILLED")

webull/trade/common/order_tif.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.common.easy_enum import EasyEnum
+
+
+class OrderTIF(EasyEnum):
+    DAY = (1, "order day")
+    GTC = (2, "GTC order")
+    IOC = (3, "deal or cancel right now")
+
+

webull/trade/common/order_type.py

@@ -0,0 +1,30 @@
+# 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.common.easy_enum import EasyEnum
+
+
+class OrderType(EasyEnum):
+    MARKET = (1, "MARKET")
+    LIMIT = (2, "LIMIT")
+    STOP_LOSS = (3, "STOP LOSS")
+    STOP_LOSS_LIMIT = (4, "STOP LOSS LIMIT")
+    TRAILING_STOP_LOSS = (5, "TRAILING STOP LOSS")
+    ENHANCED_LIMIT = (6, "ENHANCED LIMIT")
+    AT_AUCTION = (7, "AT AUCTION")
+    AT_AUCTION_LIMIT = (8, "AT AUCTION LIMIT")
+    ODD_LOT_LIMIT = (9, "ODD LOT LIMIT")
+    MARKET_ON_OPEN = (10, "MARKET ON OPEN")
+    MARKET_ON_CLOSE = (11, "MARKET ON CLOSE")

webull/trade/common/trade_policy.py

@@ -0,0 +1,22 @@
+# 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.common.easy_enum import EasyEnum
+
+
+class TradePolicy(EasyEnum):
+    ALL = (1, "Allow opening and closing of positions")
+    CLOSE_ONLY = (2, "Only allow closing")
+    DENIED = (3, "Prohibit trading")