Get Order
curl --request GET \
--url https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}', 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.coinbase.com/api/v3/brokerage/orders/historical/{order_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"order": {
"order_id": "0000-000000-000000",
"product_id": "BTC-USD",
"user_id": "2222-000000-000000",
"order_configuration": {
"market_market_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"market_market_fok": {
"quote_size": "10.00",
"base_size": "0.001"
},
"sor_limit_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00"
},
"limit_limit_gtc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"limit_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"end_time": "2021-05-31T09:59:59Z",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"limit_limit_fok": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00"
},
"twap_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"start_time": "2021-05-31T07:59:59Z",
"end_time": "2021-05-31T09:59:59Z",
"limit_price": "10000.00",
"number_buckets": "5",
"bucket_size": "2.00",
"bucket_duration": "300s"
},
"stop_limit_stop_limit_gtc": {
"base_size": "0.001",
"limit_price": "10000.00",
"stop_price": "20000.00",
"stop_direction": "20000.00"
},
"stop_limit_stop_limit_gtd": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_price": "20000.00",
"end_time": "2021-05-31T09:59:59Z",
"stop_direction": "20000.00"
},
"trigger_bracket_gtc": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_trigger_price": "20000.00"
},
"trigger_bracket_gtd": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_trigger_price": "20000.00",
"end_time": "2021-05-31T09:59:59Z"
},
"scaled_limit_gtc": {
"orders": [
{
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
}
],
"quote_size": "<string>",
"base_size": "<string>",
"num_orders": 123,
"min_price": "<string>",
"max_price": "<string>",
"price_distribution": "FLAT",
"size_distribution": "UNKNOWN_DISTRIBUTION",
"size_diff": "<string>",
"size_ratio": "<string>"
}
},
"side": "",
"client_order_id": "11111-000000-000000",
"status": "PENDING",
"created_time": "2021-05-31T09:59:59Z",
"completion_percentage": "50",
"average_filled_price": "50",
"number_of_fills": "2",
"pending_cancel": true,
"size_in_quote": false,
"total_fees": "5.00",
"size_inclusive_of_fees": false,
"total_value_after_fees": "<string>",
"time_in_force": "UNKNOWN_TIME_IN_FORCE",
"filled_size": "0.001",
"fee": "<string>",
"filled_value": "10000",
"trigger_status": "UNKNOWN_TRIGGER_STATUS",
"order_type": "UNKNOWN_ORDER_TYPE",
"reject_reason": "REJECT_REASON_UNSPECIFIED",
"settled": true,
"product_type": "UNKNOWN_PRODUCT_TYPE",
"reject_message": "<string>",
"cancel_message": "<string>",
"order_placement_source": "UNKNOWN_PLACEMENT_SOURCE",
"outstanding_hold_amount": "<string>",
"is_liquidation": true,
"last_fill_time": "<string>",
"edit_history": [
{
"price": "19000.00",
"size": "0.001",
"replace_accept_timestamp": "<string>"
}
],
"leverage": "<string>",
"margin_type": "",
"retail_portfolio_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca",
"originating_order_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca",
"attached_order_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca",
"attached_order_configuration": {
"market_market_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"market_market_fok": {
"quote_size": "10.00",
"base_size": "0.001"
},
"sor_limit_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00"
},
"limit_limit_gtc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"limit_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"end_time": "2021-05-31T09:59:59Z",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"limit_limit_fok": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00"
},
"twap_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"start_time": "2021-05-31T07:59:59Z",
"end_time": "2021-05-31T09:59:59Z",
"limit_price": "10000.00",
"number_buckets": "5",
"bucket_size": "2.00",
"bucket_duration": "300s"
},
"stop_limit_stop_limit_gtc": {
"base_size": "0.001",
"limit_price": "10000.00",
"stop_price": "20000.00",
"stop_direction": "20000.00"
},
"stop_limit_stop_limit_gtd": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_price": "20000.00",
"end_time": "2021-05-31T09:59:59Z",
"stop_direction": "20000.00"
},
"trigger_bracket_gtc": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_trigger_price": "20000.00"
},
"trigger_bracket_gtd": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_trigger_price": "20000.00",
"end_time": "2021-05-31T09:59:59Z"
},
"scaled_limit_gtc": {
"orders": [
{
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
}
],
"quote_size": "<string>",
"base_size": "<string>",
"num_orders": 123,
"min_price": "<string>",
"max_price": "<string>",
"price_distribution": "FLAT",
"size_distribution": "UNKNOWN_DISTRIBUTION",
"size_diff": "<string>",
"size_ratio": "<string>"
}
},
"current_pending_replace": {
"price": "19000.00",
"size": "0.001",
"replace_accept_timestamp": "<string>"
},
"commission_detail_total": {
"total_commission": "<string>",
"gst_commission": "<string>",
"withholding_commission": "<string>",
"client_commission": "<string>",
"venue_commission": "<string>",
"regulatory_commission": "<string>",
"clearing_commission": "<string>"
},
"workable_size": "3",
"workable_size_completion_pct": "50",
"product_details": {
"equity_details": {
"base_cbrn": "<string>",
"ticker": "<string>",
"quote_id": "<string>"
}
},
"cost_basis_method": "COST_BASIS_METHOD_UNSPECIFIED",
"displayed_order_config": "UNKNOWN_DISPLAYED_ORDER_CONFIG",
"equity_trading_session": "UNKNOWN_EQUITY_TRADING_SESSION",
"prediction_side": "PREDICTION_SIDE_UNKNOWN",
"last_update_time": "<string>",
"total_value_after_fees_native": {
"value": "1.23",
"currency": "BTC"
},
"outstanding_hold_amount_native": {
"value": "1.23",
"currency": "BTC"
},
"total_fees_native": {
"value": "1.23",
"currency": "BTC"
}
}
}{
"error": "<string>",
"code": 123,
"message": "<string>",
"details": [
{}
]
}Orders
Get Order
Get a single order by order ID.
Equities: The response identifies equity orders with product_type: EQUITY. Use displayed_order_config for the equity time in force and equity_trading_session for the session in which the order is eligible to execute.
GET
/
api
/
v3
/
brokerage
/
orders
/
historical
/
{order_id}
Get Order
curl --request GET \
--url https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}', 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.coinbase.com/api/v3/brokerage/orders/historical/{order_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coinbase.com/api/v3/brokerage/orders/historical/{order_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"order": {
"order_id": "0000-000000-000000",
"product_id": "BTC-USD",
"user_id": "2222-000000-000000",
"order_configuration": {
"market_market_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"market_market_fok": {
"quote_size": "10.00",
"base_size": "0.001"
},
"sor_limit_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00"
},
"limit_limit_gtc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"limit_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"end_time": "2021-05-31T09:59:59Z",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"limit_limit_fok": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00"
},
"twap_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"start_time": "2021-05-31T07:59:59Z",
"end_time": "2021-05-31T09:59:59Z",
"limit_price": "10000.00",
"number_buckets": "5",
"bucket_size": "2.00",
"bucket_duration": "300s"
},
"stop_limit_stop_limit_gtc": {
"base_size": "0.001",
"limit_price": "10000.00",
"stop_price": "20000.00",
"stop_direction": "20000.00"
},
"stop_limit_stop_limit_gtd": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_price": "20000.00",
"end_time": "2021-05-31T09:59:59Z",
"stop_direction": "20000.00"
},
"trigger_bracket_gtc": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_trigger_price": "20000.00"
},
"trigger_bracket_gtd": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_trigger_price": "20000.00",
"end_time": "2021-05-31T09:59:59Z"
},
"scaled_limit_gtc": {
"orders": [
{
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
}
],
"quote_size": "<string>",
"base_size": "<string>",
"num_orders": 123,
"min_price": "<string>",
"max_price": "<string>",
"price_distribution": "FLAT",
"size_distribution": "UNKNOWN_DISTRIBUTION",
"size_diff": "<string>",
"size_ratio": "<string>"
}
},
"side": "",
"client_order_id": "11111-000000-000000",
"status": "PENDING",
"created_time": "2021-05-31T09:59:59Z",
"completion_percentage": "50",
"average_filled_price": "50",
"number_of_fills": "2",
"pending_cancel": true,
"size_in_quote": false,
"total_fees": "5.00",
"size_inclusive_of_fees": false,
"total_value_after_fees": "<string>",
"time_in_force": "UNKNOWN_TIME_IN_FORCE",
"filled_size": "0.001",
"fee": "<string>",
"filled_value": "10000",
"trigger_status": "UNKNOWN_TRIGGER_STATUS",
"order_type": "UNKNOWN_ORDER_TYPE",
"reject_reason": "REJECT_REASON_UNSPECIFIED",
"settled": true,
"product_type": "UNKNOWN_PRODUCT_TYPE",
"reject_message": "<string>",
"cancel_message": "<string>",
"order_placement_source": "UNKNOWN_PLACEMENT_SOURCE",
"outstanding_hold_amount": "<string>",
"is_liquidation": true,
"last_fill_time": "<string>",
"edit_history": [
{
"price": "19000.00",
"size": "0.001",
"replace_accept_timestamp": "<string>"
}
],
"leverage": "<string>",
"margin_type": "",
"retail_portfolio_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca",
"originating_order_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca",
"attached_order_id": "b87a2d3f-8a1e-49b3-a4ea-402d8c389aca",
"attached_order_configuration": {
"market_market_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"market_market_fok": {
"quote_size": "10.00",
"base_size": "0.001"
},
"sor_limit_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00"
},
"limit_limit_gtc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"limit_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"end_time": "2021-05-31T09:59:59Z",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
},
"limit_limit_fok": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00"
},
"twap_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"start_time": "2021-05-31T07:59:59Z",
"end_time": "2021-05-31T09:59:59Z",
"limit_price": "10000.00",
"number_buckets": "5",
"bucket_size": "2.00",
"bucket_duration": "300s"
},
"stop_limit_stop_limit_gtc": {
"base_size": "0.001",
"limit_price": "10000.00",
"stop_price": "20000.00",
"stop_direction": "20000.00"
},
"stop_limit_stop_limit_gtd": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_price": "20000.00",
"end_time": "2021-05-31T09:59:59Z",
"stop_direction": "20000.00"
},
"trigger_bracket_gtc": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_trigger_price": "20000.00"
},
"trigger_bracket_gtd": {
"base_size": 0.001,
"limit_price": "10000.00",
"stop_trigger_price": "20000.00",
"end_time": "2021-05-31T09:59:59Z"
},
"scaled_limit_gtc": {
"orders": [
{
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"currency_size": {
"value": "1.23",
"currency": "BTC"
}
}
],
"quote_size": "<string>",
"base_size": "<string>",
"num_orders": 123,
"min_price": "<string>",
"max_price": "<string>",
"price_distribution": "FLAT",
"size_distribution": "UNKNOWN_DISTRIBUTION",
"size_diff": "<string>",
"size_ratio": "<string>"
}
},
"current_pending_replace": {
"price": "19000.00",
"size": "0.001",
"replace_accept_timestamp": "<string>"
},
"commission_detail_total": {
"total_commission": "<string>",
"gst_commission": "<string>",
"withholding_commission": "<string>",
"client_commission": "<string>",
"venue_commission": "<string>",
"regulatory_commission": "<string>",
"clearing_commission": "<string>"
},
"workable_size": "3",
"workable_size_completion_pct": "50",
"product_details": {
"equity_details": {
"base_cbrn": "<string>",
"ticker": "<string>",
"quote_id": "<string>"
}
},
"cost_basis_method": "COST_BASIS_METHOD_UNSPECIFIED",
"displayed_order_config": "UNKNOWN_DISPLAYED_ORDER_CONFIG",
"equity_trading_session": "UNKNOWN_EQUITY_TRADING_SESSION",
"prediction_side": "PREDICTION_SIDE_UNKNOWN",
"last_update_time": "<string>",
"total_value_after_fees_native": {
"value": "1.23",
"currency": "BTC"
},
"outstanding_hold_amount_native": {
"value": "1.23",
"currency": "BTC"
},
"total_fees_native": {
"value": "1.23",
"currency": "BTC"
}
}
}{
"error": "<string>",
"code": 123,
"message": "<string>",
"details": [
{}
]
}Authorizations
ApiKeyOAuth2
A bearer token signed using your API Key Secret, see Creating API Keys section of our docs for more information. See Scope & Permissions for the permission each endpoint requires.
Path Parameters
The ID of the order.
Query Parameters
(Deprecated) Client Order ID to fetch the order with.
(Deprecated) Native currency to fetch order with. Default is USD.
Response
A successful response.
The retrieved order.
Show child attributes
Show child attributes
Was this page helpful?