Bingex.Swap.OrderInfo (Bingex v0.1.7)

Represents order information for a swap contract in BingX.

This module provides a structured representation of an order, including its type, status, risk management settings, and execution parameters.

Summary

Types

t()

Basic order information.

Types

t()

@type t() :: %Bingex.Swap.OrderInfo{
  activation_price: float(),
  client_order_id: binary(),
  close_position?: boolean(),
  order_id: binary(),
  position_side: Bingex.Order.position_side(),
  price: float(),
  price_rate: float(),
  quantity: float(),
  reduce_only?: boolean(),
  side: Bingex.Order.side(),
  stop_guaranteed?: boolean(),
  stop_loss: any(),
  stop_price: float(),
  symbol: binary(),
  take_profit: any(),
  time_in_force: any(),
  type: Bingex.Order.type(),
  working_type: Bingex.Order.working_type()
}

Basic order information.

Fields:

  • symbol (binary): Trading pair symbol (e.g., "BTC-USDT").
  • side (Order.side()): Buy/Sell direction of the order.
  • position_side (Order.position_side()): Position type (e.g., long, short).
  • price (float): Price at which the order was placed.
  • stop_price (float): Stop price for conditional orders.
  • working_type (Order.working_type()): Price type used for stop orders.
  • quantity (float): Order quantity.
  • type (Order.type()): Order type (e.g., market, limit).
  • order_id (binary): Unique identifier for the order.
  • client_order_id (binary): Custom client-provided order ID.
  • stop_loss (map | nil): Stop-loss details (if applicable).

  • take_profit (map | nil): Take-profit details (if applicable).

  • time_in_force (any): Order expiration setting.
  • reduce_only? (boolean): Whether the order reduces an existing position.
  • price_rate (float): Rate used for price calculations.
  • activation_price (float): Activation price for certain conditional orders.
  • close_position? (boolean): Whether the order closes an entire position.
  • stop_guaranteed? (boolean): Whether stop-loss is guaranteed.

Functions

decode(data)

@spec decode(map()) :: {:ok, t()} | :error