Cancel Order

Cancel an order. (Filled orders cannot be canceled.)

POST /v1/portfolios/{portfolio_id}/orders/{order_id}/cancel

Cancel Order

cURL

curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/orders/{order_id}/cancel

200

{
  "id": "82c879c1-84e1-44ed-a8c2-1ac239cf09ad"
}

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

Java

OrdersService ordersService = PrimeServiceFactory.cancelOrdersService(client);

CancelOrderRequest request = new CancelOrderRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .orderId("ORDER_ID_HERE")
    .build());

CancelOrderResponse orderResponse = ordersService.cancelOrder(request);

For more information, please visit the Prime Java SDK.

.NET

var ordersService = new OrdersService(client);

var request = new CancelOrderRequest("PORTFOLIO_ID_HERE", "ORDER_ID_HERE");

var cancelOrderResponse = orderService.CancelOrder(request);

For more information, please visit the Prime .NET SDK.

Go

ordersService := orders.NewOrdersService(client)

request := &orders.CancelOrderRequest{
    PortfolioId: "PORTFOLIO_ID_HERE",
    OrderId: "ORDER_ID_HERE",
}

response, err := ordersService.CancelOrder(context.Background(), request)

For more information, please visit the Prime Go SDK.

Python

prime_client = PrimeClient(credentials)

request = CancelOrderRequest(
    portfolio_id="PORTFOLIO_ID_HERE",
    order_id="ORDER_ID_HERE",
)

response = prime_client.cancel_order(request)

For more information, please visit the Prime Python SDK.

CLI

primectl cancel-order --help

For more information, please visit the Prime CLI.

TS/JS

const ordersService = new OrdersService(client);

orderService.cancelOrder({
    portfolioId: 'PORTFOLIO_ID_HERE',
    orderId: 'ORDER_ID_HERE',
}).then(async (response) => {
    console.log('Order canceled: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

portfolio_id · string · required

The ID of the portfolio under which the order was placed

order_id · string · required

The order ID generated by Coinbase upon order submission

Response

200 - application/json

A successful response.

id · string

The unique UUID for the order

Example:

"82c879c1-84e1-44ed-a8c2-1ac239cf09ad"