Trades

The Trade is a sub-entity of SmartTrade. Each trade entity includes the conditions set for its specific trade type.

The Trade entity holds the following information about:

  • Order type ;

  • Trading pair; Trade status;

  • Initial and realized amounts;

  • Initial and realized total values;

  • Price values, including initial, average, and realized prices;

  • Position percentage for the trade;

  • Conditions related to trailing and triggers (e.g., trailing enabled, trigger price).

Each trade is created automatically by 3Commas based on the conditions set within the SmartTrade entity.

Depending on the conditions set within SmartTrade, a trade can be one of the following types:

  • Position trade;

  • Take profit trade;

  • Stop-loss trade;

  • Reduce funds trade;

  • Market close trade.

Here you will find a set of methods to manage these trades.

Attributes

id integer Unique 3Commas Trade entity ID

average_price null orstring The weighted average price at which the asset was bought or sold during the execution of the trades

follow_price_type string The type of price to follow for this trade (f.e. bid,ask or last)

initial_amount string The initial amount for this trade

initial_total string The initial total for this trade

initial_price number The initial price for this trade

order_price null or string The limit price for this trade

order_side string The side of the order to be created by this trade

Allowed value
  • Buy

  • Sell

order_type string The type of order used to open the position trade

Allowed value
  • Market

  • Limit

  • Conditional

pair string Trading pair in 3Commas format for this trade

position_percentage null or string Percentage of the step in Take Profit. This field is only filled if trade_purpose is take_profit

realised_amount string or null Indicates the realized amount from the trade

realised_total string or null Indicates the total realized amount from the trade

realised_percentage number Indicates the realized percentage of the total trade amount

realised_price number ornull Indicates the realized price of the trade

status string 3Commas status for this Trade

take_profit_percentage string or null The percentage price level for Take Profit for this Trade

trade_purpose string The type of trade

Show allowed values
  • position

  • take_profit

  • stop_loss

  • reduce_funds

trail_percentage string or null Indicates the percentage deviation from the price for this trade

trail_value string or null Indicates the deviation from the price calculated by 3Commas for this trade

trailing_enabled boolean Indicates whether the trailing settings for this trade can be edited

trailing_last_price string or null Indicates the last price used for trailing

trailing_last_price_updated_at number or null Indicates the timestamp of the last update to the trailing price

trigger_condition number or null Indicates the condition under which the trigger is activated

Show allowed values
  • greater

  • less

  • greater_or_equal

  • less_or_equal

trigger_price string or null Indicates the price at which the trigger is activated

trigger_price_percentage string or null Indicates the percentage for the trigger price

trigger_type string Indicates the type of trigger for the trade

created_at string ISO 8601 datetime string of when this Trade entity was created

updated_at string ISO 8601 datetime string of when this Trade entity was updated

cancelable boolean Indicates whether this trade can be canceled

force_processable boolean Indicates whether this Trade can be close by market

Last updated

Was this helpful?