Skip to main content
PUT
/
v1
/
portfolios
/
{portfolio_id}
/
orders
/
{order_id}
/
edit
Edit Order (Beta)
curl --request PUT \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/orders/{order_id}/edit \
  --header 'Content-Type: application/json' \
  --data '
{
  "orig_client_order_id": "<string>",
  "client_order_id": "<string>",
  "product_id": "<string>",
  "base_quantity": "<string>",
  "quote_value": "<string>",
  "limit_price": "<string>",
  "expiry_time": "2023-11-07T05:31:56Z",
  "display_quote_size": "<string>",
  "display_base_size": "<string>",
  "stop_price": "<string>",
  "offset": "<string>",
  "wig_level": "<string>"
}
'
{
  "order_id": "<string>"
}

Path Parameters

​
portfolio_id
string
required

The ID of the portfolio that owns the order

​
order_id
string
required

The ID of the order being edited

Body

application/json
​
orig_client_order_id
string
required

The client order ID of the order being edited

​
client_order_id
string
required

The updated version of the client order ID

​
product_id
string

Deprecated: The product ID of the order being edited

​
base_quantity
string

Order size in base asset units (either base_quantity or quote_value is required)

​
quote_value
string

Order size in quote asset units, i.e. the amount the user wants to spend (when buying) or receive (when selling); the quantity in base units will be determined based on the market liquidity and indicated quote_value (either base_quantity or quote_value is required)

​
limit_price
string

The limit price (required for TWAP, VWAP, LIMIT, and STOP_LIMIT orders)

​
expiry_time
string<date-time>

The expiry time of the order in UTC (TWAP, VWAP, LIMIT, and STOP_LIMIT GTD only)

​
display_quote_size
string

The maximum order size that will show up on venue order books. Specifying a value here effectively makes a LIMIT order into an "iceberg" style order.

​
display_base_size
string

The maximum order size that will show up on venue order books. Specifying a value here effectively makes a LIMIT order into an "iceberg" style order.

​
stop_price
string

Specifies the stop price at which the order activates. The order is activated if the last trade price on Coinbase Exchange crosses the stop price specified on the order

​
offset
string

New peg offset value for PEG orders. 0 means peg to BBO. Only non-negative values are allowed. The order's peg_offset_type is immutable and is reused server-side to interpret this value (PEG orders only)

​
wig_level
string

New WIG (Would if Good) level for PEG orders - the best price a pegged order would be placed on venues, opposite to limit_price. Cannot be added or removed post-placement (PEG orders only)

Response

200 - application/json

A successful response.

​
order_id
string

The ID of the order being edited