Create Order

Create Order

curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "<string>",
  "client_order_id": "<string>",
  "base_quantity": "<string>",
  "quote_value": "<string>",
  "limit_price": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "expiry_time": "2023-11-07T05:31:56Z",
  "stp_id": "<string>",
  "display_quote_size": "<string>",
  "display_base_size": "<string>",
  "is_raise_exact": true,
  "historical_pov": "<string>",
  "stop_price": "<string>",
  "settl_currency": "<string>",
  "post_only": true,
  "offset": "<string>",
  "wig_level": "<string>"
}
'

import requests

url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order"

payload = {
    "product_id": "<string>",
    "client_order_id": "<string>",
    "base_quantity": "<string>",
    "quote_value": "<string>",
    "limit_price": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "expiry_time": "2023-11-07T05:31:56Z",
    "stp_id": "<string>",
    "display_quote_size": "<string>",
    "display_base_size": "<string>",
    "is_raise_exact": True,
    "historical_pov": "<string>",
    "stop_price": "<string>",
    "settl_currency": "<string>",
    "post_only": True,
    "offset": "<string>",
    "wig_level": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    product_id: '<string>',
    client_order_id: '<string>',
    base_quantity: '<string>',
    quote_value: '<string>',
    limit_price: '<string>',
    start_time: '2023-11-07T05:31:56Z',
    expiry_time: '2023-11-07T05:31:56Z',
    stp_id: '<string>',
    display_quote_size: '<string>',
    display_base_size: '<string>',
    is_raise_exact: true,
    historical_pov: '<string>',
    stop_price: '<string>',
    settl_currency: '<string>',
    post_only: true,
    offset: '<string>',
    wig_level: '<string>'
  })
};

fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'product_id' => '<string>',
    'client_order_id' => '<string>',
    'base_quantity' => '<string>',
    'quote_value' => '<string>',
    'limit_price' => '<string>',
    'start_time' => '2023-11-07T05:31:56Z',
    'expiry_time' => '2023-11-07T05:31:56Z',
    'stp_id' => '<string>',
    'display_quote_size' => '<string>',
    'display_base_size' => '<string>',
    'is_raise_exact' => true,
    'historical_pov' => '<string>',
    'stop_price' => '<string>',
    'settl_currency' => '<string>',
    'post_only' => true,
    'offset' => '<string>',
    'wig_level' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order"

	payload := strings.NewReader("{\n  \"product_id\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"base_quantity\": \"<string>\",\n  \"quote_value\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"expiry_time\": \"2023-11-07T05:31:56Z\",\n  \"stp_id\": \"<string>\",\n  \"display_quote_size\": \"<string>\",\n  \"display_base_size\": \"<string>\",\n  \"is_raise_exact\": true,\n  \"historical_pov\": \"<string>\",\n  \"stop_price\": \"<string>\",\n  \"settl_currency\": \"<string>\",\n  \"post_only\": true,\n  \"offset\": \"<string>\",\n  \"wig_level\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"base_quantity\": \"<string>\",\n  \"quote_value\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"expiry_time\": \"2023-11-07T05:31:56Z\",\n  \"stp_id\": \"<string>\",\n  \"display_quote_size\": \"<string>\",\n  \"display_base_size\": \"<string>\",\n  \"is_raise_exact\": true,\n  \"historical_pov\": \"<string>\",\n  \"stop_price\": \"<string>\",\n  \"settl_currency\": \"<string>\",\n  \"post_only\": true,\n  \"offset\": \"<string>\",\n  \"wig_level\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"product_id\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"base_quantity\": \"<string>\",\n  \"quote_value\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"expiry_time\": \"2023-11-07T05:31:56Z\",\n  \"stp_id\": \"<string>\",\n  \"display_quote_size\": \"<string>\",\n  \"display_base_size\": \"<string>\",\n  \"is_raise_exact\": true,\n  \"historical_pov\": \"<string>\",\n  \"stop_price\": \"<string>\",\n  \"settl_currency\": \"<string>\",\n  \"post_only\": true,\n  \"offset\": \"<string>\",\n  \"wig_level\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "order_id": "ba0eb21c-672b-44de-8342-d6363cef87f0"
}

POST

portfolios

{portfolio_id}

order

Create Order

curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "<string>",
  "client_order_id": "<string>",
  "base_quantity": "<string>",
  "quote_value": "<string>",
  "limit_price": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "expiry_time": "2023-11-07T05:31:56Z",
  "stp_id": "<string>",
  "display_quote_size": "<string>",
  "display_base_size": "<string>",
  "is_raise_exact": true,
  "historical_pov": "<string>",
  "stop_price": "<string>",
  "settl_currency": "<string>",
  "post_only": true,
  "offset": "<string>",
  "wig_level": "<string>"
}
'

import requests

url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order"

payload = {
    "product_id": "<string>",
    "client_order_id": "<string>",
    "base_quantity": "<string>",
    "quote_value": "<string>",
    "limit_price": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "expiry_time": "2023-11-07T05:31:56Z",
    "stp_id": "<string>",
    "display_quote_size": "<string>",
    "display_base_size": "<string>",
    "is_raise_exact": True,
    "historical_pov": "<string>",
    "stop_price": "<string>",
    "settl_currency": "<string>",
    "post_only": True,
    "offset": "<string>",
    "wig_level": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    product_id: '<string>',
    client_order_id: '<string>',
    base_quantity: '<string>',
    quote_value: '<string>',
    limit_price: '<string>',
    start_time: '2023-11-07T05:31:56Z',
    expiry_time: '2023-11-07T05:31:56Z',
    stp_id: '<string>',
    display_quote_size: '<string>',
    display_base_size: '<string>',
    is_raise_exact: true,
    historical_pov: '<string>',
    stop_price: '<string>',
    settl_currency: '<string>',
    post_only: true,
    offset: '<string>',
    wig_level: '<string>'
  })
};

fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'product_id' => '<string>',
    'client_order_id' => '<string>',
    'base_quantity' => '<string>',
    'quote_value' => '<string>',
    'limit_price' => '<string>',
    'start_time' => '2023-11-07T05:31:56Z',
    'expiry_time' => '2023-11-07T05:31:56Z',
    'stp_id' => '<string>',
    'display_quote_size' => '<string>',
    'display_base_size' => '<string>',
    'is_raise_exact' => true,
    'historical_pov' => '<string>',
    'stop_price' => '<string>',
    'settl_currency' => '<string>',
    'post_only' => true,
    'offset' => '<string>',
    'wig_level' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order"

	payload := strings.NewReader("{\n  \"product_id\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"base_quantity\": \"<string>\",\n  \"quote_value\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"expiry_time\": \"2023-11-07T05:31:56Z\",\n  \"stp_id\": \"<string>\",\n  \"display_quote_size\": \"<string>\",\n  \"display_base_size\": \"<string>\",\n  \"is_raise_exact\": true,\n  \"historical_pov\": \"<string>\",\n  \"stop_price\": \"<string>\",\n  \"settl_currency\": \"<string>\",\n  \"post_only\": true,\n  \"offset\": \"<string>\",\n  \"wig_level\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"base_quantity\": \"<string>\",\n  \"quote_value\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"expiry_time\": \"2023-11-07T05:31:56Z\",\n  \"stp_id\": \"<string>\",\n  \"display_quote_size\": \"<string>\",\n  \"display_base_size\": \"<string>\",\n  \"is_raise_exact\": true,\n  \"historical_pov\": \"<string>\",\n  \"stop_price\": \"<string>\",\n  \"settl_currency\": \"<string>\",\n  \"post_only\": true,\n  \"offset\": \"<string>\",\n  \"wig_level\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"product_id\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"base_quantity\": \"<string>\",\n  \"quote_value\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"expiry_time\": \"2023-11-07T05:31:56Z\",\n  \"stp_id\": \"<string>\",\n  \"display_quote_size\": \"<string>\",\n  \"display_base_size\": \"<string>\",\n  \"is_raise_exact\": true,\n  \"historical_pov\": \"<string>\",\n  \"stop_price\": \"<string>\",\n  \"settl_currency\": \"<string>\",\n  \"post_only\": true,\n  \"offset\": \"<string>\",\n  \"wig_level\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "order_id": "ba0eb21c-672b-44de-8342-d6363cef87f0"
}

VWAP and TWAPVWAP and TWAP orders must have a minimum notional of $100/hr and also include these additional parameters: limit_price, start_time and expiry_time.

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

