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

whitebit/main_account/client.py

@@ -0,0 +1,380 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawMainAccountClient, RawMainAccountClient
+from .types.get_deposit_withdraw_history_response import GetDepositWithdrawHistoryResponse
+from .types.get_main_balance_response_value import GetMainBalanceResponseValue
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class MainAccountClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawMainAccountClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawMainAccountClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawMainAccountClient
+        """
+        return self._raw_client
+
+    def get_main_balance(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        ticker: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Dict[str, GetMainBalanceResponseValue]:
+        """
+        The endpoint retrieves the [main balance](/glossary#balance-main) by currency [ticker](/glossary#ticker) or all balances.
+
+        <Warning>
+          Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        ticker : typing.Optional[str]
+            Currency's ticker.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, GetMainBalanceResponseValue]
+            Successful response
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.main_account.get_main_balance(request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.get_main_balance(
+            request=request, nonce=nonce, ticker=ticker, request_options=request_options
+        )
+        return _response.data
+
+    def get_deposit_withdraw_history(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        transaction_method: typing.Optional[int] = OMIT,
+        ticker: typing.Optional[str] = OMIT,
+        address: typing.Optional[str] = OMIT,
+        memo: typing.Optional[str] = OMIT,
+        addresses: typing.Optional[typing.Sequence[str]] = OMIT,
+        unique_id: typing.Optional[str] = OMIT,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        status: typing.Optional[typing.Sequence[int]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetDepositWithdrawHistoryResponse:
+        """
+        The endpoint retrieves the history of deposits and withdraws.
+
+        **Deposit status codes:**
+        - `Successful` - 3, 7
+        - `Canceled` - 4, 9
+        - `Unconfirmed by user` - 5
+        - `Additional data required` - 21
+        - `Uncredited` - 22
+        - `Pending` - 15
+
+        **Travel Rule Deposit check status codes:**
+        - `Awaiting verification` - 27: The transaction has been frozen due to the lack of data required under the Travel Rule. The user is required to provide this data manually through the exchange interface.
+        - `Confirmation in progress` - 28: The Travel Rule data provided by the user is currently being verified by WhiteBIT.
+
+        ⚠️ Due to regulatory requirements in Turkey and [EU](/glossary#european-economic-area-eea), the system places every inbound crypto deposit on hold (frozen) until confirming the transaction's origin. The sender must provide certain details if the transaction is from another Virtual Asset Service Provider (VASP) or verify the address if from a self-hosted wallet. The system credits deposited funds to the account only after successful verification.
+
+        **Withdraw status codes:**
+        - `Pending` - 1, 2, 6, 10, 11, 12, 13, 14, 15, 16, 17
+        - `Successful` - 3, 7
+        - `Canceled` - 4
+        - `Unconfirmed by user` - 5
+        - `Additional data required` - 21
+        - `Partially successful` - 18
+
+        <Warning>
+        Rate limit: 200 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        transaction_method : typing.Optional[int]
+            Method. Example: **1** to display deposits / **2** to display withdraws. Do not send this parameter in order to receive both deposits and withdraws.
+
+        ticker : typing.Optional[str]
+            Currency's [ticker](/glossary#ticker). Example: BTC
+
+        address : typing.Optional[str]
+            Can be used for filtering transactions by specific address.
+
+        memo : typing.Optional[str]
+            Can be used for filtering transactions by specific [memo](/glossary#memodestination-tag)
+
+        addresses : typing.Optional[typing.Sequence[str]]
+            Can be used for filtering transactions by specific array of addresses.
+
+        unique_id : typing.Optional[str]
+            Can be used for filtering transactions by specific unique id
+
+        limit : typing.Optional[int]
+            LIMIT is a special clause used to limit records a particular query can return.
+
+        offset : typing.Optional[int]
+            Use the OFFSET clause to return entries starting from a particular line.
+
+        status : typing.Optional[typing.Sequence[int]]
+            Can be used for filtering transactions by status codes.
+
+            ⚠️ Caution: Use this parameter with the appropriate `transactionMethod` and valid status codes for that method. See the endpoint description above for valid codes. Example: `"status": [3,7]`
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetDepositWithdrawHistoryResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.main_account.get_deposit_withdraw_history(transaction_method=1, ticker='BTC', limit=100, offset=0, status=[3, 7], request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.get_deposit_withdraw_history(
+            request=request,
+            nonce=nonce,
+            transaction_method=transaction_method,
+            ticker=ticker,
+            address=address,
+            memo=memo,
+            addresses=addresses,
+            unique_id=unique_id,
+            limit=limit,
+            offset=offset,
+            status=status,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncMainAccountClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawMainAccountClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawMainAccountClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawMainAccountClient
+        """
+        return self._raw_client
+
+    async def get_main_balance(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        ticker: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Dict[str, GetMainBalanceResponseValue]:
+        """
+        The endpoint retrieves the [main balance](/glossary#balance-main) by currency [ticker](/glossary#ticker) or all balances.
+
+        <Warning>
+          Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        ticker : typing.Optional[str]
+            Currency's ticker.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, GetMainBalanceResponseValue]
+            Successful response
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.main_account.get_main_balance(request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_main_balance(
+            request=request, nonce=nonce, ticker=ticker, request_options=request_options
+        )
+        return _response.data
+
+    async def get_deposit_withdraw_history(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        transaction_method: typing.Optional[int] = OMIT,
+        ticker: typing.Optional[str] = OMIT,
+        address: typing.Optional[str] = OMIT,
+        memo: typing.Optional[str] = OMIT,
+        addresses: typing.Optional[typing.Sequence[str]] = OMIT,
+        unique_id: typing.Optional[str] = OMIT,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        status: typing.Optional[typing.Sequence[int]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetDepositWithdrawHistoryResponse:
+        """
+        The endpoint retrieves the history of deposits and withdraws.
+
+        **Deposit status codes:**
+        - `Successful` - 3, 7
+        - `Canceled` - 4, 9
+        - `Unconfirmed by user` - 5
+        - `Additional data required` - 21
+        - `Uncredited` - 22
+        - `Pending` - 15
+
+        **Travel Rule Deposit check status codes:**
+        - `Awaiting verification` - 27: The transaction has been frozen due to the lack of data required under the Travel Rule. The user is required to provide this data manually through the exchange interface.
+        - `Confirmation in progress` - 28: The Travel Rule data provided by the user is currently being verified by WhiteBIT.
+
+        ⚠️ Due to regulatory requirements in Turkey and [EU](/glossary#european-economic-area-eea), the system places every inbound crypto deposit on hold (frozen) until confirming the transaction's origin. The sender must provide certain details if the transaction is from another Virtual Asset Service Provider (VASP) or verify the address if from a self-hosted wallet. The system credits deposited funds to the account only after successful verification.
+
+        **Withdraw status codes:**
+        - `Pending` - 1, 2, 6, 10, 11, 12, 13, 14, 15, 16, 17
+        - `Successful` - 3, 7
+        - `Canceled` - 4
+        - `Unconfirmed by user` - 5
+        - `Additional data required` - 21
+        - `Partially successful` - 18
+
+        <Warning>
+        Rate limit: 200 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        transaction_method : typing.Optional[int]
+            Method. Example: **1** to display deposits / **2** to display withdraws. Do not send this parameter in order to receive both deposits and withdraws.
+
+        ticker : typing.Optional[str]
+            Currency's [ticker](/glossary#ticker). Example: BTC
+
+        address : typing.Optional[str]
+            Can be used for filtering transactions by specific address.
+
+        memo : typing.Optional[str]
+            Can be used for filtering transactions by specific [memo](/glossary#memodestination-tag)
+
+        addresses : typing.Optional[typing.Sequence[str]]
+            Can be used for filtering transactions by specific array of addresses.
+
+        unique_id : typing.Optional[str]
+            Can be used for filtering transactions by specific unique id
+
+        limit : typing.Optional[int]
+            LIMIT is a special clause used to limit records a particular query can return.
+
+        offset : typing.Optional[int]
+            Use the OFFSET clause to return entries starting from a particular line.
+
+        status : typing.Optional[typing.Sequence[int]]
+            Can be used for filtering transactions by status codes.
+
+            ⚠️ Caution: Use this parameter with the appropriate `transactionMethod` and valid status codes for that method. See the endpoint description above for valid codes. Example: `"status": [3,7]`
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetDepositWithdrawHistoryResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.main_account.get_deposit_withdraw_history(transaction_method=1, ticker='BTC', limit=100, offset=0, status=[3, 7], request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_deposit_withdraw_history(
+            request=request,
+            nonce=nonce,
+            transaction_method=transaction_method,
+            ticker=ticker,
+            address=address,
+            memo=memo,
+            addresses=addresses,
+            unique_id=unique_id,
+            limit=limit,
+            offset=offset,
+            status=status,
+            request_options=request_options,
+        )
+        return _response.data