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

webull/core/compat.py

@@ -0,0 +1,85 @@
+# 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
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/compat.py
+which was part of Alibaba Group.
+"""
+
+import sys
+from webull.core.vendored import six
+
+if six.PY2:
+    from base64 import encodestring as b64_encode_bytes
+    from base64 import decodestring as b64_decode_bytes
+
+    def ensure_bytes(s, encoding='utf-8', errors='strict'):
+        if isinstance(s, unicode):
+            return s.encode(encoding, errors)
+        if isinstance(s, str):
+            return s
+        raise ValueError("Expected str or unicode, received %s." % type(s))
+
+    def ensure_string(s, encoding='utf-8', errors='strict'):
+        if isinstance(s, unicode):
+            return s.encode(encoding, errors)
+        if isinstance(s, str):
+            return s
+        raise ValueError("Expected str or unicode, received %s." % type(s))
+
+else:
+    from base64 import encodebytes as b64_encode_bytes
+    from base64 import decodebytes as b64_decode_bytes
+
+    def ensure_bytes(s, encoding='utf-8', errors='strict'):
+        if isinstance(s, str):
+            return bytes(s, encoding=encoding)
+        if isinstance(s, bytes):
+            return s
+        if isinstance(s, bytearray):
+            return bytes(s)
+        raise ValueError(
+            "Expected str or bytes or bytearray, received %s." %
+            type(s))
+
+    def ensure_string(s, encoding='utf-8', errors='strict'):
+        if isinstance(s, str):
+            return s
+        if isinstance(s, (bytes, bytearray)):
+            return str(s, encoding='utf-8')
+        raise ValueError(
+            "Expected str or bytes or bytearray, received %s." %
+            type(s))

webull/core/context/request_context_holder.py

@@ -0,0 +1,33 @@
+# 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 threading
+
+class RequestContextHolder:
+    _thread_local = threading.local()
+
+    @classmethod
+    def get(cls) -> dict:
+        # Initializes the headers dictionary for the current thread.
+        if not hasattr(cls._thread_local, 'headers'):
+            cls._thread_local.headers = {}
+        return cls._thread_local.headers
+
+    @classmethod
+    def clear(cls):
+        # Delete the current thread's headers field to prevent threads from reusing residual data.
+        if hasattr(cls._thread_local, 'headers'):
+            del cls._thread_local.headers

webull/core/data/endpoints.json

@@ -0,0 +1,22 @@
+{
+    "default_region": "us",
+    "regions": ["us", "hk", "jp"],
+    "region_mapping": {
+        "us": {
+            "api": "api.webull.com",
+            "quotes-api": "usquotes-api.webullfintech.com",
+            "events-api": "events-api.webull.com"
+        },
+        "hk": {
+            "api": "api.webull.hk",
+            "quotes-api": "quotes-api.webull.hk",
+            "events-api": "events-api.webull.hk"
+        },
+        "jp": {
+            "api": "api.webull.co.jp",
+            "quotes-api": "",
+            "events-api": "events-api.webull.co.jp"
+        }
+    }
+}
+

webull/core/data/retry_config.json

@@ -0,0 +1,15 @@
+{
+    "api": {
+        "RetryableMethods": [
+            "GET"
+        ],
+        "RetryableThrottlingErrors": [
+            "TOO_MANY_REQUESTS"
+        ],
+        "RetryableNormalErrors":[
+            "SERVICE_NOT_AVAILABLE",
+            "GATEWAY_TIMEOUT",
+            "INTERNAL_ERROR"
+        ]
+    }
+}

webull/core/endpoint/__init__.py

@@ -0,0 +1,8 @@
+# coding=utf-8
+
+class EndpointResolver(object):
+    def resolve(self, request):
+        """
+        Endpoint resolver interface
+        """
+        pass

webull/core/endpoint/chained_endpoint_resolver.py

@@ -0,0 +1,57 @@
+    # 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.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/endpoint/chained_endpoint_resolver.py
+which was part of Alibaba Group.
+"""
+
+from webull.core.exception.exceptions import ClientException
+from webull.core.exception import error_code
+from webull.core.endpoint import EndpointResolver
+
+class ChainedEndpointResolver(EndpointResolver):
+    def __init__(self, resolver_chain):
+        EndpointResolver.__init__(self)
+        self.endpoint_resolvers = resolver_chain
+        
+    def resolve(self, request):
+        for resolver in self.endpoint_resolvers:
+            endpoint = resolver.resolve(request) 
+            if endpoint is not None:
+                return endpoint
+            
+        raise ClientException(error_code.SDK_ENDPOINT_RESOLVING_ERROR)

webull/core/endpoint/default_endpoint_resolver.py

