trd-utils 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

trd_utils/bx_ultra/bx_types.py

@@ -1,6 +1,8 @@
 from typing import Any, Optional
 from ..types_helper import BaseModel
 from decimal import Decimal
+from datetime import datetime, timedelta
+import pytz
 
 from .common_utils import (
     dec_to_str,
@@ -690,6 +692,7 @@ class ContractOrderInfo(BaseModel):
     close_type: int = None
     status: ContractOrderStatus = None
     open_date: str = None
+    close_date: str = None
     fees: Decimal = None
     lever_fee: Decimal = None
     name: str = None
@@ -730,7 +733,8 @@ class ContractOrderInfo(BaseModel):
         return self.sys_force_price
     
     def get_profit_str(self) -> str:
-        profit_or_loss = self.current_price - self.display_price
+        last_price = self.current_price or self.display_close_price
+        profit_or_loss = last_price - self.display_price
         profit_percentage = (profit_or_loss / self.display_price) * 100
         profit_percentage *= 1 if self.is_long() else -1
         return dec_to_str(profit_percentage * self.lever_times)
@@ -755,8 +759,10 @@ class ContractOrderInfo(BaseModel):
         if self.sys_force_price:
             result_str += f"liquidation: {dec_to_normalize(self.sys_force_price)}{separator}"
         
-        result_str += f"current price: {dec_to_normalize(self.current_price)}{separator}"
-        
+        if self.current_price:
+            result_str += f"current price: {dec_to_normalize(self.current_price)}{separator}"
+        elif self.display_close_price:
+            result_str += f"close price: {dec_to_normalize(self.display_close_price)}{separator}"
         profit_str = self.get_profit_str()
         result_str += f"profit: {profit_str}%"
 
@@ -768,6 +774,11 @@ class ContractOrderInfo(BaseModel):
     def __repr__(self):
         return self.to_str()
 
+class ClosedContractOrderInfo(ContractOrderInfo):
+    close_type_name: str = None
+    gross_earnings: Decimal = None
+    position_order: int = None
+
 class MarginStatInfo(BaseModel):
     name: str = None
     margin_coin_name: str = None
@@ -783,3 +794,87 @@ class ContractsListResult(BaseModel):
 
 class ContractsListResponse(BxApiResponse):
     data: ContractsListResult = None
+
+class ContractOrdersHistoryResult(BaseModel):
+    orders: list[ClosedContractOrderInfo] = None
+    page_id: int = None
+
+class ContractOrdersHistoryResponse(BxApiResponse):
+    data: ContractOrdersHistoryResult = None
+
+    def get_today_earnings(self, timezone: Any = pytz.UTC) -> Decimal:
+        """
+        Returns the total earnings for today.
+        NOTE: This function will return None if there are no orders for today.
+        """
+        found_any_for_today: bool = False
+        today_earnings = Decimal("0.00")
+        today = datetime.now(timezone).date()
+        for current_order in self.data.orders:
+            # check if the date is for today
+            closed_date = datetime.strptime(
+                current_order.close_date,
+                '%Y-%m-%dT%H:%M:%S.%f%z',
+            ).astimezone(timezone).date()
+            if closed_date == today:
+                today_earnings += current_order.gross_earnings
+                found_any_for_today = True
+        
+        if not found_any_for_today:
+            return None
+
+        return today_earnings
+    
+    def get_this_week_earnings(self, timezone: Any = pytz.UTC) -> Decimal:
+        """
+        Returns the total earnings for this week.
+        NOTE: This function will return None if there are no orders for this week.
+        """
+        found_any_for_week: bool = False
+        week_earnings = Decimal("0.00")
+        today = datetime.now(timezone).date()
+        week_start = today - timedelta(days=today.weekday())
+        for current_order in self.data.orders:
+            # check if the date is for this week
+            closed_date = datetime.strptime(
+                current_order.close_date,
+                '%Y-%m-%dT%H:%M:%S.%f%z',
+            ).astimezone(timezone).date()
+            if closed_date >= week_start:
+                week_earnings += current_order.gross_earnings
+                found_any_for_week = True
+        
+        if not found_any_for_week:
+            return None
+
+        return week_earnings
+
+    def get_this_month_earnings(self, timezone: Any = pytz.UTC) -> Decimal:
+        """
+        Returns the total earnings for this month.
+        NOTE: This function will return None if there are no orders for this month.
+        """
+        found_any_for_month: bool = False
+        month_earnings = Decimal("0.00")
+        today = datetime.now(timezone).date()
+        month_start = today.replace(day=1)
+        for current_order in self.data.orders:
+            # check if the date is for this month
+            closed_date = datetime.strptime(
+                current_order.close_date,
+                '%Y-%m-%dT%H:%M:%S.%f%z',
+            ).astimezone(timezone).date()
+            if closed_date >= month_start:
+                month_earnings += current_order.gross_earnings
+                found_any_for_month = True
+        
+        if not found_any_for_month:
+            return None
+
+        return month_earnings
+
+    def get_orders_len(self) -> int:
+        if not self.data or not self.data.orders:
+            return 0
+        return len(self.data.orders)
+        

trd_utils/bx_ultra/bx_ultra_client.py

@@ -1,5 +1,6 @@
 """BxUltra exchange subclass"""
 
+import asyncio
 from decimal import Decimal
 import json
 import logging
@@ -13,6 +14,7 @@ from pathlib import Path
 from .common_utils import do_ultra_ss
 from .bx_types import (
     AssetsInfoResponse,
+    ContractOrdersHistoryResponse,
     ContractsListResponse,
     CopyTraderTradePositionsResponse,
     HintListResponse,
@@ -241,6 +243,136 @@ class BXUltraClient:
         )
         return ContractsListResponse.deserialize(response.json(parse_float=Decimal))
 
+    async def get_contract_order_history(
+        self,
+        fund_type: int = 1,
+        paging_size: int = 10,
+        page_id: int = 0,
+        from_order_no: int = 0,
+        margin_coin_name: str = "USDT",
+        margin_type: int = 0,
+    ) -> ContractOrdersHistoryResponse:
+        params = {
+            "fundType": f"{fund_type}",
+            "pagingSize": f"{paging_size}",
+            "pageId": f"{page_id}",
+            "marginCoinName": margin_coin_name,
+            "marginType": f"{margin_type}",
+        }
+        if from_order_no:
+            params["fromOrderNo"] = f"{from_order_no}"
+
+        headers = self.get_headers(params, needs_auth=True)
+        response = await self.httpx_client.get(
+            f"{self.we_api_base_url}/v2/contract/order/history",
+            headers=headers,
+            params=params,
+        )
+        return ContractOrdersHistoryResponse.deserialize(
+            response.json(parse_float=Decimal)
+        )
+
+    async def get_today_contract_earnings(
+        self,
+        margin_coin_name: str = "USDT",
+        page_size: int = 10,
+        max_total_size: int = 500,
+        delay_per_fetch: float = 1.0,
+    ) -> Decimal:
+        """
+        Fetches today's earnings from the contract orders.
+        NOTE: This method is a bit slow due to the API rate limiting.
+        NOTE: If the user has not opened ANY contract orders today, 
+            this method will return None.
+        """
+        return await self._get_period_contract_earnings(
+            period="day",
+            margin_coin_name=margin_coin_name,
+            page_size=page_size,
+            max_total_size=max_total_size,
+            delay_per_fetch=delay_per_fetch,
+        )
+
+    async def get_this_week_contract_earnings(
+        self,
+        margin_coin_name: str = "USDT",
+        page_size: int = 10,
+        max_total_size: int = 500,
+        delay_per_fetch: float = 1.0,
+    ) -> Decimal:
+        """
+        Fetches this week's earnings from the contract orders.
+        NOTE: This method is a bit slow due to the API rate limiting.
+        NOTE: If the user has not opened ANY contract orders this week, 
+            this method will return None.
+        """
+        return await self._get_period_contract_earnings(
+            period="week",
+            margin_coin_name=margin_coin_name,
+            page_size=page_size,
+            max_total_size=max_total_size,
+            delay_per_fetch=delay_per_fetch,
+        )
+
+    async def get_this_month_contract_earnings(
+        self,
+        margin_coin_name: str = "USDT",
+        page_size: int = 10,
+        max_total_size: int = 500,
+        delay_per_fetch: float = 1.0,
+    ) -> Decimal:
+        """
+        Fetches this month's earnings from the contract orders.
+        NOTE: This method is a bit slow due to the API rate limiting.
+        NOTE: If the user has not opened ANY contract orders this week, 
+            this method will return None.
+        """
+        return await self._get_period_contract_earnings(
+            period="month",
+            margin_coin_name=margin_coin_name,
+            page_size=page_size,
+            max_total_size=max_total_size,
+            delay_per_fetch=delay_per_fetch,
+        )
+
+    async def _get_period_contract_earnings(
+        self,
+        period: str,
+        margin_coin_name: str = "USDT",
+        page_size: int = 10,
+        max_total_size: int = 500,
+        delay_per_fetch: float = 1.0,
+    ) -> Decimal:
+        total_fetched = 0
+        total_earnings = Decimal("0.00")
+        has_earned_any = False
+        while total_fetched < max_total_size:
+            current_page = total_fetched // page_size
+            result = await self.get_contract_order_history(
+                page_id=current_page,
+                paging_size=page_size,
+                margin_coin_name=margin_coin_name,
+            )
+            if period == "day":
+                temp_earnings = result.get_today_earnings()
+            elif period == "week":
+                temp_earnings = result.get_this_week_earnings()
+            elif period == "month":
+                temp_earnings = result.get_this_month_earnings()
+            if temp_earnings is None:
+                # all ended
+                break
+            total_earnings += temp_earnings
+            has_earned_any = True
+            total_fetched += page_size
+            if result.get_orders_len() < page_size:
+                break
+            await asyncio.sleep(delay_per_fetch)
+        
+        if not has_earned_any:
+            return None
+        return total_earnings
+    
     # endregion
     ###########################################################
     # region copy-trade-facade

{trd_utils-0.0.3.dist-info → trd_utils-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: trd_utils
-Version: 0.0.3
+Version: 0.0.4
 Summary: Common Basic Utils for Python3. By ALiwoto.
 Home-page: https://github.com/ALiwoto/trd_utils
 Keywords: utils,trd_utils,basic-utils,common-utils

{trd_utils-0.0.3.dist-info → trd_utils-0.0.4.dist-info}/RECORD

@@ -1,7 +1,7 @@
 trd_utils/__init__.py,sha256=ajz1GSNU9xYVrFEDSz6Xwg7amWQ_yvW75tQa1ZvRIWc,3
 trd_utils/bx_ultra/__init__.py,sha256=8Ssy-eOemQR32Nv1-FoPHm87nRqRO4Fm2PU5GHEFKfQ,80
-trd_utils/bx_ultra/bx_types.py,sha256=avgj7JFijJpK3_WBMrV5HaK4rssBnj0eG7kToEbdvAQ,21646
-trd_utils/bx_ultra/bx_ultra_client.py,sha256=w2ajrBLDrSeRAPXCPV4lkUkR-r1PqE1Kwu2bxbJUy7A,15876
+trd_utils/bx_ultra/bx_types.py,sha256=eaNIjGiWh9T9j9jfCdcni_vVTHS5AW1FyA3aeyCssqU,25187
+trd_utils/bx_ultra/bx_ultra_client.py,sha256=4fNtu0G04ZXqy2SHaYkwbwWDTb7M-InOggRN-a-bprs,20504
 trd_utils/bx_ultra/common_utils.py,sha256=p9u3D52jCa9DNJzo-oA1yK_lrdb7_ahkGHaTuiX5wGE,1656
 trd_utils/cipher/__init__.py,sha256=V05KNuzQwCic-ihMVHlC8sENaJGc3I8MCb4pg4849X8,1765
 trd_utils/html_utils/__init__.py,sha256=1WWs8C7JszRjTkmzIRLHpxWECHur_DrulTPGIeX88oM,426
@@ -11,7 +11,7 @@ trd_utils/tradingview/tradingview_client.py,sha256=iiNSLSKr5PnDcGiVFn515gsnGtqm5
 trd_utils/tradingview/tradingview_types.py,sha256=z21MXPVdWHAduEl3gSeMIRhxtBN9yK-jPYHfZSMIbSA,6144
 trd_utils/types_helper/__init__.py,sha256=SB9_5bQkuxV059AKC4cXYwsLPT3lM4LOu2m8LpMhZlQ,60
 trd_utils/types_helper/base_model.py,sha256=J3SdOB9UNgw0cI8gaG8zjnfqa1qiVmlpz4o3aBxHqas,5631
-trd_utils-0.0.3.dist-info/LICENSE,sha256=msfwzd8S06fL8ORRneycnonTKmyuXzfeBT0V2figir8,1062
-trd_utils-0.0.3.dist-info/METADATA,sha256=uhT5sTw4F0V-uIdk-i3iz3EKSfDHq8TU8FpELH0-K-o,975
-trd_utils-0.0.3.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-trd_utils-0.0.3.dist-info/RECORD,,
+trd_utils-0.0.4.dist-info/LICENSE,sha256=msfwzd8S06fL8ORRneycnonTKmyuXzfeBT0V2figir8,1062
+trd_utils-0.0.4.dist-info/METADATA,sha256=4RQOqx9CFCx1HzBbzBJsYyyRCn-EWCiupNs37429BPA,975
+trd_utils-0.0.4.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+trd_utils-0.0.4.dist-info/RECORD,,