webull-openapi-python-sdk 1.0.4__py3-none-any.whl → 1.0.6__py3-none-any.whl

samples/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.4"
+__version__ = '1.0.6'

samples/data/data_client.py

@@ -15,6 +15,7 @@
 # coding=utf-8
 
 from webull.data.common.category import Category
+from webull.data.common.contract_type import ContractType
 from webull.data.common.timespan import Timespan
 from webull.core.client import ApiClient
 from webull.data.data_client import DataClient
@@ -34,6 +35,22 @@ if __name__ == '__main__':
     if res.status_code == 200:
         print('get_instrument:', res.json())
 
+    res = data_client.instrument.get_crypto_instrument()
+    if res.status_code == 200:
+        print('get_crypto_instrument(all):', res.json())
+
+    res = data_client.instrument.get_crypto_instrument("BTCUSD")
+    if res.status_code == 200:
+        print('get_crypto_instrument:', res.json())
+
+    res = data_client.crypto_market_data.get_crypto_snapshot("BTCUSD")
+    if res.status_code == 200:
+        print('get_crypto_snapshot:', res.json())
+
+    res = data_client.crypto_market_data.get_crypto_history_bar("BTCUSD", Category.US_CRYPTO.name, Timespan.M1.name)
+    if res.status_code == 200:
+        print('get_crypto_history_bar:', res.json())
+
     res = data_client.market_data.get_snapshot('AAPL', Category.US_STOCK.name, extend_hour_required=True, overnight_required=True)
     if res.status_code == 200:
         print('get_snapshot:', res.json())
@@ -54,4 +71,30 @@ if __name__ == '__main__':
     if res.status_code == 200:
         print('get_quotes:', res.json())
 
+    res = data_client.futures_market_data.get_futures_depth("SILZ5", Category.US_FUTURES.name, depth=1)
+    if res.status_code == 200:
+        print('get_futures_depth:', res.json())
+
+    res = data_client.futures_market_data.get_futures_history_bars('SILZ5,6BM6', Category.US_FUTURES.name, Timespan.M1.name)
+    if res.status_code == 200:
+        print('get_futures_history_bars:', res.json())
+
+    res = data_client.futures_market_data.get_futures_tick("SILZ5", Category.US_FUTURES.name, count=10)
+    if res.status_code == 200:
+        print('get_futures_tick:', res.json())
+
+    res = data_client.futures_market_data.get_futures_snapshot("SILZ5,6BM6", Category.US_FUTURES.name)
+    if res.status_code == 200:
+        print('get_futures_snapshot:', res.json())
 
+    res = data_client.instrument.get_futures_products(Category.US_FUTURES.name)
+    if res.status_code == 200:
+        print('get_futures_products:', res.json())
+
+    res = data_client.instrument.get_futures_instrument("ESZ5", Category.US_FUTURES.name)
+    if res.status_code == 200:
+        print('get_futures_instrument:', res.json())
+
+    res = data_client.instrument.get_futures_instrument_by_code("ES", Category.US_FUTURES.name, ContractType.MONTHLY.name)
+    if res.status_code == 200:
+        print('get_futures_instrument_by_code:', res.json())

samples/trade/trade_client_v3.py

