curl --request POST \
--url https://api.coinbase.com/api/v3/brokerage/orders/preview \
--header 'Content-Type: application/json' \
--data '{
"product_id": "<string>",
"side": "<any>",
"order_configuration": {
"market_market_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"rfq_disabled": true
},
"sor_limit_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"rfq_disabled": true
},
"limit_limit_gtc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"rfq_disabled": true
},
"limit_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"end_time": "2021-05-31T09:59:59.000Z",
"post_only": false
},
"limit_limit_fok": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"rfq_disabled": true
},
"twap_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"start_time": "2021-05-31T07:59:59.000Z",
"end_time": "2021-05-31T09:59:59.000Z",
"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": "<any>"
},
"stop_limit_stop_limit_gtd": {
"base_size": "0.001",
"limit_price": "10000.00",
"stop_price": "20000.00",
"end_time": "2021-05-31T09:59:59.000Z",
"stop_direction": "<any>"
},
"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:59.000Z"
}
},
"leverage": "2.0",
"margin_type": "<any>",
"retail_portfolio_id": "11111111-1111-1111-1111-111111111111",
"attached_order_configuration": {
"market_market_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"rfq_disabled": true
},
"sor_limit_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"rfq_disabled": true
},
"limit_limit_gtc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"rfq_disabled": true
},
"limit_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"end_time": "2021-05-31T09:59:59.000Z",
"post_only": false
},
"limit_limit_fok": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"rfq_disabled": true
},
"twap_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"start_time": "2021-05-31T07:59:59.000Z",
"end_time": "2021-05-31T09:59:59.000Z",
"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": "<any>"
},
"stop_limit_stop_limit_gtd": {
"base_size": "0.001",
"limit_price": "10000.00",
"stop_price": "20000.00",
"end_time": "2021-05-31T09:59:59.000Z",
"stop_direction": "<any>"
},
"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:59.000Z"
}
}
}'
{
"order_total": "<string>",
"commission_total": "<string>",
"errs": [
"UNKNOWN_PREVIEW_FAILURE_REASON"
],
"warning": [
"UNKNOWN"
],
"quote_size": "10",
"base_size": "0.001",
"best_bid": "<string>",
"best_ask": "<string>",
"is_max": true,
"order_margin_total": "<string>",
"leverage": "2.0",
"long_leverage": "<string>",
"short_leverage": "<string>",
"slippage": "<string>",
"preview_id": "<string>",
"current_liquidation_buffer": "<string>",
"projected_liquidation_buffer": "<string>",
"max_leverage": "<string>",
"pnl_configuration": {
"trigger_bracket_pnl": {
"take_profit_pnl": "<string>",
"stop_loss_pnl": "<string>"
}
},
"twap_bucket_metadata": {
"bucket_duration": "<string>",
"bucket_size": "<string>",
"number_buckets": "<string>"
},
"position_notional_limit": "<string>"
}
Preview an order.
curl --request POST \
--url https://api.coinbase.com/api/v3/brokerage/orders/preview \
--header 'Content-Type: application/json' \
--data '{
"product_id": "<string>",
"side": "<any>",
"order_configuration": {
"market_market_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"rfq_disabled": true
},
"sor_limit_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"rfq_disabled": true
},
"limit_limit_gtc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"rfq_disabled": true
},
"limit_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"end_time": "2021-05-31T09:59:59.000Z",
"post_only": false
},
"limit_limit_fok": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"rfq_disabled": true
},
"twap_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"start_time": "2021-05-31T07:59:59.000Z",
"end_time": "2021-05-31T09:59:59.000Z",
"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": "<any>"
},
"stop_limit_stop_limit_gtd": {
"base_size": "0.001",
"limit_price": "10000.00",
"stop_price": "20000.00",
"end_time": "2021-05-31T09:59:59.000Z",
"stop_direction": "<any>"
},
"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:59.000Z"
}
},
"leverage": "2.0",
"margin_type": "<any>",
"retail_portfolio_id": "11111111-1111-1111-1111-111111111111",
"attached_order_configuration": {
"market_market_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"rfq_disabled": true
},
"sor_limit_ioc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"rfq_disabled": true
},
"limit_limit_gtc": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"post_only": false,
"rfq_disabled": true
},
"limit_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"end_time": "2021-05-31T09:59:59.000Z",
"post_only": false
},
"limit_limit_fok": {
"quote_size": "10.00",
"base_size": "0.001",
"limit_price": "10000.00",
"rfq_disabled": true
},
"twap_limit_gtd": {
"quote_size": "10.00",
"base_size": "0.001",
"start_time": "2021-05-31T07:59:59.000Z",
"end_time": "2021-05-31T09:59:59.000Z",
"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": "<any>"
},
"stop_limit_stop_limit_gtd": {
"base_size": "0.001",
"limit_price": "10000.00",
"stop_price": "20000.00",
"end_time": "2021-05-31T09:59:59.000Z",
"stop_direction": "<any>"
},
"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:59.000Z"
}
}
}'
{
"order_total": "<string>",
"commission_total": "<string>",
"errs": [
"UNKNOWN_PREVIEW_FAILURE_REASON"
],
"warning": [
"UNKNOWN"
],
"quote_size": "10",
"base_size": "0.001",
"best_bid": "<string>",
"best_ask": "<string>",
"is_max": true,
"order_margin_total": "<string>",
"leverage": "2.0",
"long_leverage": "<string>",
"short_leverage": "<string>",
"slippage": "<string>",
"preview_id": "<string>",
"current_liquidation_buffer": "<string>",
"projected_liquidation_buffer": "<string>",
"max_leverage": "<string>",
"pnl_configuration": {
"trigger_bracket_pnl": {
"take_profit_pnl": "<string>",
"stop_loss_pnl": "<string>"
}
},
"twap_bucket_metadata": {
"bucket_duration": "<string>",
"bucket_size": "<string>",
"number_buckets": "<string>"
},
"position_notional_limit": "<string>"
}
A successful response.
The response is of type object
.
Was this page helpful?