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

whitebit/crypto_lending_fixed/client.py

@@ -0,0 +1,651 @@
+# 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 ..types.fixed_plan import FixedPlan
+from .raw_client import AsyncRawCryptoLendingFixedClient, RawCryptoLendingFixedClient
+from .types.create_fixed_investment_response import CreateFixedInvestmentResponse
+from .types.get_fixed_investments_history_response import GetFixedInvestmentsHistoryResponse
+from .types.get_interest_payment_history_response import GetInterestPaymentHistoryResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CryptoLendingFixedClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCryptoLendingFixedClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCryptoLendingFixedClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCryptoLendingFixedClient
+        """
+        return self._raw_client
+
+    def get_fixed_plans(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        ticker: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[FixedPlan]:
+        """
+        The endpoint retrieves all active [plans](/glossary#crypto-lending).
+
+        <Note>
+        These endpoints are available only for B2B partner services. Fill the institutional services form to get permissions to use these endpoints.
+        </Note>
+
+        **Note:** When target currency is different from source currency, interest amount in target currency will be calculated using `interestRatio` value.
+
+        **Examples:**
+        - When source currency = USDT, target currency = BTC and interest ratio = 40000, interest is received in BTC and equals the USDT interest amount divided by the interest ratio (e.g. 0.000025 BTC per 1 USDT of interest).
+        - When source currency equals target currency, interest ratio equals 1.
+
+        <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]
+            [Invest plan](/glossary#crypto-lending) source currency's [ticker](/glossary#ticker). Example: BTC
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[FixedPlan]
+            Successful response
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.crypto_lending_fixed.get_fixed_plans(ticker='USDT', request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.get_fixed_plans(
+            request=request, nonce=nonce, ticker=ticker, request_options=request_options
+        )
+        return _response.data
+
+    def create_fixed_investment(
+        self,
+        *,
+        plan_id: str,
+        amount: str,
+        request: str,
+        nonce: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateFixedInvestmentResponse:
+        """
+        The endpoint creates a new investment to the specified [invest plan](/glossary#crypto-lending).
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        plan_id : str
+            [Invest plan](/glossary#crypto-lending) identifier
+
+        amount : str
+            Investment amount
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateFixedInvestmentResponse
+            Investment created successfully
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.crypto_lending_fixed.create_fixed_investment(plan_id='8e667b4a-0b71-4988-8af5-9474dbfaeb51', amount='100', request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.create_fixed_investment(
+            plan_id=plan_id, amount=amount, request=request, nonce=nonce, request_options=request_options
+        )
+        return _response.data
+
+    def close_fixed_investment(
+        self, *, id: str, request: str, nonce: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Dict[str, typing.Optional[typing.Any]]:
+        """
+        The endpoint closes active investment.
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        id : str
+            Investment identifier
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, typing.Optional[typing.Any]]
+            Investment closed successfully
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.crypto_lending_fixed.close_fixed_investment(id='0d7b66ff-1909-4938-ab7a-d16d9a64dcd5', request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.close_fixed_investment(
+            id=id, request=request, nonce=nonce, request_options=request_options
+        )
+        return _response.data
+
+    def get_fixed_investments_history(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        id: typing.Optional[str] = OMIT,
+        ticker: typing.Optional[str] = OMIT,
+        status: typing.Optional[int] = OMIT,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetFixedInvestmentsHistoryResponse:
+        """
+        The endpoint retrieves an investments history.
+
+        <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
+
+        id : typing.Optional[str]
+            Investment identifier
+
+        ticker : typing.Optional[str]
+            [Invest plan](/glossary#crypto-lending) source currency's [ticker](/glossary#ticker)
+
+        status : typing.Optional[int]
+            Investment status (1 - active, 2 - closed)
+
+        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.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetFixedInvestmentsHistoryResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.crypto_lending_fixed.get_fixed_investments_history(id='0d7b66ff-1909-4938-ab7a-d16d9a64dcd5', ticker='USDT', status=1, request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.get_fixed_investments_history(
+            request=request,
+            nonce=nonce,
+            id=id,
+            ticker=ticker,
+            status=status,
+            limit=limit,
+            offset=offset,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_interest_payment_history(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        plan_id: typing.Optional[str] = OMIT,
+        ticker: typing.Optional[str] = OMIT,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetInterestPaymentHistoryResponse:
+        """
+        The endpoint retrieves the history of interest payments.
+
+        <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
+
+        plan_id : typing.Optional[str]
+            [Invest plan](/glossary#crypto-lending) identifier
+
+        ticker : typing.Optional[str]
+            [Invest plan](/glossary#crypto-lending) target currency's [ticker](/glossary#ticker)
+
+        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.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetInterestPaymentHistoryResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.crypto_lending_fixed.get_interest_payment_history(plan_id='8e667b4a-0b71-4988-8af5-9474dbfaeb51', ticker='USDT', request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.get_interest_payment_history(
+            request=request,
+            nonce=nonce,
+            plan_id=plan_id,
+            ticker=ticker,
+            limit=limit,
+            offset=offset,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncCryptoLendingFixedClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCryptoLendingFixedClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCryptoLendingFixedClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCryptoLendingFixedClient
+        """
+        return self._raw_client
+
+    async def get_fixed_plans(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        ticker: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[FixedPlan]:
+        """
+        The endpoint retrieves all active [plans](/glossary#crypto-lending).
+
+        <Note>
+        These endpoints are available only for B2B partner services. Fill the institutional services form to get permissions to use these endpoints.
+        </Note>
+
+        **Note:** When target currency is different from source currency, interest amount in target currency will be calculated using `interestRatio` value.
+
+        **Examples:**
+        - When source currency = USDT, target currency = BTC and interest ratio = 40000, interest is received in BTC and equals the USDT interest amount divided by the interest ratio (e.g. 0.000025 BTC per 1 USDT of interest).
+        - When source currency equals target currency, interest ratio equals 1.
+
+        <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]
+            [Invest plan](/glossary#crypto-lending) source currency's [ticker](/glossary#ticker). Example: BTC
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[FixedPlan]
+            Successful response
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.crypto_lending_fixed.get_fixed_plans(ticker='USDT', request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_fixed_plans(
+            request=request, nonce=nonce, ticker=ticker, request_options=request_options
+        )
+        return _response.data
+
+    async def create_fixed_investment(
+        self,
+        *,
+        plan_id: str,
+        amount: str,
+        request: str,
+        nonce: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateFixedInvestmentResponse:
+        """
+        The endpoint creates a new investment to the specified [invest plan](/glossary#crypto-lending).
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        plan_id : str
+            [Invest plan](/glossary#crypto-lending) identifier
+
+        amount : str
+            Investment amount
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateFixedInvestmentResponse
+            Investment created successfully
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.crypto_lending_fixed.create_fixed_investment(plan_id='8e667b4a-0b71-4988-8af5-9474dbfaeb51', amount='100', request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_fixed_investment(
+            plan_id=plan_id, amount=amount, request=request, nonce=nonce, request_options=request_options
+        )
+        return _response.data
+
+    async def close_fixed_investment(
+        self, *, id: str, request: str, nonce: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Dict[str, typing.Optional[typing.Any]]:
+        """
+        The endpoint closes active investment.
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        id : str
+            Investment identifier
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, typing.Optional[typing.Any]]
+            Investment closed successfully
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.crypto_lending_fixed.close_fixed_investment(id='0d7b66ff-1909-4938-ab7a-d16d9a64dcd5', request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.close_fixed_investment(
+            id=id, request=request, nonce=nonce, request_options=request_options
+        )
+        return _response.data
+
+    async def get_fixed_investments_history(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        id: typing.Optional[str] = OMIT,
+        ticker: typing.Optional[str] = OMIT,
+        status: typing.Optional[int] = OMIT,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetFixedInvestmentsHistoryResponse:
+        """
+        The endpoint retrieves an investments history.
+
+        <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
+
+        id : typing.Optional[str]
+            Investment identifier
+
+        ticker : typing.Optional[str]
+            [Invest plan](/glossary#crypto-lending) source currency's [ticker](/glossary#ticker)
+
+        status : typing.Optional[int]
+            Investment status (1 - active, 2 - closed)
+
+        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.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetFixedInvestmentsHistoryResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.crypto_lending_fixed.get_fixed_investments_history(id='0d7b66ff-1909-4938-ab7a-d16d9a64dcd5', ticker='USDT', status=1, request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_fixed_investments_history(
+            request=request,
+            nonce=nonce,
+            id=id,
+            ticker=ticker,
+            status=status,
+            limit=limit,
+            offset=offset,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_interest_payment_history(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        plan_id: typing.Optional[str] = OMIT,
+        ticker: typing.Optional[str] = OMIT,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetInterestPaymentHistoryResponse:
+        """
+        The endpoint retrieves the history of interest payments.
+
+        <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
+
+        plan_id : typing.Optional[str]
+            [Invest plan](/glossary#crypto-lending) identifier
+
+        ticker : typing.Optional[str]
+            [Invest plan](/glossary#crypto-lending) target currency's [ticker](/glossary#ticker)
+
+        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.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetInterestPaymentHistoryResponse
+            Successful response
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.crypto_lending_fixed.get_interest_payment_history(plan_id='8e667b4a-0b71-4988-8af5-9474dbfaeb51', ticker='USDT', request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_interest_payment_history(
+            request=request,
+            nonce=nonce,
+            plan_id=plan_id,
+            ticker=ticker,
+            limit=limit,
+            offset=offset,
+            request_options=request_options,
+        )
+        return _response.data