@@ -0,0 +1,420 @@
+# 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
+import uuid
+from time import sleep
+
+from webull.core.client import ApiClient
+from webull.trade.trade_client import TradeClient
+
+optional_api_endpoint = "<api_endpoint>"
+your_app_key = "<your_app_key>"
+your_app_secret = "<your_app_secret>"
+region_id = "<region_id>"
+account_id = "<your_account_id>"
+api_client = ApiClient(your_app_key, your_app_secret, region_id)
+api_client.add_endpoint(region_id, optional_api_endpoint)
+
+
+if __name__ == '__main__':
+    trade_client = TradeClient(api_client)
+
+    res = trade_client.account_v2.get_account_list()
+    if res.status_code == 200:
+        print('get account list:', res.json())
+
+    res = trade_client.account_v2.get_account_balance(account_id)
+    if res.status_code == 200:
+        print('get account balance res:', res.json())
+
+    res = trade_client.account_v2.get_account_position(account_id)
+    if res.status_code == 200:
+        print('get account position res:', res.json())
+
+    # ============================================================
+    # Equity Order Example
+    # ============================================================
+
+    # normal equity order
+    normal_equity_client_order_id = uuid.uuid4().hex
+    print('client order id:', normal_equity_client_order_id)
+    new_normal_equity_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": normal_equity_client_order_id,
+            "symbol": "AAPL",
+            "instrument_type": "EQUITY",
+            "market": "US",
+            "order_type": "LIMIT",
+            "limit_price": "188",
+            "quantity": "1",
+            "support_trading_session": "N",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY"
+        }
+    ]
+
+    res = trade_client.order_v3.preview_order(account_id, new_normal_equity_orders)
+    if res.status_code == 200:
+        print('preview normal equity order res:', res.json())
+
+    res = trade_client.order_v3.place_order(account_id, new_normal_equity_orders)
+    if res.status_code == 200:
+        print('place normal equity order res:', res.json())
+    sleep(3)
+
+    replace_normal_equity_orders = [
+        {
+            "client_order_id": normal_equity_client_order_id,
+            "quantity": "100",
+            "limit_price": "200"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_normal_equity_orders)
+    if res.status_code == 200:
+        print('replace normal equity order res:', res.json())
+    sleep(3)
+
+    res = trade_client.order_v3.cancel_order(account_id, normal_equity_client_order_id)
+    if res.status_code == 200:
+        print('cancel normal equity order res:', res.json())
+
+    res = trade_client.order_v3.get_order_open(account_id=account_id)
+    if res.status_code == 200:
+        print("order_open_res=" + json.dumps(res.json(), indent=4))
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_detail(account_id, normal_equity_client_order_id)
+    if res.status_code == 200:
+        print('get order detail res:', res.json())
+
+
+
+    # combo equity order
+    master_equity_client_order_id = uuid.uuid4().hex
+    stop_profit_equity_client_order_id = uuid.uuid4().hex
+    stop_loss_equity_client_order_id = uuid.uuid4().hex
+    print('normal_equity_master_client_order_id:', master_equity_client_order_id)
+    print('stop_profit_equity_client_order_id:', stop_profit_equity_client_order_id)
+    print('stop_loss_equity_client_order_id:', stop_loss_equity_client_order_id)
+    new_combo_orders = [
+        {
+            "client_order_id": master_equity_client_order_id,
+            "combo_type": "MASTER",
+            "symbol": "F",
+            "instrument_type": "EQUITY",
+            "market": "US",
+            "order_type": "LIMIT",
+            "quantity": "1",
+            "support_trading_session": "N",
+            "limit_price": "10.5",
+            "side": "BUY",
+            "entrust_type": "QTY",
+            "time_in_force": "DAY"
+        },
+        {
+            "client_order_id": stop_profit_equity_client_order_id,
+            "combo_type": "STOP_PROFIT",
+            "symbol": "F",
+            "instrument_type": "EQUITY",
+            "market": "US",
+            "order_type": "LIMIT",
+            "quantity": "1",
+            "support_trading_session": "N",
+            "limit_price": "11.5",
+            "side": "SELL",
+            "entrust_type": "QTY",
+            "time_in_force": "DAY"
+        },
+        {
+            "client_order_id": stop_loss_equity_client_order_id,
+            "combo_type": "STOP_LOSS",
+            "symbol": "F",
+            "instrument_type": "EQUITY",
+            "market": "US",
+            "order_type": "STOP_LOSS",
+            "quantity": "1",
+            "support_trading_session": "N",
+            "stop_price": "10",
+            "side": "SELL",
+            "entrust_type": "QTY",
+            "time_in_force": "DAY"
+        }
+    ]
+
+    res = trade_client.order_v3.preview_order(account_id, new_combo_orders)
+    if res.status_code == 200:
+        print('preview combo equity order res:', res.json())
+
+    res = trade_client.order_v3.place_order(account_id, new_combo_orders)
+    if res.status_code == 200:
+        print('place combo equity order res:', res.json())
+    sleep(3)
+
+    replace_combo_orders = [
+        {
+            "client_order_id": master_equity_client_order_id,
+            "quantity": "2"
+        },
+        {
+            "client_order_id": stop_profit_equity_client_order_id,
+            "quantity": "2"
+        },
+        {
+            "client_order_id": stop_loss_equity_client_order_id,
+            "quantity": "2"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_combo_orders)
+    if res.status_code == 200:
+        print('replace combo equity order res:', res.json())
+    sleep(3)
+
+    res = trade_client.order_v3.cancel_order(account_id, master_equity_client_order_id)
+    if res.status_code == 200:
+        print('cancel master equity order res:', res.json())
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_open(account_id=account_id)
+    if res.status_code == 200:
+        print("order_open_res=" + json.dumps(res.json(), indent=4))
+
+    res = trade_client.order_v3.get_order_detail(account_id, master_equity_client_order_id)
+    if res.status_code == 200:
+        print('get master order detail res:', res.json())
+
+
+
+
+    # ============================================================
+    # Option Order Example
+    # ============================================================
+
+    # normal option order
+    normal_option_client_order_id = uuid.uuid4().hex
+    new_normal_option_orders = [
+        {
+            "client_order_id": normal_option_client_order_id,
+            "combo_type": "NORMAL",
+            "order_type": "LIMIT",
+            "quantity": "1",
+            "limit_price": "21.25",
+            "option_strategy": "SINGLE",
+            "side": "BUY",
+            "time_in_force": "GTC",
+            "entrust_type": "QTY",
+            "legs": [
+                {
+                    "side": "BUY",
+                    "quantity": "1",
+                    "symbol": "TSLA",
+                    "strike_price": "400",
+                    "option_expire_date": "2025-12-26",
+                    "instrument_type": "OPTION",
+                    "option_type": "CALL",
+                    "market": "US"
+                }
+            ]
+        }
+    ]
+
+    # preview
+    res = trade_client.order_v3.preview_order(account_id, new_normal_option_orders)
+    if res.status_code == 200:
+        print("preview normal option order res:" + json.dumps(res.json(), indent=4))
+
+    # place
+    res = trade_client.order_v3.place_order(account_id, new_normal_option_orders)
+    if res.status_code == 200:
+        print("place normal option order res:" + json.dumps(res.json(), indent=4))
+    sleep(3)
+
+    # replace for Webull HK
+    # replace_normal_option_orders = [
+    #     {
+    #         "client_order_id": normal_option_client_order_id,
+    #         "quantity": "2",
+    #         "limit_price": "11.3"
+    #     }
+    # ]
+    # res = trade_client.order_v3.replace_option(account_id, replace_normal_option_orders)
+    # if res.status_code == 200:
+    #     print("replace normal option order res:" + json.dumps(res.json(), indent=4))
+    # sleep(5)
+
+    # replace for Webull US
+    res = trade_client.order_v3.get_order_detail(account_id, normal_option_client_order_id)
+    if res.status_code == 200:
+        print('get normal option order detail res:', res.json())
+    data = res.json() or {}
+    leg_id = (
+        data.get("orders", [{}])[0]
+        .get("legs", [{}])[0]
+        .get("id")
+    )
+    print('get normal option order detail id :', leg_id)
+
+    # If it is a multi-leg option, you need to manually match it to the corresponding sub-leg orderId.
+    if leg_id:
+        replace_normal_option_orders = [
+            {
+                "client_order_id": normal_option_client_order_id,
+                "quantity": "2",
+                "limit_price": "21.3",
+                "legs": [
+                    {
+                        "id": leg_id,
+                        "quantity": "2"
+                    }
+                ]
+            }
+        ]
+        res = trade_client.order_v3.replace_order(account_id, replace_normal_option_orders)
+        if res.status_code == 200:
+            print("replace normal option order res:" + json.dumps(res.json(), indent=4))
+        sleep(3)
+
+    # cancel
+    res = trade_client.order_v3.cancel_order(account_id, normal_option_client_order_id)
+    if res.status_code == 200:
+        print("cancel normal option order res:" + json.dumps(res.json(), indent=4))
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_open(account_id=account_id)
+    if res.status_code == 200:
+        print("order_open_res=" + json.dumps(res.json(), indent=4))
+
+    res = trade_client.order_v3.get_order_detail(account_id, normal_option_client_order_id)
+    if res.status_code == 200:
+        print('get option order detail res:', res.json())
+
+
+
+    # ============================================================
+    # Crypto Order Example
+    # For the cryptocurrency example, please use a cryptocurrency account ID.
+    # ============================================================
+
+    # normal crypto order
+    normal_crypto_client_order_id = uuid.uuid4().hex
+    print('client order id:', normal_crypto_client_order_id)
+    new_normal_crypto_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": normal_crypto_client_order_id,
+            "symbol": "BTCUSD",
+            "instrument_type": "CRYPTO",
+            "market": "US",
+            "order_type": "LIMIT",
+            "limit_price": "80000",
+            "quantity": "0.003",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY"
+        }
+    ]
+
+    res = trade_client.order_v3.place_order(account_id, new_normal_crypto_orders)
+    if res.status_code == 200:
+        print('place normal crypto order res:', res.json())
+    sleep(3)
+
+    res = trade_client.order_v3.cancel_order(account_id, normal_crypto_client_order_id)
+    if res.status_code == 200:
+        print('cancel normal crypto order res:', res.json())
+
+    res = trade_client.order_v3.get_order_open(account_id=account_id)
+    if res.status_code == 200:
+        print("order_open_res=" + json.dumps(res.json(), indent=4))
+
+    res = trade_client.order_v3.get_order_history(account_id)
+    if res.status_code == 200:
+        print('get order history res:', res.json())
+
+    res = trade_client.order_v3.get_order_detail(account_id, normal_crypto_client_order_id)
+    if res.status_code == 200:
+        print('get order detail res:', res.json())
+
+
+
+    # ============================================================
+    # Futures Order Example
+    # ============================================================
+
+    # normal futures order
+    normal_futures_client_order_id = uuid.uuid4().hex
+    print('futures client order id:', normal_futures_client_order_id)
+    new_normal_futures_orders = [
+        {
+            "combo_type": "NORMAL",
+            "client_order_id": normal_futures_client_order_id,
+            "symbol": "ESZ5",
+            "instrument_type": "FUTURES",
+            "market": "US",
+            "order_type": "LIMIT",
+            "limit_price": "4500",
+            "quantity": "1",
+            "side": "BUY",
+            "time_in_force": "DAY",
+            "entrust_type": "QTY"
+        }
+    ]
+    res = trade_client.order_v3.place_order(account_id, new_normal_futures_orders)
+    if res.status_code == 200:
+        print('place normal futures order res:', res.json())
+    sleep(3)
+
+    # normal futures order replace
+    replace_normal_futures_orders = [
+        {
+            "client_order_id": normal_futures_client_order_id,
+            "quantity": "2",
+            "limit_price": "4550"
+        }
+    ]
+    res = trade_client.order_v3.replace_order(account_id, replace_normal_futures_orders)
+    if res.status_code == 200:
+        print('replace normal futures order res:', res.json())
+    sleep(3)
+
+    # normal futures order cancel
+    res = trade_client.order_v3.cancel_order(account_id, normal_futures_client_order_id)
+    if res.status_code == 200:
+        print('cancel normal futures order res:', res.json())
+
+    # get futures order detail
+    res = trade_client.order_v3.get_order_detail(account_id, normal_futures_client_order_id)
+    if res.status_code == 200:
+        print('get futures order detail res:', res.json())
+
+    # get futures open orders
+    res = trade_client.order_v3.get_order_open(account_id, page_size=10)
+    if res.status_code == 200:
+        print("order_open_res=" + json.dumps(res.json(), indent=4))
+
+    # get futures order history
+    res = trade_client.order_v3.get_order_history(account_id, page_size=10)
+    if res.status_code == 200:
+        print('get order history res:', res.json())

