Get Order by Order ID
curl --request GET \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/orders/{order_id}{
"order": {
"id": "82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
"user_id": "42",
"portfolio_id": "3e1fe27e-26fe-46d8-b118-c752a2ae6b47",
"product_id": "BTC-USD",
"client_order_id": "f69a20b1-4ac4-420e-90b5-814a12565bfa",
"base_quantity": "50",
"quote_value": "100",
"limit_price": "50.12",
"start_time": "2021-05-31T09:59:59.000Z",
"expiry_time": "2021-05-31T10:59:59.000Z",
"created_at": "2021-05-31T10:59:59.000Z",
"filled_quantity": "100",
"filled_value": "100",
"average_filled_price": "50.19",
"commission": "4.99",
"exchange_fee": "2.50",
"historical_pov": "2.50",
"stop_price": "50.12",
"net_average_filled_price": "57.68",
"user_context": "User initiated cancellation",
"client_product_id": "BTC-USDC",
"post_only": true,
"order_edit_history": [
{
"price": "<string>",
"size": "<string>",
"display_size": "<string>",
"stop_price": "<string>",
"stop_limit_price": "<string>",
"end_time": "2023-11-07T05:31:56Z",
"accept_time": "2023-11-07T05:31:56Z",
"client_order_id": "<string>"
}
],
"is_raise_exact": true,
"display_size": "10.5",
"edit_history": [
{
"price": "100",
"base_quantity": "1",
"quote_value": "100",
"display_base_size": "1.00",
"display_quote_size": "1.00",
"stop_price": "120",
"expiry_time": "2021-05-31T10:59:59.000Z",
"accept_time": "2021-06-20T10:59:59.000Z",
"client_order_id": "123"
}
],
"display_quote_size": "100.50",
"display_base_size": "10.5",
"peg_offset_type": "PEG_OFFSET_TYPE_PRICE",
"offset": "100",
"wig_level": "100000",
"commission_detail_total": {
"total_commission": "<string>",
"client_commission": "<string>",
"venue_commission": "<string>",
"ces_commission": "<string>",
"financing_commission": "<string>",
"regulatory_commission": "<string>",
"clearing_commission": "<string>"
}
}
}Orders
Get Order by Order ID
Retrieve an order by order ID.
GET
/
v1
/
portfolios
/
{portfolio_id}
/
orders
/
{order_id}
Get Order by Order ID
curl --request GET \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/orders/{order_id}{
"order": {
"id": "82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
"user_id": "42",
"portfolio_id": "3e1fe27e-26fe-46d8-b118-c752a2ae6b47",
"product_id": "BTC-USD",
"client_order_id": "f69a20b1-4ac4-420e-90b5-814a12565bfa",
"base_quantity": "50",
"quote_value": "100",
"limit_price": "50.12",
"start_time": "2021-05-31T09:59:59.000Z",
"expiry_time": "2021-05-31T10:59:59.000Z",
"created_at": "2021-05-31T10:59:59.000Z",
"filled_quantity": "100",
"filled_value": "100",
"average_filled_price": "50.19",
"commission": "4.99",
"exchange_fee": "2.50",
"historical_pov": "2.50",
"stop_price": "50.12",
"net_average_filled_price": "57.68",
"user_context": "User initiated cancellation",
"client_product_id": "BTC-USDC",
"post_only": true,
"order_edit_history": [
{
"price": "<string>",
"size": "<string>",
"display_size": "<string>",
"stop_price": "<string>",
"stop_limit_price": "<string>",
"end_time": "2023-11-07T05:31:56Z",
"accept_time": "2023-11-07T05:31:56Z",
"client_order_id": "<string>"
}
],
"is_raise_exact": true,
"display_size": "10.5",
"edit_history": [
{
"price": "100",
"base_quantity": "1",
"quote_value": "100",
"display_base_size": "1.00",
"display_quote_size": "1.00",
"stop_price": "120",
"expiry_time": "2021-05-31T10:59:59.000Z",
"accept_time": "2021-06-20T10:59:59.000Z",
"client_order_id": "123"
}
],
"display_quote_size": "100.50",
"display_base_size": "10.5",
"peg_offset_type": "PEG_OFFSET_TYPE_PRICE",
"offset": "100",
"wig_level": "100000",
"commission_detail_total": {
"total_commission": "<string>",
"client_commission": "<string>",
"venue_commission": "<string>",
"ces_commission": "<string>",
"financing_commission": "<string>",
"regulatory_commission": "<string>",
"clearing_commission": "<string>"
}
}
}Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples
For more information, please visit the Prime Java SDK.For more information, please visit the Prime .NET SDK.For more information, please visit the Prime Go SDK.For more information, please visit the Prime Python SDK.For more information, please visit the Prime CLI.For more information, please visit the Prime TS SDK.
- Java
- .NET
- Go
- Python
- CLI
- TS/JS
OrdersService ordersService = PrimeServiceFactory.createOrdersService(client);
GetOrderByOrderIdRequest request = new GetOrderByOrderIdRequest.Builder()
.portfolioId("PORTFOLIO_ID_HERE")
.orderId("ORDER_ID_HERE")
.build();
GetOrderByOrderIdResponse response = ordersService.getOrderByOrderId(request);
var ordersService = new OrdersService(client);
var request = new GetOrderByOrderIdRequest("PORTFOLIO_ID_HERE", "ORDER_ID_HERE");
var response = ordersService.GetOrderByOrderId(request);
ordersService := orders.NewOrdersService(client)
request := &orders.GetOrderRequest{
PortfolioId: "PORTFOLIO_ID_HERE",
OrderId: "ORDER_ID_HERE",
}
response, err := ordersService.GetOrder(context.Background(), request)
prime_client = PrimeClient(credentials)
request = GetOrderRequest(
portfolio_id="PORTFOLIO_ID_HERE",
order_id="ORDER_ID_HERE",
)
response = prime_client.get_order(request)
primectl get-order --help
const ordersService = new OrdersService(client);
ordersService.getOrder({
portfolioId: 'PORTFOLIO_ID_HERE',
orderId: 'ORDER_ID_HERE'
}).then(async (response) => {
console.log('Order: ', response);
})
Was this page helpful?
⌘I