CreateOrderRequest request = new CreateOrderRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .productId("ADA-USD")
    .side(OrderSide.BUY)
    .type(OrderType.MARKET)
    .baseQuantity("10.0")
    .clientOrderId(UUID.randomUUID().toString())
    .build());
CreateOrderResponse orderResponse = ordersService.createOrder(request);

For more information, please visit the Prime Java SDK.

var ordersService = new OrdersService(client);

var request = new CreateOrderRequest("PORTFOLIO_ID_HERE")
{
    BaseQuantity = "5",
    LimitPrice = "0.32",
    Side = OrderSide.BUY,
    ProductId = "ADA-USD",
    Type = OrderType.LIMIT,
    ExpiryTime = new DateTimeOffset(DateTime.UtcNow.AddMinutes(5)).ToString("o"),
    ClientOrderId = Guid.NewGuid().ToString()
};

var createOrderResponse = orderService.CreateOrder(request);

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

ordersService := orders.NewOrdersService(client)

request := &orders.CreateOrderRequest{
    Order: &model.Order{
        PortfolioId:   "PORTFOLIO_ID_HERE",
        BaseQuantity:  "5",
        LimitPrice:    "0.32",
        Side:          "BUY",
        ProductId:     "ADA-USD",
        Type:          "LIMIT",
        ExpiryTime:    time.Now().UTC().Add(5 * time.Minute).Format(time.RFC3339),
        ClientOrderId: uuid.New().String(),
    },
}

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

For more information, please visit the Prime Go SDK.

prime_client = PrimeClient(credentials)

request = CreateOrderRequest(
    portfolio_id="PORTFOLIO_ID_HERE",
    base_quantity="5",
    limit_price="0.32",
    side="BUY",
    product_id="ADA-USD",
    type="LIMIT",
    expiry_time=(datetime.datetime.now() + datetime.timedelta(minutes=5)).isoformat() + "Z",
    client_order_id=str(uuid.uuid4()),
)

response = prime_client.create_order(request)

For more information, please visit the Prime Python SDK.

primectl create-order --help

For more information, please visit the Prime CLI.

const ordersService = new OrdersService(client);
const today = new Date();

ordersService.createOrder({
    portfolioId: "PORTFOLIO_ID_HERE",
    baseQuantity: "5",
    limitPrice: "0.32",
    side: OrderSide.BUY,
    productId: "ADA-USD",
    type: OrderType.LIMIT,
    expiryTime: date.setDate(date.getDate() + 1),
    clientOrderId: uuidv4()
}).then(async (response) => {
    console.log('Order: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

portfolio_id

string

required

The ID of the portfolio that owns the order

Body

application/json

product_id

string

required

side

enum<string>

required

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

Available options:

BUY,

SELL

client_order_id

string

required

type

enum<string>

required

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

base_quantity

string

quote_value

string

limit_price

string

start_time

string<date-time>

expiry_time

string<date-time>

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

stp_id

string

display_quote_size

string

Optionally specify a display size. This is 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. This property only applies to LIMIT orders and will be ignored for other order types.

display_base_size

string

is_raise_exact

boolean

historical_pov

string

stop_price

string

settl_currency

string

post_only

boolean

Post-only flag - when true, the order will only be posted to the order book and not immediately matched. Only applicable to LIMIT orders with GTC or GTD time in force.

peg_offset_type

enum<string>

UNKNOWN_PEG_OFFSET_TYPE: nil value
PEG_OFFSET_TYPE_PRICE: Offset specified in price units
PEG_OFFSET_TYPE_BPS: Offset specified in basis points (BPS)
PEG_OFFSET_TYPE_DEPTH: Offset specified in depth

Available options:

PEG_OFFSET_TYPE_PRICE,

PEG_OFFSET_TYPE_BPS,

PEG_OFFSET_TYPE_DEPTH

offset

string

wig_level

string

next: 23

Response

200 - application/json

A successful response.

order_id

string

The order ID generated by Coinbase

Example:

"ba0eb21c-672b-44de-8342-d6363cef87f0"

Cancel Order

Create Quote Request

⌘I

REST API

Websocket Feed

FIX 4.2 API

FIX 5.0 API

Path Parameters

Body

Response