Get Order by Order ID

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

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);

For more information, please visit the Prime Java SDK.

Path Parameters

portfolio_id

string

required

Portfolio ID

order_id

string

required

Order ID

Response

200 - application/json

A successful response.

order

object

Show child attributes

order.id

string

The unique order ID generated by Coinbase

Example:

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

order.user_id

string

The ID of the user that created the order

Example:

"42"

order.portfolio_id

string

The ID of the portfolio that owns the order

Example:

"3e1fe27e-26fe-46d8-b118-c752a2ae6b47"

order.product_id

string

The ID of the product being traded by the order

Example:

"BTC-USD"

order.side

enum<string>

UNKNOWN_ORDER_SIDE: nil value
BUY: Buy order
SELL: Sell order

Available options:

BUY,

SELL

order.client_order_id

string

A client-generated order ID used for reference purposes (note: order will be rejected if this ID is not unique among all currently active orders)

Example:

"f69a20b1-4ac4-420e-90b5-814a12565bfa"

order.type

enum<string>

UNKNOWN_ORDER_TYPE: nil value
MARKET: A market order
LIMIT: A limit order
TWAP: A time-weighted average price order
BLOCK: A block trade
VWAP: A volume-weighted average price order
STOP_LIMIT: A conditional order combined of stop order and limit order
RFQ: A request for quote
PEG: A pegged order that dynamically adjust based on market conditions while maintaining execution discretion and avoiding adverse selection

Available options:

MARKET,

LIMIT,

TWAP,

BLOCK,

VWAP,

STOP_LIMIT,

RFQ,

PEG

order.base_quantity

string

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

Example:

"50"

order.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

Example:

"100"

order.limit_price

string

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

Example:

"50.12"

order.start_time

string<date-time>

The start time of the order in UTC (only applies to TWAP, VWAP orders.)

Example:

"2021-05-31T09:59:59.000Z"

order.expiry_time

string<date-time>

The expiry time of the order in UTC (applies to TWAP, VWAP, LIMIT, and STOP_LIMIT orders with time_in_force set to GTD)

Example:

"2021-05-31T10:59:59.000Z"

order.status

enum<string>

UNKNOWN_ORDER_STATUS: nil value
OPEN: The order is open but unfilled
FILLED: The order was filled
CANCELLED: The order was cancelled
EXPIRED: The order has expired
FAILED: Order submission failed
PENDING: The order has been sent but is not yet confirmed

Available options:

OPEN,

FILLED,

CANCELLED,

EXPIRED,

FAILED,

PENDING

order.time_in_force

enum<string>

UNKNOWN_TIME_IN_FORCE: nil value
GOOD_UNTIL_DATE_TIME: Expires at a certain date/time
GOOD_UNTIL_CANCELLED: Order stays on the books until cancelled
IMMEDIATE_OR_CANCEL: Order is executed immediately at submission or is cancelled
FILL_OR_KILL: Order is executed immediately and fully at submission or is cancelled

Available options:

GOOD_UNTIL_DATE_TIME,

GOOD_UNTIL_CANCELLED,

IMMEDIATE_OR_CANCEL,

FILL_OR_KILL

order.created_at

string<date-time>

The order creation time as a UTC timestamp

Example:

"2021-05-31T10:59:59.000Z"

order.filled_quantity

string

Size filled (in base asset units)

Example:

"100"

order.filled_value

string

Market value filled (in quote asset units)

Example:

"100"

order.average_filled_price

string

Indicates the average filled_price

Example:

"50.19"

order.commission

string

Total commission paid on this order (in quote asset units) -- only applicable for partially- or fully-filled orders

Example:

"4.99"

order.exchange_fee

string

Fee charged by the exchange for Cost Plus commission configurations. Exchange fee will be 0 for All In commission configurations.

Example:

"2.50"

order.historical_pov

string

historical pov for the order

Example:

"2.50"

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

Example:

"50.12"

order.net_average_filled_price

string

Indicates the average filled_price net of commissions and fees

Example:

"57.68"

order.user_context

string

Indicates a user friendly message for regarding various aspects of the order such as cancellation or rejection reasons

Example:

"User initiated cancellation"

order.client_product_id

string

The client product ID of the fill indictating the settlment currency

Example:

"BTC-USDC"

order.post_only

boolean

Post-only flag - indicates whether the order was placed as post-only

Example:

true

order.order_edit_history

LimitOrderEdit represents an order edit that is accepted · object[]

The history of order edits (deprecated: use edit_history instead)

Show child attributes

price

string

size

string

display_size

string

stop_price

string

stop_limit_price

string

end_time

string<date-time>

accept_time

string<date-time>

client_order_id

string

order.is_raise_exact

boolean

Indicates if this was a raise exact order (size inclusive of fees for sell orders in quote)

Example:

true

order.display_size

string

Display size for the order

Example:

"10.5"

order.edit_history

Order Edit History · object[]

The history of order edits

Show child attributes

price

string

base_quantity

string

quote_value

string

display_base_size

string

display_quote_size

string

stop_price

string

expiry_time

string<date-time>

accept_time

string<date-time>

client_order_id

string

Example:

[
  {
    "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"
  }
]

order.display_quote_size

string

The maximum order size that will show up on venue order books (in quote currency).

Example:

"100.50"

order.display_base_size

string

The maximum order size that will show up on venue order books (in base currency).

Example:

"10.5"

order.peg_offset_type

string

The peg offset type for PEG orders (PRICE, BASIS_POINTS, or CUMULATIVE_DEPTH_IN_BASE_UNITS)

Example:

"PEG_OFFSET_TYPE_PRICE"

order.offset

string

The offset value for PEG orders

Example:

"100"

order.wig_level

string

The wig (would if good) level for PEG orders - best price opposite to limit_price

Example:

"100000"

REST API

FIX API

Websocket Feed

Path Parameters

Response