aggregate asset

Author: tigersk

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.3.4
+### `TradeClient.get_aggregate_assets`
+
+
 ## 3.3.3 (2025-03-05)
 ### New
 - `QuoteClient.get_quote_overnight` 获取夜盘行情

tigeropen/__init__.py

@@ -4,4 +4,4 @@
 
 @author: gaoan
 """
-__VERSION__ = '3.3.3'
+__VERSION__ = '3.3.4'

tigeropen/common/consts/service_types.py

@@ -33,6 +33,7 @@
 PLACE_FOREX_ORDER = "place_forex_order"
 ESTIMATE_TRADABLE_QUANTITY = "estimate_tradable_quantity"
 TRANSFER_FUND = "transfer_fund"
+AGGREGATE_ASSETS = "aggregate_assets"
 
 USER_LICENSE = "user_license"
 

tigeropen/trade/domain/prime_account.py

@@ -99,3 +99,56 @@ def from_dict(d):
 
     def __repr__(self):
         return MODEL_REPR.format(self.__class__.__name__, self.__dict__)
+
+
+class AggregateAsset:
+    """
+    """
+    def __init__(self):
+        # 基础币种
+        self.currency = None
+        # 现金余额
+        self.cash_balance = float('inf')
+        # 现金余额包括在途
+        self.cash_balance_with_in_transit = float('inf')
+        # 具有借贷价值资产
+        self.equity_with_loan = float('inf')
+        # 净清算价值
+        self.net_liquidation = float('inf')
+        # 初始保证金
+        self.init_margin = float('inf')
+        # 维持保证金
+        self.maintain_margin = float('inf')
+        # 外汇保证金
+        self.trade_currency_margin = float('inf')
+        # 日内风险度
+        self.intraday_risk_ratio = float('inf')
+        # 总市值
+        self.gross_position_value = float('inf')
+        # 期权市值
+        self.option_market_value = float('inf')
+        # 期货市值
+        self.futures_market_value = float('inf')
+        # 可用剩余资产
+        self.cash_available_for_trade = float('inf')
+        # 可用现金值
+        self.available_cash = float('inf')
+        # 已锁定的剩余资产
+        self.locked_funds = float('inf')
+        # 锁定现金值
+        self.locked_cash = float('inf')
+        # 引用额度
+        self.credit_limit = float('inf')
+        # ee 剩余资产
+        self.excess_equity = float('inf')
+        # el 剩余流动资产
+        self.excess_liquidity = float('inf')
+
+    @staticmethod
+    def from_dict(d):
+        aggregate_asset = AggregateAsset()
+        aggregate_asset.__dict__.update(d)
+        return aggregate_asset
+
+    def __repr__(self):
+        return MODEL_REPR.format(self.__class__.__name__, self.__dict__)

tigeropen/trade/request/model.py

@@ -131,6 +131,50 @@ def to_openapi_dict(self):
 
         return params
 
+class AggregateAssetParams(BaseParams):
+    def __init__(self):
+        super(AggregateAssetParams, self).__init__()
+        self._account = None
+        self._secret_key = None
+        self._seg_type = False
+        self._base_currency = None
+
+    @property
+    def account(self):
+        return self._account
+    @account.setter
+    def account(self, value):
+        self._account = value
+    @property
+    def secret_key(self):
+        return self._secret_key
+    @secret_key.setter
+    def secret_key(self, value):
+        self._secret_key = value
+    @property
+    def seg_type(self):
+        return self._seg_type
+    @seg_type.setter
+    def seg_type(self, value):
+        self._seg_type = value
+    @property
+    def base_currency(self):
+        return self._base_currency
+    @base_currency.setter
+    def base_currency(self, value):
+        self._base_currency = value 
+
+    def to_openapi_dict(self):
+        params = super().to_openapi_dict()
+        if self.account:
+            params['account'] = self.account
+        if self.secret_key:
+            params['secret_key'] = self.secret_key
+        if self.seg_type:
+            params['seg_type'] = self.seg_type
+        if self.base_currency:
+            params['base_currency'] = self.base_currency
+        return params
 
 class PositionParams(BaseParams):
     def __init__(self):

tigeropen/trade/response/aggregate_assets_response.py

@@ -0,0 +1,18 @@
+from tigeropen.common.response import TigerResponse
+from tigeropen.common.util.string_utils import camel_to_underline_obj
+from tigeropen.trade.domain.prime_account import AggregateAsset
+
+
+class AggregateAssetsResponse(TigerResponse):
+    def __init__(self):
+        super().__init__()
+        self.result = None
+        self._is_success = None
+
+    def parse_response_content(self, response_content):
+        response = super().parse_response_content(response_content)
+        if 'is_success' in response:
+            self._is_success = response['is_success']
+
+        if self.data:
+            self.result = AggregateAsset.from_dict(camel_to_underline_obj(self.data))

tigeropen/trade/trade_client.py

@@ -9,8 +9,9 @@
 from tigeropen.common.consts import THREAD_LOCAL, SecurityType, Market, Currency, Language, OPEN_API_SERVICE_VERSION_V3
 from tigeropen.common.consts.service_types import CONTRACTS, ACCOUNTS, POSITIONS, ASSETS, ORDERS, ORDER_NO, \
     CANCEL_ORDER, MODIFY_ORDER, PLACE_ORDER, ACTIVE_ORDERS, INACTIVE_ORDERS, FILLED_ORDERS, CONTRACT, PREVIEW_ORDER, \
-    PRIME_ASSETS, ORDER_TRANSACTIONS, QUOTE_CONTRACT, ANALYTICS_ASSET, SEGMENT_FUND_AVAILABLE, SEGMENT_FUND_HISTORY, TRANSFER_FUND, \
-    TRANSFER_SEGMENT_FUND, CANCEL_SEGMENT_FUND, PLACE_FOREX_ORDER, ESTIMATE_TRADABLE_QUANTITY
+    PRIME_ASSETS, ORDER_TRANSACTIONS, QUOTE_CONTRACT, ANALYTICS_ASSET, SEGMENT_FUND_AVAILABLE, SEGMENT_FUND_HISTORY, \
+    TRANSFER_FUND, \
+    TRANSFER_SEGMENT_FUND, CANCEL_SEGMENT_FUND, PLACE_FOREX_ORDER, ESTIMATE_TRADABLE_QUANTITY, AGGREGATE_ASSETS
 from tigeropen.common.exceptions import ApiException
 from tigeropen.common.util.common_utils import get_enum_value, date_str_to_timestamp
 from tigeropen.common.request import OpenApiRequest
@@ -19,8 +20,9 @@
 from tigeropen.trade.domain.order import Order
 from tigeropen.trade.request.model import ContractParams, AccountsParams, AssetParams, PositionParams, OrdersParams, \
     OrderParams, PlaceModifyOrderParams, CancelOrderParams, TransactionsParams, AnalyticsAssetParams, SegmentFundParams, \
-    ForexTradeOrderParams, EstimateTradableQuantityModel, FundingHistoryParams
+    ForexTradeOrderParams, EstimateTradableQuantityModel, FundingHistoryParams, AggregateAssetParams
 from tigeropen.trade.response.account_profile_response import ProfilesResponse
+from tigeropen.trade.response.aggregate_assets_response import AggregateAssetsResponse
 from tigeropen.trade.response.analytics_asset_response import AnalyticsAssetResponse
 from tigeropen.trade.response.assets_response import AssetsResponse
 from tigeropen.trade.response.contracts_response import ContractsResponse
@@ -316,6 +318,23 @@ def get_prime_assets(self, account=None, base_currency=None, consolidated=True):
                 raise ApiException(response.code, response.message)
         return None
 
+    def get_aggregate_assets(self, account=None, base_currency=None, seg_type=None):
+        params = AggregateAssetParams()
+        params.account = account if account else self._account
+        params.secret_key = self._secret_key
+        params.lang = get_enum_value(self._lang)
+        params.base_currency = get_enum_value(base_currency)
+        params.seg_type = get_enum_value(seg_type)
+        request = OpenApiRequest(AGGREGATE_ASSETS, biz_model=params)
+        response_content = self.__fetch_data(request)
+        if response_content:
+            response = AggregateAssetsResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return response.data
+            else:
+                raise ApiException(response.code, response.message)
+
     def get_orders(self, account=None, sec_type=None, market=Market.ALL, symbol=None, start_time=None, end_time=None,
                    limit=100, is_brief=False, states=None, sort_by=None, seg_type=None):
         """