whitebit-python-sdk 1.1.0__py3-none-any.whl

whitebit/withdraw/types/create_withdraw_request_beneficiary.py

@@ -0,0 +1,74 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class CreateWithdrawRequestBeneficiary(UniversalBaseModel):
+    """
+    Beneficiary information data array.
+
+    ⚠️ Required if currency [ticker](/glossary#ticker) is one of: UAH_IBAN, USD_VISAMASTER, EUR_VISAMASTER, USD, EUR
+    """
+
+    first_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="firstName")] = pydantic.Field(
+        default=None
+    )
+    """
+    Beneficiary first name. Max length: 40 symbols, latin letters and special characters.
+    
+    ⚠️ Required if currency [ticker](/glossary#ticker) is one of: UAH_IBAN, USD_VISAMASTER, USD, EUR
+    """
+
+    last_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastName")] = pydantic.Field(
+        default=None
+    )
+    """
+    Beneficiary last name. Max length: 40 symbols, latin letters and special characters.
+    
+    ⚠️ Required if currency [ticker](/glossary#ticker) is one of: UAH_IBAN, USD_VISAMASTER, USD, EUR
+    """
+
+    tin: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Beneficiary TAX payer number. Integer, 10 digits.
+    
+    ⚠️ Required if currency is UAH_IBAN.
+    """
+
+    phone: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Beneficiary phone number.
+    
+    ⚠️ Required if currency [ticker](/glossary#ticker) is one of: USD_VISAMASTER, EUR_VISAMASTER
+    """
+
+    email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Beneficiary email.
+    
+    ⚠️ Required if currency [ticker](/glossary#ticker) is one of: USD_VISAMASTER, EUR_VISAMASTER
+    """
+
+    birth_date: typing_extensions.Annotated[typing.Optional[dt.date], FieldMetadata(alias="birthDate")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Beneficiary birth date. Format: YYYY-MM-DD.
+    
+    ⚠️ Required if currency [ticker](/glossary#ticker) is one of: USD_VISAMASTER, EUR_VISAMASTER
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

whitebit/withdraw/types/create_withdraw_request_travel_rule.py

@@ -0,0 +1,52 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .create_withdraw_request_travel_rule_type import CreateWithdrawRequestTravelRuleType
+
+
+class CreateWithdrawRequestTravelRule(UniversalBaseModel):
+    """
+    Travel Rule information data array.
+
+    ⚠️ Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+    """
+
+    type: typing.Optional[CreateWithdrawRequestTravelRuleType] = pydantic.Field(default=None)
+    """
+    Travel rule receiver type. Values: "individual" or "entity"
+    
+    ⚠️ Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+    """
+
+    vasp: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Travel rule destination platform (VASP) name.
+    
+    ⚠️ Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Travel rule. If individual - first_name ; if entity - entity_name
+    
+    ⚠️ Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+    """
+
+    address: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Travel rule. If individual - last_name ; if entity - entity_address
+    
+    ⚠️ Required if currency is crypto and the account is from [EEA](/glossary#european-economic-area-eea)
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

whitebit/withdraw/types/create_withdraw_request_travel_rule_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateWithdrawRequestTravelRuleType = typing.Union[typing.Literal["individual", "entity"], typing.Any]

whitebit_python_sdk-1.1.0.dist-info/METADATA

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: whitebit-python-sdk
+Version: 1.1.0
+Summary: A Python SDK for WhiteBit cryptocurrency exchange API
+Author: WhiteBit SDK Team
+License: MIT
+Project-URL: Homepage, https://www.whitebit.com
+Project-URL: Documentation, https://whitebit-exchange.github.io/api-docs/
+Project-URL: Repository, https://github.com/whitebit-exchange/python-sdk
+Project-URL: Issues, https://github.com/whitebit-exchange/python-sdk/issues
+Keywords: whitebit,cryptocurrency,exchange,api,sdk,trading
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0.0,>=2.28.1
+Requires-Dist: websockets<11.0,>=10.4
+Requires-Dist: responses>=0.23.1
+Requires-Dist: urllib3<2.0.0,>=1.26.15
+Requires-Dist: pydantic<3.0.0,>=1.10.0
+Requires-Dist: httpx<1.0.0,>=0.23.0
+Dynamic: license-file
+
+## A Python SDK for [whitebit](https://www.whitebit.com)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Please read [whitebit API document](https://whitebit-exchange.github.io/api-docs/) before continuing.
+
+## API List
+
+- [Private API](https://whitebit-exchange.github.io/api-docs/private/http-trade-v4/)
+- [Public API](https://whitebit-exchange.github.io/api-docs/public/http-v4/)
+- [Private WS](https://whitebit-exchange.github.io/api-docs/private/websocket/)
+- [Public WS](https://whitebit-exchange.github.io/api-docs/public/websocket/)
+
+v4 is the preferred one to use
+
+## Disclaimer
+“You acknowledge that the software is provided “as is”. Author makes no representations or warranties with respect to
+the software whether express or implied, including but not limited to, implied warranties of merchantability and fitness
+for a particular purpose. author makes no representation or warranty that: (i) the use and distribution of the software
+will be uninterrupted or error free, and (ii) any use and distribution of the software is free from infringement of any
+third party intellectual property rights. It shall be your sole responsibility to make such determination before the use
+of software. Author disclaims any liability in case any such use and distribution infringe any third party’s
+intellectual property rights. Author hereby disclaims any warranty and liability whatsoever for any development created
+by or for you with respect to your customers. You acknowledge that you have relied on no warranties and that no
+warranties are made by author or granted by law whenever it is permitted by law.”
+
+## REST API
+
+### Setup
+
+#### Install the Python module:
+
+```bash
+python3 -m pip install python-whitebit-sdk
+```
+
+Init client for API services. Get APIKey/SecretKey from your whitebit account.
+
+```python
+from whitebit import MainAccountClient
+
+account = MainAccountClient(api_key="", api_secret=""))
+```
+
+Following are some simple examples.
+
+See the **examples** folder for full references.
+
+#### Create Spot Limit Order
+
+```python
+# Create order/spot client
+order = OrderClient(api_key="",
+                    api_secret="")
+
+# Call SDK function put_limit
+print(order.put_limit("BTC_USDT", "sell", "0.1", "40000", True))
+```
+
+## Websocket API
+
+### Setup
+
+Init bot class and "on_message" method for work with ws responses. Get APIKey/SecretKey from your whitebit account.
+
+```python
+class Bot(WhitebitWsClient):
+    def __init__(self):
+        super().__init__(key="", secret="")
+
+    async def on_message(self, event) -> None:
+        logging.info(event)
+        
+```
+
+Following are some simple examples.
+
+See the **examples** folder for full references.
+
+#### Subscribe on deals topic
+
+```python
+class Bot(WhitebitWsClient):
+    '''Can be used to create a custom trading strategy/bot'''
+
+    def __init__(self):
+        super().__init__(key="", secret="")
+
+    async def on_message(self, event) -> None:
+        '''receives the websocket events'''
+        if 'result' in event:
+            result = event['result']
+            match result:
+                case 'pong': return
+            logging.info(event['result'])
+            return
+        else:
+            method = event['method']
+            match method:
+                case WhitebitWsClient.DEALS_UPDATE:
+                    logging.info(event['params'])
+            return
+
+
+async def main() -> None:
+    bot = Bot()
+    await bot.get_deals("BTC_USDT", 0, 100)
+    await bot.subscribe_deals(["BTC_USDT"])
+    while not bot.exception_occur:
+        await asyncio.sleep(100)
+    return
+
+
+if __name__ == '__main__':
+    logging.basicConfig(level=logging.INFO)
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        pass
+    finally:
+        loop.close()
+```