samples/trade/trade_event_client.py

@@ -37,7 +37,9 @@ if __name__ == '__main__':
 
     # Create EventsClient instance
     trade_events_client = TradeEventsClient(your_app_key, your_app_secret, region_id)
-    # For non production environment, you need to set the domain name of the subscription service through eventsclient. For example, the domain name of the UAT environment is set here
+    # [Important] For non production environment, you need to set the domain name of the subscription service through events client. For example, the domain name of the UAT environment is set here
+    # [Important] For non production environment, you need to set the domain name of the subscription service through events client. For example, the domain name of the UAT environment is set here
+    # [Important] For non production environment, you need to set the domain name of the subscription service through events client. For example, the domain name of the UAT environment is set here
     # trade_events_client = TradeEventsClient(your_app_key, your_app_secret, region_id, host=optional_api_endpoint)
     trade_events_client.on_log = _on_log
 

webull/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.4"
+__version__ = '1.0.6'

webull/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.4"
+__version__ = '1.0.6'
 
 import logging
 

webull/core/data/endpoints.json

@@ -4,7 +4,7 @@
     "region_mapping": {
         "us": {
             "api": "api.webull.com",
-            "quotes-api": "usquotes-api.webullfintech.com",
+            "quotes-api": "data-api.webull.com",
             "events-api": "events-api.webull.com"
         },
         "hk": {

webull/data/__init__.py

@@ -1,3 +1,3 @@
 # coding=utf-8
 
-__version__ = '1.0.4'
+__version__ = '1.0.6'

webull/data/common/category.py

@@ -20,7 +20,8 @@ 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")
+    CN_STOCK = (7, "CN STOCK")
+    US_CRYPTO = (8, "US CRYPTO")
+    US_FUTURES = (12, "US FUTURES")

webull/data/common/contract_type.py

@@ -0,0 +1,20 @@
+# 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 ContractType(EasyEnum):
+    MONTHLY = (1, "MONTHLY")
+    MAIN = (2, "MAIN")

webull/data/data_client.py

@@ -18,6 +18,8 @@ import logging
 import sys
 
 from webull.core.http.initializer.client_initializer import ClientInitializer
+from webull.data.quotes.crypto_market_data import CryptoMarketData
+from webull.data.quotes.futures_market_data import FuturesMarketData
 from webull.data.quotes.instrument import Instrument
 from webull.data.quotes.market_data import MarketData
 
@@ -28,6 +30,8 @@ class DataClient:
         ClientInitializer.initializer(api_client)
         self.instrument = Instrument(api_client)
         self.market_data = MarketData(api_client)
+        self.crypto_market_data = CryptoMarketData(api_client)
+        self.futures_market_data = FuturesMarketData(api_client)
 
     def _init_logger(self, api_client):
         # No logger configured, using default console and local file logging.

webull/data/quotes/crypto_market_data.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.
+from webull.data.common.category import Category
+from webull.data.request.get_crypto_historical_bars_request import GetCryptoHistoricalBarsRequest
+from webull.data.request.get_crypto_snapshot_request import GetCryptoSnapshotRequest
+
+
+class CryptoMarketData:
+    def __init__(self, api_client):
+        self.client = api_client
+
+    def get_crypto_history_bar(self, symbols, category, timespan, count='200', real_time_required=None):
+        """
+        Returns to Instrument in the window aggregated data.
+        According to the last N K-lines of the stock code, it supports various granularity K-lines such as m1 and m5.
+        Currently, only the K-line with the previous weight is provided for the daily K-line and above,
+        and only the un-weighted K-line is provided for the minute K.
+
+        :param symbols: List of security codes (e.g., single: 00700; multiple: BTCUSD,ETHUSD or ['BTCUSD','ETHUSD']).
+        :param category: Security type. Fixed value: "US_CRYPTO"
+        :param timespan: K-line time granularity
+        :param count: The number of lines: the default is 200, and the maximum limit is 1200
+        :param real_time_required: Returns the latest trade quote data. By default, the most recent market data is returned.
+        By default, only intraday candlestick data is returned.
+        """
+        crypto_history_bar_request = GetCryptoHistoricalBarsRequest()
+        crypto_history_bar_request.set_symbols(symbols)
+        crypto_history_bar_request.set_category(category)
+        crypto_history_bar_request.set_timespan(timespan)
+        crypto_history_bar_request.set_count(count)
+        crypto_history_bar_request.set_real_time_required(real_time_required)
+        response = self.client.get_response(crypto_history_bar_request)
+        return response
+
+    def get_crypto_snapshot(self, symbols, category=Category.US_CRYPTO.name):
+        """
+        Query the latest crypto market snapshots in batches according to the security code list.
+
+        :param symbols: List of security codes (e.g., single: 00700; multiple: BTCUSD,ETHUSD or ['BTCUSD','ETHUSD']).
+        Up to 20 symbols can be subscribed per request.
+        :param category: Security type. Fixed value: "US_CRYPTO".
+        """
+        crypto_snapshot_request = GetCryptoSnapshotRequest()
+        crypto_snapshot_request.set_symbols(symbols)
+        crypto_snapshot_request.set_category(category)
+        response = self.client.get_response(crypto_snapshot_request)
+        return response