Add Manual Safety Trade

Description: Creates a new additional safety manual trade entry

Permission: BOTS_WRITE Security: SIGNED

POST

/ver1/deals/{deal_id}/add_funds

Path Parameter

deal_id integer required Unique 3Commas ID Deal entity

Body Parameters

quantity number required Specifies the amount for the manual safety trade

is_market boolean required Indicates the type of order: true for a market order, false for a limit order

response_type string Defines the response format: empty;deal;market_order deal is using only for 1 pair bot. Default: empty

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

Response Parameters

Response format depends on choosing response_type:

empty

None

market_order

order_id string Unique 3Commas Trade entity ID

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

Allowed value

• Buy

• Sell

deal_order_type string The type of the order to be created by this trade

Allowed value

• Base

• Take profit

• Stop Loss

• Safety

• Manual Safety

cancellable boolean Indicates whether this trade can be canceled (true or not (false)

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

status_string string 3Commas status for this Trade

Allowed value

• Active - the trade is currently open, waiting to be filled

• Filled - the trade has been fully executed

• Finished - the trade process is complete

• Cancelled - the trade was canceled before it could be fully executed

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

quantity string Total quantity of the asset in this order

quantity_remaining string Remaining quantity of the asset left to be filled in this order

total string Total value of the order based on quantity and rate

rate string Price per unit of the asset in the order

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

deal

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

Example Request

POST /ver1/deals/2295672969/add_funds

Body:

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

Example Response and errors

Status: 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"
}

Status: 400 Bad request

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