Replace Order

Replace an order with a new one. Can be used to replace an order with a new margin, exchange, or derivative order.

📘

aff_code

API orders can now pass an affiliate code through which you can earn rebates. To learn more about these rebates and our affiliate program, please look at the relevant announcement and knowledge base article.

Response Details

KeyTypeDescription
order_id[int64]A randomly generated ID for the order and the information given by /order/status.

Ratelimit: 450 req/min

Form Data
int64
required

The order ID given by /order/new.

string

The name of the symbol (see /symbols).

string

Order size: how much to buy or sell.

string

Price to buy or sell at. May omit if a market order.

string

“bitfinex”

string

Either “buy” or “sell”.

string

Either “market” / “limit” / “stop” / “trailing-stop” / “fill-or-kill” / “exchange market” / “exchange limit” / “exchange stop” / “exchange trailing-stop” / “exchange fill-or-kill”. (type starting by “exchange ” are exchange orders, others are margin trading orders)

boolean
Defaults to false

true if the order should be hidden.

boolean
Defaults to false

true if the order should be post only. Only relevant for limit orders.

boolean
Defaults to false

True if the new order should use the remaining amount of the original order.

int32
Defaults to 10

Set the leverage for a derivative order, supported by derivative symbol orders only. The value should be between 1 and 100 inclusive. The field is optional, if omitted the default leverage value of 10 will be used.

string

Allows you to pass along an affiliate code with your API orders

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json