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

whitebit/client.py

@@ -0,0 +1,580 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+from .codes.client import AsyncCodesClient, CodesClient
+from .collateral_trading.client import AsyncCollateralTradingClient, CollateralTradingClient
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .core.request_options import RequestOptions
+from .credit_line.client import AsyncCreditLineClient, CreditLineClient
+from .crypto_lending_fixed.client import AsyncCryptoLendingFixedClient, CryptoLendingFixedClient
+from .crypto_lending_flex.client import AsyncCryptoLendingFlexClient, CryptoLendingFlexClient
+from .deposit.client import AsyncDepositClient, DepositClient
+from .environment import WhitebitApiEnvironment
+from .fees.client import AsyncFeesClient, FeesClient
+from .jwt.client import AsyncJwtClient, JwtClient
+from .main_account.client import AsyncMainAccountClient, MainAccountClient
+from .market_fee.client import AsyncMarketFeeClient, MarketFeeClient
+from .mining_pool.client import AsyncMiningPoolClient, MiningPoolClient
+from .public_api_v4.client import AsyncPublicApiV4Client, PublicApiV4Client
+from .raw_client import AsyncRawWhitebitApi, RawWhitebitApi
+from .spot_trading.client import AsyncSpotTradingClient, SpotTradingClient
+from .sub_account.client import AsyncSubAccountClient, SubAccountClient
+from .sub_account_api_keys.client import AsyncSubAccountApiKeysClient, SubAccountApiKeysClient
+from .transfer.client import AsyncTransferClient, TransferClient
+from .types.convert_confirm_response import ConvertConfirmResponse
+from .types.convert_estimate_request_direction import ConvertEstimateRequestDirection
+from .types.convert_estimate_response import ConvertEstimateResponse
+from .types.convert_history_response import ConvertHistoryResponse
+from .withdraw.client import AsyncWithdrawClient, WithdrawClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class WhitebitApi:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    environment : WhitebitApiEnvironment
+        The environment to use for requests from the client. from .environment import WhitebitApiEnvironment
+
+        Defaults to WhitebitApiEnvironment.DEFAULT
+
+
+
+    api_key : str
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from whitebit import WhitebitApi
+    client = WhitebitApi(api_key="YOUR_API_KEY", )
+    """
+
+    def __init__(
+        self,
+        *,
+        environment: WhitebitApiEnvironment = WhitebitApiEnvironment.DEFAULT,
+        api_key: str,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = SyncClientWrapper(
+            environment=environment,
+            api_key=api_key,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self._raw_client = RawWhitebitApi(client_wrapper=self._client_wrapper)
+        self.public_api_v4 = PublicApiV4Client(client_wrapper=self._client_wrapper)
+        self.main_account = MainAccountClient(client_wrapper=self._client_wrapper)
+        self.deposit = DepositClient(client_wrapper=self._client_wrapper)
+        self.jwt = JwtClient(client_wrapper=self._client_wrapper)
+        self.withdraw = WithdrawClient(client_wrapper=self._client_wrapper)
+        self.transfer = TransferClient(client_wrapper=self._client_wrapper)
+        self.codes = CodesClient(client_wrapper=self._client_wrapper)
+        self.crypto_lending_fixed = CryptoLendingFixedClient(client_wrapper=self._client_wrapper)
+        self.crypto_lending_flex = CryptoLendingFlexClient(client_wrapper=self._client_wrapper)
+        self.fees = FeesClient(client_wrapper=self._client_wrapper)
+        self.sub_account = SubAccountClient(client_wrapper=self._client_wrapper)
+        self.sub_account_api_keys = SubAccountApiKeysClient(client_wrapper=self._client_wrapper)
+        self.mining_pool = MiningPoolClient(client_wrapper=self._client_wrapper)
+        self.credit_line = CreditLineClient(client_wrapper=self._client_wrapper)
+        self.collateral_trading = CollateralTradingClient(client_wrapper=self._client_wrapper)
+        self.market_fee = MarketFeeClient(client_wrapper=self._client_wrapper)
+        self.spot_trading = SpotTradingClient(client_wrapper=self._client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawWhitebitApi:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawWhitebitApi
+        """
+        return self._raw_client
+
+    def convert_estimate(
+        self,
+        *,
+        from_: str,
+        to: str,
+        direction: ConvertEstimateRequestDirection,
+        amount: str,
+        nonce: typing.Optional[int] = OMIT,
+        request: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ConvertEstimateResponse:
+        """
+        The endpoint creates a quote for converting one currency to another. Quote lifetime is 10 seconds, then quote will be expired.
+
+        <Warning>
+        Rate limit: 10000 requests/10 sec.
+        </Warning>
+
+        Parameters
+        ----------
+        from_ : str
+            From currency. Example: BTC
+
+        to : str
+            To currency. Example: USDT
+
+        direction : ConvertEstimateRequestDirection
+            Convert amount direction, defines in which currency corresponding "amount" field is populated. Use "to" in case amount is in "to" currency, use "from" if amount is in "from" currency
+
+        amount : str
+            Amount to convert or receive.
+
+        nonce : typing.Optional[int]
+            Nonce for request
+
+        request : typing.Optional[str]
+            Request path
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ConvertEstimateResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.convert_estimate(from_='BTC', to='USDT', direction="to", amount='35,103.1', )
+        """
+        _response = self._raw_client.convert_estimate(
+            from_=from_,
+            to=to,
+            direction=direction,
+            amount=amount,
+            nonce=nonce,
+            request=request,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def convert_confirm(
+        self,
+        *,
+        quote_id: str,
+        nonce: typing.Optional[int] = OMIT,
+        request: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ConvertConfirmResponse:
+        """
+        The endpoint confirms an estimated quote.
+
+        <Warning>
+        Rate limit: 10000 requests/10 sec.
+        </Warning>
+
+        Parameters
+        ----------
+        quote_id : str
+            Quote ID
+
+        nonce : typing.Optional[int]
+            Nonce for request
+
+        request : typing.Optional[str]
+            Request path
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ConvertConfirmResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.convert_confirm(quote_id='4050', )
+        """
+        _response = self._raw_client.convert_confirm(
+            quote_id=quote_id, nonce=nonce, request=request, request_options=request_options
+        )
+        return _response.data
+
+    def convert_history(
+        self,
+        *,
+        from_ticker: typing.Optional[str] = OMIT,
+        to_ticker: typing.Optional[str] = OMIT,
+        from_: typing.Optional[str] = OMIT,
+        to: typing.Optional[str] = OMIT,
+        quote_id: typing.Optional[str] = OMIT,
+        limit: typing.Optional[str] = OMIT,
+        offset: typing.Optional[str] = OMIT,
+        nonce: typing.Optional[int] = OMIT,
+        request: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ConvertHistoryResponse:
+        """
+        The endpoint returns convert history.
+
+        <Warning>
+        Rate limit: 10000 requests/10 sec.
+        </Warning>
+        **Note:** The endpoint can retrieve data not older than 6 months from current month. For older data, use the Report on the History page.
+
+        Parameters
+        ----------
+        from_ticker : typing.Optional[str]
+            From currency. Example: BTC
+
+        to_ticker : typing.Optional[str]
+            To currency. Example: USDT
+
+        from_ : typing.Optional[str]
+            From time filter. Example: 1699260637. Default: now()
+
+        to : typing.Optional[str]
+            To time filter. Example: 1699260637. Default: now() +
+
+        quote_id : typing.Optional[str]
+            Quote Id. Example: 4050
+
+        limit : typing.Optional[str]
+            How many records to receive. Default: 100
+
+        offset : typing.Optional[str]
+            Amount to convert or receive. Default 0
+
+        nonce : typing.Optional[int]
+            Nonce for request
+
+        request : typing.Optional[str]
+            Request path
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ConvertHistoryResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.convert_history(from_ticker='BTC', )
+        """
+        _response = self._raw_client.convert_history(
+            from_ticker=from_ticker,
+            to_ticker=to_ticker,
+            from_=from_,
+            to=to,
+            quote_id=quote_id,
+            limit=limit,
+            offset=offset,
+            nonce=nonce,
+            request=request,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncWhitebitApi:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    environment : WhitebitApiEnvironment
+        The environment to use for requests from the client. from .environment import WhitebitApiEnvironment
+
+        Defaults to WhitebitApiEnvironment.DEFAULT
+
+
+
+    api_key : str
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from whitebit import AsyncWhitebitApi
+    client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+    """
+
+    def __init__(
+        self,
+        *,
+        environment: WhitebitApiEnvironment = WhitebitApiEnvironment.DEFAULT,
+        api_key: str,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = AsyncClientWrapper(
+            environment=environment,
+            api_key=api_key,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self._raw_client = AsyncRawWhitebitApi(client_wrapper=self._client_wrapper)
+        self.public_api_v4 = AsyncPublicApiV4Client(client_wrapper=self._client_wrapper)
+        self.main_account = AsyncMainAccountClient(client_wrapper=self._client_wrapper)
+        self.deposit = AsyncDepositClient(client_wrapper=self._client_wrapper)
+        self.jwt = AsyncJwtClient(client_wrapper=self._client_wrapper)
+        self.withdraw = AsyncWithdrawClient(client_wrapper=self._client_wrapper)
+        self.transfer = AsyncTransferClient(client_wrapper=self._client_wrapper)
+        self.codes = AsyncCodesClient(client_wrapper=self._client_wrapper)
+        self.crypto_lending_fixed = AsyncCryptoLendingFixedClient(client_wrapper=self._client_wrapper)
+        self.crypto_lending_flex = AsyncCryptoLendingFlexClient(client_wrapper=self._client_wrapper)
+        self.fees = AsyncFeesClient(client_wrapper=self._client_wrapper)
+        self.sub_account = AsyncSubAccountClient(client_wrapper=self._client_wrapper)
+        self.sub_account_api_keys = AsyncSubAccountApiKeysClient(client_wrapper=self._client_wrapper)
+        self.mining_pool = AsyncMiningPoolClient(client_wrapper=self._client_wrapper)
+        self.credit_line = AsyncCreditLineClient(client_wrapper=self._client_wrapper)
+        self.collateral_trading = AsyncCollateralTradingClient(client_wrapper=self._client_wrapper)
+        self.market_fee = AsyncMarketFeeClient(client_wrapper=self._client_wrapper)
+        self.spot_trading = AsyncSpotTradingClient(client_wrapper=self._client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawWhitebitApi:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawWhitebitApi
+        """
+        return self._raw_client
+
+    async def convert_estimate(
+        self,
+        *,
+        from_: str,
+        to: str,
+        direction: ConvertEstimateRequestDirection,
+        amount: str,
+        nonce: typing.Optional[int] = OMIT,
+        request: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ConvertEstimateResponse:
+        """
+        The endpoint creates a quote for converting one currency to another. Quote lifetime is 10 seconds, then quote will be expired.
+
+        <Warning>
+        Rate limit: 10000 requests/10 sec.
+        </Warning>
+
+        Parameters
+        ----------
+        from_ : str
+            From currency. Example: BTC
+
+        to : str
+            To currency. Example: USDT
+
+        direction : ConvertEstimateRequestDirection
+            Convert amount direction, defines in which currency corresponding "amount" field is populated. Use "to" in case amount is in "to" currency, use "from" if amount is in "from" currency
+
+        amount : str
+            Amount to convert or receive.
+
+        nonce : typing.Optional[int]
+            Nonce for request
+
+        request : typing.Optional[str]
+            Request path
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ConvertEstimateResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.convert_estimate(from_='BTC', to='USDT', direction="to", amount='35,103.1', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.convert_estimate(
+            from_=from_,
+            to=to,
+            direction=direction,
+            amount=amount,
+            nonce=nonce,
+            request=request,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def convert_confirm(
+        self,
+        *,
+        quote_id: str,
+        nonce: typing.Optional[int] = OMIT,
+        request: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ConvertConfirmResponse:
+        """
+        The endpoint confirms an estimated quote.
+
+        <Warning>
+        Rate limit: 10000 requests/10 sec.
+        </Warning>
+
+        Parameters
+        ----------
+        quote_id : str
+            Quote ID
+
+        nonce : typing.Optional[int]
+            Nonce for request
+
+        request : typing.Optional[str]
+            Request path
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ConvertConfirmResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.convert_confirm(quote_id='4050', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.convert_confirm(
+            quote_id=quote_id, nonce=nonce, request=request, request_options=request_options
+        )
+        return _response.data
+
+    async def convert_history(
+        self,
+        *,
+        from_ticker: typing.Optional[str] = OMIT,
+        to_ticker: typing.Optional[str] = OMIT,
+        from_: typing.Optional[str] = OMIT,
+        to: typing.Optional[str] = OMIT,
+        quote_id: typing.Optional[str] = OMIT,
+        limit: typing.Optional[str] = OMIT,
+        offset: typing.Optional[str] = OMIT,
+        nonce: typing.Optional[int] = OMIT,
+        request: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ConvertHistoryResponse:
+        """
+        The endpoint returns convert history.
+
+        <Warning>
+        Rate limit: 10000 requests/10 sec.
+        </Warning>
+        **Note:** The endpoint can retrieve data not older than 6 months from current month. For older data, use the Report on the History page.
+
+        Parameters
+        ----------
+        from_ticker : typing.Optional[str]
+            From currency. Example: BTC
+
+        to_ticker : typing.Optional[str]
+            To currency. Example: USDT
+
+        from_ : typing.Optional[str]
+            From time filter. Example: 1699260637. Default: now()
+
+        to : typing.Optional[str]
+            To time filter. Example: 1699260637. Default: now() +
+
+        quote_id : typing.Optional[str]
+            Quote Id. Example: 4050
+
+        limit : typing.Optional[str]
+            How many records to receive. Default: 100
+
+        offset : typing.Optional[str]
+            Amount to convert or receive. Default 0
+
+        nonce : typing.Optional[int]
+            Nonce for request
+
+        request : typing.Optional[str]
+            Request path
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ConvertHistoryResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.convert_history(from_ticker='BTC', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.convert_history(
+            from_ticker=from_ticker,
+            to_ticker=to_ticker,
+            from_=from_,
+            to=to,
+            quote_id=quote_id,
+            limit=limit,
+            offset=offset,
+            nonce=nonce,
+            request=request,
+            request_options=request_options,
+        )
+        return _response.data

whitebit/codes/__init__.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import ApplyCodeResponse, CreateCodeResponse, GetCodesHistoryResponse, GetMyCodesResponse
+
+__all__ = ["ApplyCodeResponse", "CreateCodeResponse", "GetCodesHistoryResponse", "GetMyCodesResponse"]