List Open Orders

GET

portfolios

{portfolio_id}

open_orders

List Open Orders

curl --request GET \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/open_orders

{
  "orders": [
    {
      "id": "82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
      "user_id": "42",
      "portfolio_id": "3e1fe27e-26fe-46d8-b118-c752a2ae6b47",
      "product_id": "BTC-USD",
      "side": "BUY",
      "client_order_id": "f69a20b1-4ac4-420e-90b5-814a12565bfa",
      "type": "MARKET",
      "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",
      "status": "OPEN",
      "time_in_force": "GOOD_UNTIL_DATE_TIME",
      "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": "100",
          "size": "1",
          "display_size": "1.00",
          "stop_price": "120",
          "stop_limit_price": "120",
          "end_time": "2021-05-31T10:59:59.000Z",
          "accept_time": "2021-06-20T10:59:59.000Z"
        }
      ],
      "is_raise_exact": true,
      "display_size": "10.5"
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "sort_direction": "DESC",
    "has_next": true
  }
}

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

OrdersService ordersService = PrimeServiceFactory.createOrdersService(client);

ListOpenOrdersRequest request = new ListOpenOrdersRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .build();

ListOpenOrdersResponse response = ordersService.listOpenOrders(request);

For more information, please visit the Prime Java SDK.

OrdersService ordersService = PrimeServiceFactory.createOrdersService(client);

ListOpenOrdersRequest request = new ListOpenOrdersRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .build();

ListOpenOrdersResponse response = ordersService.listOpenOrders(request);

For more information, please visit the Prime Java SDK.

var ordersService = new OrdersService(client);

var request = new ListOpenOrdersRequest("PORTFOLIO_ID_HERE");

var response = ordersService.ListOpenOrders(request);

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

ordersService := orders.NewOrdersService(client)

request := &orders.ListOpenOrdersRequest{
    PortfolioId: "PORTFOLIO_ID_HERE",
}

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

For more information, please visit the Prime Go SDK.

prime_client = PrimeClient(credentials)

request = ListOpenOrdersRequest(
    portfolio_id="PORTFOLIO_ID_HERE",
)

response = prime_client.list_open_orders(request)

For more information, please visit the Prime Python SDK.

primectl list-open-orders --help

For more information, please visit the Prime CLI.

const ordersService = new OrdersService(client);

ordersService.listOpenOrders({
    portfolioId: 'PORTFOLIO_ID_HERE'
}).then(async (response) => {
    console.log('Orders: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

portfolio_id

string

required

Portfolio ID

Query Parameters

product_ids

string[]

List of products by which to filter the response

order_type

enum<string>

An order type by which to filter the response

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

Available options:

MARKET,

LIMIT,

TWAP,

BLOCK,

VWAP,

STOP_LIMIT,

RFQ

cursor

string

<b>Deprecated</b> - this endpoint always returns one page with at most 1000 orders. If you need to retrieve more than 1000 orders, use the WebSocket API instead.

limit

integer

<b>Deprecated</b> - the limit for this endpoint is always 1000. If you need to retrieve more than 1000 orders, use the WebSocket API instead.

sort_direction

enum<string>

default:DESC

Sorting order

Available options:

DESC,

ASC

start_date

string

A start date for the orders to be queried from

order_side

enum<string>

An order side to filter on.

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

Available options:

BUY,

SELL

end_date

string

An end date for the orders to be queried from

Response

200 - application/json

A successful response.

The response is of type object.

Get Order Preview

List Order Fills

List Open Orders

curl --request GET \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/open_orders

{
  "orders": [
    {
      "id": "82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
      "user_id": "42",
      "portfolio_id": "3e1fe27e-26fe-46d8-b118-c752a2ae6b47",
      "product_id": "BTC-USD",
      "side": "BUY",
      "client_order_id": "f69a20b1-4ac4-420e-90b5-814a12565bfa",
      "type": "MARKET",
      "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",
      "status": "OPEN",
      "time_in_force": "GOOD_UNTIL_DATE_TIME",
      "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": "100",
          "size": "1",
          "display_size": "1.00",
          "stop_price": "120",
          "stop_limit_price": "120",
          "end_time": "2021-05-31T10:59:59.000Z",
          "accept_time": "2021-06-20T10:59:59.000Z"
        }
      ],
      "is_raise_exact": true,
      "display_size": "10.5"
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "sort_direction": "DESC",
    "has_next": true
  }
}

REST API

FIX API

Websocket Feed

Path Parameters

Query Parameters

Response