@@ -0,0 +1,60 @@
+# 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.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/endpoint/default_endpoint_resolver.py
+which was part of Alibaba Group.
+"""
+
+from webull.core.endpoint import EndpointResolver
+from webull.core.endpoint.chained_endpoint_resolver import ChainedEndpointResolver
+from webull.core.endpoint.local_config_regional_endpoint_resolver import LocalConfigRegionalEndpointResolver
+from webull.core.endpoint.user_customized_endpoint_resolver import UserCustomizedEndpointResolver
+
+class DefaultEndpointResolver(EndpointResolver):
+    def __init__(self, user_config=None):
+        self._user_customized_endpoint_resolver = UserCustomizedEndpointResolver()
+        endpoint_resolvers = [
+            self._user_customized_endpoint_resolver,
+            LocalConfigRegionalEndpointResolver()
+        ] 
+        self._resolver = ChainedEndpointResolver(endpoint_resolvers)
+
+    def resolve(self, request):
+        return self._resolver.resolve(request)
+
+    def put_endpoint_entry(self, region_id, api_type, endpoint):
+        self._user_customized_endpoint_resolver.put_endpoint_entry(region_id, api_type, endpoint)

webull/core/endpoint/local_config_regional_endpoint_resolver.py

@@ -0,0 +1,77 @@
+# 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.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/endpoint/local_config_regional_endpoint_resolver.py
+which was part of Alibaba Group.
+"""
+
+import json
+import os
+import webull.core
+from webull.core.endpoint import EndpointResolver
+
+ENDPOINT_JSON = os.path.join(os.path.dirname(webull.core.__file__), "data", "endpoints.json")
+
+
+class LocalConfigRegionalEndpointResolver(EndpointResolver):
+    def __init__(self, config_json_str=None):
+        EndpointResolver.__init__(self)
+        if config_json_str:
+            obj = json.loads(config_json_str)
+        else:
+            obj = self._read_from_default_file()
+        self._init_config(obj)
+
+    def _init_config(self, obj):
+        self._default_region = obj["default_region"]
+        self._region_mapping = obj["region_mapping"]
+
+    def _read_from_default_file(self):
+        with open(ENDPOINT_JSON) as fp:
+            return json.load(fp)
+
+    def resolve(self, request):
+        if request.region_id:
+            region_code_mapping = self._region_mapping.get(request.region_id)
+        else:
+            region_code_mapping = self._region_mapping.get(self._default_region)
+
+        if region_code_mapping:
+            # Select the appropriate API endpoint based on client type
+            return region_code_mapping.get(request.api_type)
+
+        return None

webull/core/endpoint/resolver_endpoint_request.py

@@ -0,0 +1,46 @@
+# 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.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/endpoint/resolver_endpoint_request.py
+which was part of Alibaba Group.
+"""
+
+from webull.core.common.api_type import DEFAULT as HTTP_API_TYPE
+class ResolveEndpointRequest(object):
+    def __init__(self, region_id=None, api_type=HTTP_API_TYPE):
+        self.region_id = region_id
+        self.api_type = api_type

webull/core/endpoint/user_customized_endpoint_resolver.py

@@ -0,0 +1,55 @@
+# 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.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/endpoint/user_customized_endpoint_resolver.py
+which was part of Alibaba Group.
+"""
+
+from webull.core.endpoint import EndpointResolver
+        
+class UserCustomizedEndpointResolver(EndpointResolver):
+    def __init__(self):
+        EndpointResolver.__init__(self)
+        self._endpoint_entry_map = {}
+        
+    def put_endpoint_entry(self, region_id, api_type, endpoint):
+        entry_key = str(region_id) + api_type
+        self._endpoint_entry_map[entry_key] = endpoint
+    
+    def resolve(self, request):
+        key = str(request.region_id) + request.api_type
+        return self._endpoint_entry_map.get(key)

webull/core/exception/error_code.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
+
+SDK_INVALID_CREDENTIAL = 'SDK.InvalidCredential'
+SDK_INVALID_PARAMETER = 'SDK.InvalidParameter'
+SDK_NOT_SUPPORT = 'SDK.NotSupport'
+SDK_INVALID_REQUEST = 'SDK.InvalidRequest'
+SDK_ENDPOINT_RESOLVING_ERROR = 'SDK.EndpointResolvingError'
+SDK_HTTP_ERROR = 'SDK.HttpError'
+SDK_UNKNOWN_SERVER_ERROR = 'SDK.UnknownServerError'

webull/core/exception/error_msg.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
+__dict = dict(
+     
+)
+
+def get_msg(code):
+    return __dict.get(code)

webull/core/exception/exceptions.py

@@ -0,0 +1,53 @@
+# 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
+class ClientException(Exception):
+    def __init__(self, code, msg=""):
+        Exception.__init__(self)
+        self.error_code = code
+        self.error_msg = msg
+        
+    def __str__(self):
+        return "%s %s" % (self.error_code, self.error_msg)
+
+    def get_error_code(self):
+        return self.error_code
+
+    def get_error_msg(self):
+        return self.error_msg
+
+class ServerException(Exception):
+    def __init__(self, code, msg="", http_status = None, request_id = None):
+        Exception.__init__(self)
+        self.error_code = code
+        self.error_msg = msg
+        self.http_status = http_status
+        self.request_id = request_id
+
+    def get_error_code(self):
+        return self.error_code
+
+    def get_error_msg(self):
+        return self.error_msg
+
+    def get_http_status(self):
+        return self.http_status
+
+    def get_request_id(self):
+        return self.request_id
+
+    def __str__(self):
+        return "HTTP Status: %s, Code: %s, Msg: %s, RequestID: %s" \
+    % (str(self.http_status), self.error_code, self.error_msg, self.request_id)

webull/core/headers.py

@@ -0,0 +1,57 @@
+# 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
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/request.py
+which was part of Alibaba Group.
+"""
+
+REQUEST_ID = "X-Request-Id"
+APP_KEY = "x-app-key"
+SIGNATURE = "x-signature"
+SIGN_ALGORITHM = "x-signature-algorithm"
+SIGN_VERSION = "x-signature-version"
+NONCE = "x-signature-nonce"
+TIMESTAMP = "x-timestamp"
+VERSION = "x-version"
+WB_USER_ID = "wb-user-id"
+
+ACCESS_TOKEN = "x-access-token"
+
+NATIVE_HOST = "Host"
+NATIVE_CONTENT_TYPE = "Content-Type"
+NATIVE_CONTENT_LENGTH = "Content-Length"
+NATIVE_USER_AGENT = "User-Agent"