Add manual safety trade

POST

/ver1/deals/:deal_id/add_funds

Permission: BOTS_WRITE

Security: SIGNED

Creates a new additional safety manual trade entry.

---

Path Parameter

deal_idintegerrequired

Unique 3Commas ID Deal entity.

Body Parameters

quantitynumberrequired

Specifies the amount for the manual safety trade.

is_marketbooleanrequired

Indicates the type of order: true for a market order, false for a limit order.

response_typestring

Defines the response format: deal; market_order; empty.

Value deal is using only for 1 pair bot.

default: empty

ratenumberrequired

Sets the rate for the safety order. Required if a limit order is used.

Example Request

POST

/ver1/deals/2295672969/add_funds

{
  "quantity": 0.01,
  "is_market": false,
  "response_type": "market_order",
  "rate": 0.2970
}

Response Parameters

Response format depends on choosing response_type:

market_order

order_idinteger

Unique 3Commas Trade entity ID.

order_typestring

The side of the order to be created by this trade: Buy or Sell.

deal_order_typestring

The type of the order to be created by this trade.

Hide allowed valuesShow allowed values

• Base;
• Take profit;
• Stop Loss;
• Safety;
• Manual Safety;

cancellableboolean

Indicates whether this trade can be canceled true or not false.

More attributes

status_stringstring

created_atstring

updated_atstring

quantitystring

quantity_remainingstring

totalstring

ratestring

average_pricestring

deal

If successful, the response includes an updated copy of the Deals entity.

empty

None

Example Responses

201 Created

{
  "order_id": "1110817001",
  "order_type": "SELL",
  "deal_order_type": "Manual Safety",
  "cancellable": true,
  "status_string": "Active",
  "created_at": "2024-11-11T16:46:59.479Z",
  "updated_at": "2024-11-11T16:46:59.479Z",
  "quantity": "0.0",
  "quantity_remaining": "0.0",
  "total": "0.0",
  "rate": "0.297",
  "average_price": "0.0"
}

400 Bad Request

{
  "error": "record_invalid",
  "error_description": "Invalid parameters",
  "error_attributes": {
    "rate": [
      "is missing"
    ]
  }
}