Standard Futures Models

This section documents the data models used in the Standard Futures module.

class bingx_py.models.standard.HistoricalOrderItem(*, avgPrice=None, cumQuote=None, executedQty=None, orderId=None, positionSide, status, symbol, time, updateTime, margin=None, leverage=None, isolated=None, closePrice=None, positionId)[source]

Bases: BaseModel

Model for historical order item.

Args: - avg_price (Optional[float]): Closing price. - cum_quote (Optional[float]): Transaction amount. - executed_qty (Optional[float]): Turnover. - order_id (Optional[int]): System order number. - position_side (str): Position direction, LONG and SHORT. - status (str): Order Status CLOSED. - symbol (str): Currency pair, the format is similar to: BTC-USDT. - time (int): Order time. - update_time (int): Update time. - margin (Optional[float]): Margin. - leverage (Optional[float]): Leverage. - isolated (Optional[bool]): Whether it is isolated margin mode. - close_price (Optional[float]): Closing price. - position_id (int): Position order number.

Parameters:

  • avgPrice (float | None)

  • cumQuote (float | None)

  • executedQty (float | None)

  • orderId (int | None)

  • positionSide (str)

  • status (str)

  • symbol (str)

  • time (int)

  • updateTime (int)

  • margin (float | None)

  • leverage (float | None)

  • isolated (bool | None)

  • closePrice (float | None)

  • positionId (int)

avg_price: float | None
close_price: float | None
cum_quote: float | None
executed_qty: float | None
isolated: bool | None
leverage: float | None
margin: float | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order_id: int | None
position_id: int
position_side: str
status: str
symbol: str
time: int
update_time: int
class bingx_py.models.standard.HistoricalOrderResponse(*, code, timestamp, data)[source]

Bases: BaseModel

Model for the response of Historical Order.

Args: - code (int): Error code, 0 means successful response, others mean response failure. - timestamp (int): Response timestamp. - data (List[HistoricalOrderItem]): Response data.

Parameters:
code: int
data: list[HistoricalOrderItem]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp: int
class bingx_py.models.standard.PositionItem(*, symbol, initialMargin=None, leverage=None, unrealizedProfit=None, isolated=None, entryPrice=None, positionSide=None, positionAmt=None, currentPrice=None, time)[source]

Bases: BaseModel

Model for position data.

Parameters:

  • symbol (str) – Trading pair.

  • initial_margin (Optional[float]) – Margin.

  • leverage (Optional[float]) – Leverage.

  • unrealized_profit (Optional[float]) – Position unrealized profit and loss.

  • isolated (Optional[bool]) – Whether it is isolated margin mode.

  • entry_price (Optional[float]) – Holding cost price.

  • position_side (Optional[float]) – Position direction, LONG and SHORT.

  • position_amt (Optional[float]) – Transaction data.

  • current_price (Optional[float]) – Current price. When there is no closing price, the current price will be returned.

  • time (int) – Opening time.

  • initialMargin (float | None)

  • unrealizedProfit (float | None)

  • entryPrice (float | None)

  • positionSide (float | None)

  • positionAmt (float | None)

  • currentPrice (float | None)

current_price: float | None
entry_price: float | None
initial_margin: float | None
isolated: bool | None
leverage: float | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

position_amt: float | None
position_side: float | None
symbol: str
time: int
unrealized_profit: float | None
class bingx_py.models.standard.PositionsResponse(*, code, timestamp, data)[source]

Bases: BaseModel

Model for the response of Query Invited Users.

Args: - code (int): Error code, 0 means successful response, others mean response failure. - timestamp (int): Response timestamp. - data (List[PositionItem]): Response data.

Parameters:
code: int
data: list[PositionItem]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp: int
class bingx_py.models.standard.StandardContractBalanceItem(*, asset, balance, crossWalletBalance, crossUnPnl, availableBalance, maxWithdrawAmount, marginAvailable=None, updateTime=None)[source]

Bases: BaseModel

Model for standard contract balance item.

Args: - asset (str): Assets. - balance (str): Total balance. - cross_wallet_balance (str): Cross position balance. - cross_un_pnl (str): Unrealized profit and loss of cross positions. - available_balance (str): Order available balance. - max_withdraw_amount (str): Maximum transferable balance. - margin_available (Optional[bool]): Can it be used as a joint bond. - update_time (Optional[float]): Timestamp.

Parameters:

  • asset (str)

  • balance (str)

  • crossWalletBalance (str)

  • crossUnPnl (str)

  • availableBalance (str)

  • maxWithdrawAmount (str)

  • marginAvailable (bool | None)

  • updateTime (float | None)

asset: str
available_balance: str
balance: str
cross_un_pnl: str
cross_wallet_balance: str
margin_available: bool | None
max_withdraw_amount: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

update_time: float | None
class bingx_py.models.standard.StandardContractBalanceResponse(*, code, timestamp, data)[source]

Bases: BaseModel

Model for the response of Historical Order.

Args: - code (int): Error code, 0 means successful response, others mean response failure. - timestamp (int): Response timestamp. - data (List[StandardContractBalanceItem]): Response data.

Parameters:
code: int
data: list[StandardContractBalanceItem]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp: int