trd-utils 0.0.1__py3-none-any.whl

trd_utils/__init__.py

@@ -0,0 +1,3 @@
+
+
+

trd_utils/bx_ultra/__init__.py

@@ -0,0 +1,6 @@
+
+from .bx_ultra_client import BXUltraClient
+
+__all__ = [
+    "BXUltraClient",
+]

trd_utils/bx_ultra/bx_types.py

@@ -0,0 +1,719 @@
+from typing import Any, Optional
+from ..types_helper import BaseModel
+from decimal import Decimal
+
+default_quantize = Decimal("1.00")
+
+
+class BxApiResponse(BaseModel):
+    code: int = None
+    timestamp: int = None
+    msg: str = None
+
+    def __str__(self):
+        return f"code: {self.code}; timestamp: {self.timestamp}"
+
+    def __repr__(self):
+        return f"code: {self.code}; timestamp: {self.timestamp}"
+
+
+class CoinQuotationInfo(BaseModel):
+    name: str = None
+    coin_type: int = None
+    valuation_coin_name: str = None
+    coin_name: str = None
+    icon_name: str = None
+    slug: str = None
+    quotation_id: int = None
+    open: Decimal = None
+    close: Decimal = None
+    weight: int = None
+    favorite_flag: Any = None  # unknown
+    precision: int = None
+    coin_precision: int = None
+    valuation_precision: int = None
+    market_status: Any = None  # unknown
+    trader_scale: Decimal = None
+    coin_id: int = None
+    valuation_coin_id: int = None
+    status: Any = None  # unknown
+    open_time: Any = None  # unknown
+    open_price: Any = None  # unknown
+    high24: Optional[Decimal] = None
+    low24: Optional[Decimal] = None
+    volume24: Optional[Decimal] = None
+    amount24: Optional[Decimal] = None
+    market_val: Optional[Decimal] = None
+    full_name: str = None
+    biz_type: int = None
+
+    def __str__(self):
+        return f"{self.coin_name}/{self.valuation_coin_name}; price: {self.close}; vol: {self.market_val}"
+
+    def __repr__(self):
+        return f"{self.coin_name}/{self.valuation_coin_name}; price: {self.close}; vol: {self.market_val}"
+
+
+###########################################################
+
+
+class ZoneModuleInfo(BaseModel):
+    id: int = None
+    name: str = None
+    quotation_list: list[CoinQuotationInfo] = None
+    zone_name: str = None
+    weight: int = None
+    biz_type: int = None
+
+    def __str__(self):
+        return f"{self.name} ({self.zone_name})"
+
+    def __repr__(self):
+        return f"{self.name} ({self.zone_name})"
+
+
+class ZoneModuleListResult(BaseModel):
+    zone_module_list: list[ZoneModuleInfo] = None
+    biz_type: int = None
+    need_channel_type: list[int] = None
+    icon_url_prefix: str = None
+
+
+class ZoneModuleListResponse(BxApiResponse):
+    data: ZoneModuleListResult = None
+
+
+###########################################################
+
+
+class UserFavoriteQuotationResult(BaseModel):
+    usdt_margin_list: list[CoinQuotationInfo] = None
+    coin_margin_list: list[CoinQuotationInfo] = None
+    swap_list: list[CoinQuotationInfo] = None
+    biz_type: int = None
+    icon_url_prefix: str = None
+    recommend: bool = None
+
+
+class UserFavoriteQuotationResponse(BxApiResponse):
+    data: UserFavoriteQuotationResult = None
+
+
+###########################################################
+
+
+class QuotationRankBizItem(BaseModel):
+    quotation_list: list[CoinQuotationInfo] = None
+    biz_type: int = None
+    biz_name: str = None
+
+
+class QuotationRankItem(BaseModel):
+    rank_type: int = None
+    rank_name: str = None
+    rank_biz_list: list[QuotationRankBizItem] = None
+
+
+class QuotationRankResult(BaseModel):
+    rank_list: list[QuotationRankItem] = None
+    icon_prefix: str = None
+    icon_url_prefix: str = None
+    order_flag: int = None
+    show_favorite: bool = None
+
+
+class QuotationRankResponse(BxApiResponse):
+    data: QuotationRankResult = None
+
+
+###########################################################
+
+# region HotSearch types
+
+
+class HotSearchItem(BaseModel):
+    symbol: str = None
+    coin_name: str = None
+    val_coin_name: str = None
+    weight: int = None
+
+    def __str__(self):
+        return f"{self.coin_name} ({self.symbol})"
+    
+    def __repr__(self):
+        return f"{self.coin_name} ({self.symbol})"
+
+
+class HotSearchResult(BaseModel):
+    result: list[HotSearchItem] = None
+    hint_ab_test: bool = None
+    page_id: int = None
+    total: int = None
+
+
+class HotSearchResponse(BxApiResponse):
+    data: HotSearchResult = None
+
+    def __str__(self):
+        if not self.data:
+            return "HotSearchResponse: No data"
+        
+        str_result = "HotSearchResponse: \n"
+        for current_item in self.data.result:
+            str_result += f" - {current_item}\n"
+        
+        return str_result
+    
+    def __repr__(self):
+        return self.__str__()
+
+
+# endregion
+
+###########################################################
+
+# region HomePage types
+
+
+class CoinModuleInfoBase(BaseModel):
+    name: str = None
+    coin_name: str = None
+    icon_name: str = None
+    valuation_coin_name: str = None
+    open: Decimal = None
+    close: Decimal = None
+    precision: int = None
+    biz_type: int = None
+    market_val: Decimal = None
+    status: int = None
+    open_time: int = None
+    open_price: Decimal = None
+    full_name: str = None
+    amount24: Decimal = None
+    global_first_publish: bool = None
+    st_tag: int = None
+
+
+class HomePageModuleIncreaseRankData(CoinModuleInfoBase):
+    pass
+
+
+class HomePageModuleIncreaseRank(BaseModel):
+    item_name: str = None
+    sub_module_type: int = None
+    data: list[HomePageModuleIncreaseRankData] = None
+
+
+class HomePageModuleHotZoneData(CoinModuleInfoBase):
+    zone_desc: str = None
+    zone_name: str = None
+    zone_id: int = None
+    zone_price_rate: Decimal = None
+
+
+class HomePageModuleHotZone(BaseModel):
+    data: list[HomePageModuleHotZoneData] = None
+
+
+class HomePageModuleRecentHotData(CoinModuleInfoBase):
+    pass
+
+
+class HomePageModuleRecentHot(BaseModel):
+    data: list[HomePageModuleRecentHotData] = None
+
+
+class HomePageModuleGlobalDebutData(CoinModuleInfoBase):
+    pass
+
+
+class HomePageModuleGlobalDebut(BaseModel):
+    data: list[HomePageModuleGlobalDebutData] = None
+
+
+class HomePageModuleMainMarketData(CoinModuleInfoBase):
+    pass
+
+
+class HomePageModuleMainMarket(BaseModel):
+    data: list[HomePageModuleMainMarketData] = None
+
+
+class HomePageModulePreOnlineData(CoinModuleInfoBase):
+    pass
+
+
+class HomePageModulePreOnline(BaseModel):
+    data: list[HomePageModulePreOnlineData] = None
+
+
+class HomePageModuleBannerData(BaseModel):
+    banner_title: str = None
+    banner_img: str = None
+    banner_jump_url: str = None
+
+
+class HomePageModuleBanner(BaseModel):
+    data: list[HomePageModuleBannerData] = None
+
+
+class HomePageModuleInfo(BaseModel):
+    module_type: int = None
+    module_name: str = None
+    module_desc: str = None
+    item_list: list = None
+
+    def _check_module_name(
+        self, j_data: dict, module_name: str, module_type: int
+    ) -> bool:
+        return (
+            self.module_name == module_name
+            or j_data.get("moduleName", None) == module_name
+            or self.module_type == module_type
+            or j_data.get("moduleType", None) == module_type
+        )
+
+    def _get_item_list_type(self, j_data: dict = None) -> type:
+        if not j_data:
+            # for more safety
+            j_data = {}
+
+        if self._check_module_name(j_data, "PRE_ONLINE", 1):
+            return list[HomePageModulePreOnline]
+
+        elif self._check_module_name(j_data, "MAIN_MARKET", 2):
+            return list[HomePageModuleMainMarket]
+
+        elif self._check_module_name(j_data, "RECENT_HOT", 3):
+            return list[HomePageModuleRecentHot]
+
+        elif self._check_module_name(j_data, "HOT_ZONE", 5):
+            return list[HomePageModuleHotZone]
+
+        elif self._check_module_name(j_data, "INCREASE_RANK", 6):
+            return list[HomePageModuleIncreaseRank]
+
+        elif self._check_module_name(j_data, "BANNER", 7):
+            return list[HomePageModuleBanner]
+
+        elif self._check_module_name(j_data, "GLOBAL_DEBUT", 8):
+            return list[HomePageModuleGlobalDebut]
+
+        return None
+
+    def __str__(self):
+        return (
+            f"{self.module_name} ({self.module_type}): {self.module_desc};"
+            + f" {len(self.item_list)} items"
+        )
+
+    def __repr__(self):
+        return (
+            f"{self.module_name} ({self.module_type}): {self.module_desc};"
+            + f" {len(self.item_list)} items"
+        )
+
+
+class HomePageResult(BaseModel):
+    icon_prefix: str = None
+    green_amount_img_prefix: str = None
+    red_amount_img_prefix: str = None
+    module_list: list[HomePageModuleInfo] = None
+
+
+class HomePageResponse(BxApiResponse):
+    data: HomePageResult = None
+
+
+# endregion
+
+
+###########################################################
+
+
+class ZenDeskABStatusResult(BaseModel):
+    ab_status: int = None
+
+
+class ZenDeskABStatusResponse(BxApiResponse):
+    data: ZenDeskABStatusResult = None
+
+
+###########################################################
+
+
+class HintListResult(BaseModel):
+    hints: list = None  # unknown
+
+
+class HintListResponse(BxApiResponse):
+    data: HintListResult = None
+
+
+###########################################################
+
+#region CopyTrading types
+
+
+class CopyTradingSymbolConfigInfo(BaseModel):
+    price_precision: int = None
+    quantity_precision: int = None
+
+
+class CopyTraderPositionInfo(BaseModel):
+    avg_price: Decimal = None
+    coin_name: str = None
+    leverage: Decimal = None
+    liquidated_price: Decimal = None
+    margin: Decimal = None
+    mark_price: Decimal = None
+    position_earning_rate: Decimal = None
+    position_no: int = None
+    position_side: str = None
+    position_side_and_symbol: str = None
+    symbol: str = None
+    symbol_config: CopyTradingSymbolConfigInfo = None
+    unrealized_pnl: Decimal = None
+    valuation_coin_name: str = None
+    volume: Decimal = None
+    search_result: Optional[bool] = None
+    short_position_rate: Decimal = None
+    total: int = None
+
+    def __str__(self):
+        return (
+            f"{self.coin_name} / {self.valuation_coin_name} {self.position_side} "
+            + f"{self.leverage.quantize(default_quantize)}x "
+            + f"vol: {self.volume.quantize(default_quantize)}; "
+            + f"price: {self.avg_price.quantize(default_quantize)}; "
+            + f"margin: {self.margin.quantize(default_quantize)}; "
+            + f"pnl: {self.unrealized_pnl.quantize(default_quantize)}; "
+            + f"ROI: {(self.position_earning_rate * 100).quantize(default_quantize)}%"
+        )
+
+    def __repr__(self):
+        return self.__str__()
+
+
+class CopyTraderTradePositionsResult(BaseModel):
+    hide: int = None
+    long_position_rate: Decimal = None
+    page_id: int = None
+    positions: list[CopyTraderPositionInfo] = None
+
+
+class CopyTraderTradePositionsResponse(BxApiResponse):
+    data: CopyTraderTradePositionsResult = None
+
+
+class SearchCopyTraderCondition(BaseModel):
+    key: str = "exchangeId"
+    selected: int = 2
+    type: str = "singleSelect"
+
+    def to_dict(self):
+        return {
+            "key": self.key,
+            "selected": f"{self.selected}",
+            "type": self.type,
+        }
+
+class SearchedTraderChartItem(BaseModel):
+    cumulative_pnl_rate: Decimal = None
+
+class SearchedTraderExchangeVoInfo(BaseModel):
+    account_enum: str = None
+    desc: str = None
+    exchange_id: int = None
+    exchange_name: str = None
+    icon: str = None
+
+class SearchTraderInfoRankStat(BaseModel):
+    api_identity: int = None
+    avg_hold_time: str = None
+    avg_loss_amount: str = None
+    avg_loss_rate: str = None
+    avg_profit_amount: str = None
+    avg_profit_rate: str = None
+    being_invite: bool = None
+    chart: list[SearchedTraderChartItem] = None  # unknown; list
+    copier_status: int = None
+    dis_play_name: str = None
+    equity: str = None
+    exchange_vo: Any = None  # unknown
+    expand: int = None
+    follower_earning: str = None
+    follower_full: bool = None
+    icon: str = None
+    is_pro: bool = None
+    is_relation: bool = None
+    last_trade_time: str = None
+    latest30_days_median_lever_times: str = None
+    latest30_days_median_margin: str = None
+    loss_count: int = None
+    max_draw_down: str = None
+    pnl_rate: str = None
+    profit_count: int = None
+    recent7_day_follower_num_change: int = None
+    recent30_day_follower_num_change: int = None
+    recent90_day_follower_num_change: int = None
+    recent180_day_follower_num_change: int = None
+    risk_level7_days: str = None
+    risk_level30_days: str = None
+    risk_level90_days: str = None
+    risk_level180_days: str = None
+    risk_status: int = None
+    str_acc_follower_num: str = None
+    str_follower_num: str = None
+    str_recent7_days_rate: str = None
+    str_recent30_days_rate: str = None
+    str_recent90_days_rate: str = None
+    str_recent180_days_rate: str = None
+    str_recent180_days_rate: str = None
+    str_total_earnings_rate: str = None
+    total_earnings: str = None
+    total_transactions: int = None
+    trade_days: str = None
+    update_time: str = None
+    valid: int = None
+    vst_copier_status: int = None
+    weekly_trade_frequency: str = None
+    winRate: str = None
+
+class SearchedTraderInfo(BaseModel):
+    avatar: str = None
+    be_trader: bool = None
+    channel: str = None
+    flag: str = None
+    ip_country: str = None
+    nation: str = None
+    nick_name: str = None
+    register_date: str = None
+    register_ip_country: str = None
+    short_uid: int = None
+    team_id: int = None
+    uid: int = None
+
+class SearchedTraderAccountGradeVoInfo(BaseModel):
+    api_identity: int = None
+    label: int = None
+    trader_grade: int = None
+    uid: int = None
+
+class SearchTraderInfoContainer(BaseModel):
+    content: str = None
+    has_new: bool = None
+    labels: list = None  # unknown
+    rank_stat: SearchTraderInfoRankStat = None  # unknown
+    trader: SearchedTraderInfo = None  # unknown
+    trader_account_grade_vo: SearchedTraderAccountGradeVoInfo = None  # unknown
+    trader_public_recommend_status: Any = None  # unknown
+
+    def get_nick_name(self) -> str:
+        if self.trader:
+            return self.trader.nick_name
+        
+        return
+
+    def get_uid(self) -> int:
+        if self.trader:
+            return self.trader.uid
+        
+        return
+
+    def get_api_identity(self) -> int:
+        if self.trader_account_grade_vo:
+            return self.trader_account_grade_vo.api_identity
+        
+        if self.rank_stat:
+            return self.rank_stat.api_identity
+        
+        # TODO: later on add support for more cases
+        return None
+
+    def __str__(self):
+        if not self.trader:
+            return "No trader info"
+        
+        return f"uid: {self.trader.uid}; name: {self.trader.nick_name}; country: {self.trader.nation}"
+    
+    def __repr__(self):
+        return self.__str__()
+
+class SearchCopyTradersResult(BaseModel):
+    expand_display: Any = None  # unknown
+    fold_display: Any = None  # unknown
+    page_id: int = None
+    rank_desc: str = None
+    rank_short_desc: str = None
+    rank_statistic_days: int = None
+    rank_tags: Any = None  # unknown
+    rank_title: str = None
+    rank_type: str = None
+    result: list[SearchTraderInfoContainer] = None  # unknown
+    search_result: bool = None
+    total: int = None
+
+class SearchCopyTradersResponse(BxApiResponse):
+    data: SearchCopyTradersResult = None
+
+
+#endregion
+
+###########################################################
+
+# region Account Assets types
+
+class TotalAssetsInfo(BaseModel):
+    amount: Any = None  # unknown
+    currency_amount: Decimal = None
+    sign: str = None
+
+    def __str__(self):
+        return f"{self.currency_amount.quantize(default_quantize)} {self.sign}"
+    
+    def __repr__(self):
+        return self.__str__()
+
+class AccountOverviewItem(BaseModel):
+    account_name: str = None
+    account_type: int = None
+    total: TotalAssetsInfo = None  # unknown
+    schema: str = None
+    order: int = None
+
+    def __str__(self):
+        return f"{self.account_name} ({self.account_type}): {self.total}"
+
+class AssetsInfoResult(BaseModel):
+    total: TotalAssetsInfo = None
+    account_overviews: list[AccountOverviewItem] = None
+    recharge: int = None
+    withdraw: int = None
+    transfer: int = None
+    exchange: int = None
+    fault_flag: int = None
+    fault_accounts: Any = None  # unknown
+
+class AssetsInfoResponse(BxApiResponse):
+    data: AssetsInfoResult = None
+
+# endregion
+
+###########################################################
+
+# region Contracts types
+
+class BasicCoinInfo(BaseModel):
+    name: str = None
+
+    def __str__(self):
+        return f"{self.name} CoinInfo"
+    
+    def __repr__(self):
+        return self.__str__()
+
+class QuotationCoinVOInfo(BaseModel):
+    id: int = None
+    coin: BasicCoinInfo = None
+    valuation_coin: BasicCoinInfo = None
+    precision: int = None
+    name: str = None
+    market_status: int = None
+
+class OrderDebitInfo(BaseModel):
+    lend_coin: BasicCoinInfo = None
+    amount: Decimal = None
+
+class OrderOpenTradeInfo(BaseModel):
+    traded_amount: Decimal = None
+    traded_cash_amount: Decimal = None
+
+class ContractOrderStatus(BaseModel):
+    code: int = None
+    value: str = None
+
+
+class ContractTakeProfitInfo(BaseModel):
+    id: int = None
+
+    # this is id of the contract that this take-profit info belongs to.
+    order_no: int = None
+    margin_coin_name: str = None
+    type: int = None
+    margin: Decimal = None
+    stop_rate: Decimal = None
+    stop_price: Decimal = None
+    close_style: int = None
+    all_close: bool = None
+
+class ContractStopLossInfo(BaseModel):
+    pass
+
+class ProfitLossInfoContainer(BaseModel):
+    loss_nums: int = None
+    profit_nums: int = None
+    profit_margin: Decimal = None
+    loss_margin: Decimal = None
+    profit_config: ContractTakeProfitInfo = None
+    loss_config: ContractStopLossInfo = None
+
+class ContractOrderInfo(BaseModel):
+    order_no: int = None
+    quotation_coin_vo: QuotationCoinVOInfo = None
+    margin: Decimal = None
+    margin_coin_name: str = None
+    lever_times: Decimal = None
+    display_lever_times: Decimal = None
+    amount: Decimal = None # margin * lever_times
+    display_price: Decimal = None
+    display_close_price: Decimal = None
+    order_type: int = None
+    close_type: int = None
+    status: ContractOrderStatus = None
+    open_date: str = None
+    fees: Decimal = None
+    lever_fee: Decimal = None
+    name: str = None
+    order_create_type: int = None
+    hide_price: bool = None
+    fee_rate: Decimal = None
+    hide: int = None
+    liquidation_desc: str = None
+    contract_account_mode: int = None
+    current_price: Decimal = None
+    sys_force_price: Decimal = None
+    fund_type: int = None
+    interest: Decimal = None
+    order_open_trade: OrderOpenTradeInfo = None
+    order_debit: OrderDebitInfo = None
+    open_rate: Decimal = None
+    close_rate: Decimal = None
+    market_status: int = None
+    create_time: str = None
+    coupon_amount: Decimal = None
+    stop_profit_modify_time: str = None
+    stop_loss_modify_time: str = None
+    show_adjust_margin: int = None
+    trailing_stop: Decimal = None
+    trailing_close_price: Decimal = None
+    stop_rate: Decimal = None
+    profit_loss_info: ProfitLossInfoContainer = None
+    configs: Any = None  # just dictionaries of take-profit and stop-loss configs.
+    stop_offset_rate: Decimal = None
+
+class MarginStatInfo(BaseModel):
+    name: str = None
+    margin_coin_name: str = None
+    margin_type: int = None
+
+    # total count of open contract orders in this margin-type.
+    total: int = None
+
+class ContractsListResult(BaseModel):
+    orders: list[ContractOrderInfo] = None
+    page_id: int = None
+    margin_stats: list[MarginStatInfo] = None
+
+class ContractsListResponse(BxApiResponse):
+    data: ContractsListResult = None