Preview Order - Coinbase Developer Documentation

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Creating API Keys section of our Coinbase App Authentication docs for information on how to generate your Bearer Token.

Body

application/json

product_id

string

required

The trading pair (e.g. 'BTC-USD').

side

enum<string>

default:""

required

The side of the market that the order is on (e.g. 'BUY', 'SELL').

Available options:

BUY,

SELL

order_configuration

object

required

The configuration of the order (e.g. the order type, size, etc).

Show child attributes

order_configuration.market_market_ioc

Order entry configurations · object

Buy or sell a specified quantity of an Asset at the current best available market price. Read more on Market Orders

Show child attributes

order_configuration.market_market_ioc.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

order_configuration.market_market_ioc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

order_configuration.market_market_fok

object

Buy or sell a specified quantity of an Asset at the current best available market price. The Order will only post to the Order Book if it is to immediately and completely Fill. Read more on Market Orders

Show child attributes

order_configuration.market_market_fok.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

order_configuration.market_market_fok.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

order_configuration.sor_limit_ioc

object

Buy or sell a specified quantity of an Asset at a specified price. The Order will only post to the Order Book if it will immediately Fill; any remaining quantity is canceled. Read more on Limit Orders.

Show child attributes

order_configuration.sor_limit_ioc.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

order_configuration.sor_limit_ioc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

order_configuration.sor_limit_ioc.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.limit_limit_gtc

object

Buy or sell a specified quantity of an Asset at a specified price. If posted, the Order will remain on the Order Book until canceled. Read more on Limit Orders.

Show child attributes

order_configuration.limit_limit_gtc.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

order_configuration.limit_limit_gtc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

order_configuration.limit_limit_gtc.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.limit_limit_gtc.post_only

boolean

Enable or disable Post-only Mode. When enabled, only Maker Orders will be posted to the Order Book. Orders that will be posted as a Taker Order will be rejected.

Example:

false

order_configuration.limit_limit_gtd

object

Buy or sell a specified quantity of an Asset at a specified price. If posted, the Order will remain on the Order Book until a certain time is reached or the Order is canceled. Read more on Limit Orders.

Show child attributes

order_configuration.limit_limit_gtd.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

order_configuration.limit_limit_gtd.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

order_configuration.limit_limit_gtd.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.limit_limit_gtd.end_time

string<RFC3339 Timestamp>

The time at which the order will be cancelled if it is not Filled.

Example:

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

order_configuration.limit_limit_gtd.post_only

boolean

Enable or disable Post-only Mode. When enabled, only Maker Orders will be posted to the Order Book. Orders that will be posted as a Taker Order will be rejected.

Example:

false

order_configuration.limit_limit_fok

object

Buy or sell a specified quantity of an Asset at a specified price. The Order will only post to the Order Book if it is to immediately and completely Fill. Read more on Limit Orders.

Show child attributes

order_configuration.limit_limit_fok.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

order_configuration.limit_limit_fok.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

order_configuration.limit_limit_fok.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.twap_limit_gtd

object

A time-weighted average price (TWAP) order type that calculates the average price of a product to programmatically execute an order over a specified duration.

Show child attributes

order_configuration.twap_limit_gtd.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

order_configuration.twap_limit_gtd.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

order_configuration.twap_limit_gtd.start_time

string<RFC3339 Timestamp>

Time at which the order should begin executing.

Example:

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

order_configuration.twap_limit_gtd.end_time

string<RFC3339 Timestamp>

The time at which the order will be cancelled if it is not Filled.

Example:

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

order_configuration.twap_limit_gtd.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.twap_limit_gtd.number_buckets

string

The number of smaller buckets/suborders over which the entire order will be broken into. Each suborder will be executed over a duration calculated based on the end_time

Example:

"5"

order_configuration.twap_limit_gtd.bucket_size

string

The size of each suborder. bucket_size multiplied by number_buckets should match the size of the entire twap order)

Example:

"2.00"

order_configuration.twap_limit_gtd.bucket_duration

string

The duration over which each sub order was executed

Example:

"300s"

order_configuration.stop_limit_stop_limit_gtc

object

Posts an Order to buy or sell a specified quantity of an Asset, but only if and when the last trade price on the Order Book equals or surpasses the Stop Price. If posted, the Order will remain on the Order Book until canceled. Read more on Stop-Limit Orders.

Show child attributes

order_configuration.stop_limit_stop_limit_gtc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

order_configuration.stop_limit_stop_limit_gtc.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.stop_limit_stop_limit_gtc.stop_price

string

The specified price that will trigger the placement of the Order.

Example:

"20000.00"

order_configuration.stop_limit_stop_limit_gtc.stop_direction

enum<string>

default:""

The direction of the stop limit Order. If Up, then the Order will trigger when the last trade price goes above the stop_price. If Down, then the Order will trigger when the last trade price goes below the stop_price.

Available options:

STOP_DIRECTION_STOP_UP,

STOP_DIRECTION_STOP_DOWN

Example:

"20000.00"

order_configuration.stop_limit_stop_limit_gtd

object

Show child attributes

order_configuration.stop_limit_stop_limit_gtd.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

0.001

order_configuration.stop_limit_stop_limit_gtd.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.stop_limit_stop_limit_gtd.stop_price

string

The specified price that will trigger the placement of the Order.

Example:

"20000.00"

order_configuration.stop_limit_stop_limit_gtd.end_time

string<RFC3339 Timestamp>

The time at which the order will be cancelled if it is not Filled.

Example:

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

order_configuration.stop_limit_stop_limit_gtd.stop_direction

enum<string>

default:""

Available options:

STOP_DIRECTION_STOP_UP,

STOP_DIRECTION_STOP_DOWN

Example:

"20000.00"

order_configuration.trigger_bracket_gtc

object

A Limit Order to buy or sell a specified quantity of an Asset at a specified price, with stop limit order parameters embedded in the order. If posted, the Order will remain on the Order Book until canceled. Read more on Bracket Orders.

Show child attributes

order_configuration.trigger_bracket_gtc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

0.001

order_configuration.trigger_bracket_gtc.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.trigger_bracket_gtc.stop_trigger_price

string

The price level (in quote currency) where the position will be exited. When triggered, a stop limit order is automatically placed with a limit price 5% higher for BUYS and 5% lower for SELLS.

Example:

"20000.00"

order_configuration.trigger_bracket_gtd

object

Show child attributes

order_configuration.trigger_bracket_gtd.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

0.001

order_configuration.trigger_bracket_gtd.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

order_configuration.trigger_bracket_gtd.stop_trigger_price

string

The price level (in quote currency) where the position will be exited. When triggered, a stop limit order is automatically placed with a limit price 5% higher for BUYS and 5% lower for SELLS.

Example:

"20000.00"

order_configuration.trigger_bracket_gtd.end_time

string<RFC3339 Timestamp>

The time at which the order will be cancelled if it is not Filled.

Example:

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

order_configuration.scaled_limit_gtc

scaled limit order allows user to specify the order size and price on the child · object

A scaled order enables users to divide a large order into multiple smaller limit orders, which are placed incrementally across a user-defined price range. Read more on Limit Orders.

Show child attributes

order_configuration.scaled_limit_gtc.orders

object[]

Show child attributes

quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

post_only

boolean

Enable or disable Post-only Mode. When enabled, only Maker Orders will be posted to the Order Book. Orders that will be posted as a Taker Order will be rejected.

Example:

false

order_configuration.scaled_limit_gtc.quote_size

string

order_configuration.scaled_limit_gtc.base_size

string

order_configuration.scaled_limit_gtc.num_orders

integer<int32>

order_configuration.scaled_limit_gtc.min_price

string

order_configuration.scaled_limit_gtc.max_price

string

order_configuration.scaled_limit_gtc.price_distribution

enum<string>

default:FLAT

Available options:

FLAT,

LINEAR_INCREASING,

LINEAR_DECREASING

order_configuration.scaled_limit_gtc.size_distribution

enum<string>

default:UNKNOWN_DISTRIBUTION

Size distribution across the child orders.

Available options:

UNKNOWN_DISTRIBUTION,

INCREASING,

DECREASING,

EVENLY_SPLIT

order_configuration.scaled_limit_gtc.size_diff

string

order_configuration.scaled_limit_gtc.size_ratio

string

leverage

string

The amount of leverage for the order (default is 1.0).

Example:

"2.0"

margin_type

enum<string>

default:""

Margin Type for this order (default is CROSS).

Available options:

CROSS,

ISOLATED

retail_portfolio_id

string

(Deprecated) The ID of the portfolio to associate the order with. Only applicable for legacy keys. CDP keys will default to the key's permissioned portfolio.

Example:

"11111111-1111-1111-1111-111111111111"

attached_order_configuration

object

The configuration of the attached order. Only TriggerBracketGtc is eligible. Size field must be omitted as the size of the attached order is the same as that of the parent order.

Show child attributes

attached_order_configuration.market_market_ioc

Order entry configurations · object

Buy or sell a specified quantity of an Asset at the current best available market price. Read more on Market Orders

Show child attributes

attached_order_configuration.market_market_ioc.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

attached_order_configuration.market_market_ioc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

attached_order_configuration.market_market_fok

object

Show child attributes

attached_order_configuration.market_market_fok.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

attached_order_configuration.market_market_fok.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

attached_order_configuration.sor_limit_ioc

object

Show child attributes

attached_order_configuration.sor_limit_ioc.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

attached_order_configuration.sor_limit_ioc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

attached_order_configuration.sor_limit_ioc.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.limit_limit_gtc

object

Buy or sell a specified quantity of an Asset at a specified price. If posted, the Order will remain on the Order Book until canceled. Read more on Limit Orders.

Show child attributes

attached_order_configuration.limit_limit_gtc.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

attached_order_configuration.limit_limit_gtc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

attached_order_configuration.limit_limit_gtc.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.limit_limit_gtc.post_only

boolean

Enable or disable Post-only Mode. When enabled, only Maker Orders will be posted to the Order Book. Orders that will be posted as a Taker Order will be rejected.

Example:

false

attached_order_configuration.limit_limit_gtd

object

Show child attributes

attached_order_configuration.limit_limit_gtd.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

attached_order_configuration.limit_limit_gtd.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

attached_order_configuration.limit_limit_gtd.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.limit_limit_gtd.end_time

string<RFC3339 Timestamp>

The time at which the order will be cancelled if it is not Filled.

Example:

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

attached_order_configuration.limit_limit_gtd.post_only

boolean

Enable or disable Post-only Mode. When enabled, only Maker Orders will be posted to the Order Book. Orders that will be posted as a Taker Order will be rejected.

Example:

false

attached_order_configuration.limit_limit_fok

object

Buy or sell a specified quantity of an Asset at a specified price. The Order will only post to the Order Book if it is to immediately and completely Fill. Read more on Limit Orders.

Show child attributes

attached_order_configuration.limit_limit_fok.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

attached_order_configuration.limit_limit_fok.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

attached_order_configuration.limit_limit_fok.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.twap_limit_gtd

object

A time-weighted average price (TWAP) order type that calculates the average price of a product to programmatically execute an order over a specified duration.

Show child attributes

attached_order_configuration.twap_limit_gtd.quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

attached_order_configuration.twap_limit_gtd.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

attached_order_configuration.twap_limit_gtd.start_time

string<RFC3339 Timestamp>

Time at which the order should begin executing.

Example:

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

attached_order_configuration.twap_limit_gtd.end_time

string<RFC3339 Timestamp>

The time at which the order will be cancelled if it is not Filled.

Example:

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

attached_order_configuration.twap_limit_gtd.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.twap_limit_gtd.number_buckets

string

The number of smaller buckets/suborders over which the entire order will be broken into. Each suborder will be executed over a duration calculated based on the end_time

Example:

"5"

attached_order_configuration.twap_limit_gtd.bucket_size

string

The size of each suborder. bucket_size multiplied by number_buckets should match the size of the entire twap order)

Example:

"2.00"

attached_order_configuration.twap_limit_gtd.bucket_duration

string

The duration over which each sub order was executed

Example:

"300s"

attached_order_configuration.stop_limit_stop_limit_gtc

object

Show child attributes

attached_order_configuration.stop_limit_stop_limit_gtc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

attached_order_configuration.stop_limit_stop_limit_gtc.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.stop_limit_stop_limit_gtc.stop_price

string

The specified price that will trigger the placement of the Order.

Example:

"20000.00"

attached_order_configuration.stop_limit_stop_limit_gtc.stop_direction

enum<string>

default:""

Available options:

STOP_DIRECTION_STOP_UP,

STOP_DIRECTION_STOP_DOWN

Example:

"20000.00"

attached_order_configuration.stop_limit_stop_limit_gtd

object

Show child attributes

attached_order_configuration.stop_limit_stop_limit_gtd.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

0.001

attached_order_configuration.stop_limit_stop_limit_gtd.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.stop_limit_stop_limit_gtd.stop_price

string

The specified price that will trigger the placement of the Order.

Example:

"20000.00"

attached_order_configuration.stop_limit_stop_limit_gtd.end_time

string<RFC3339 Timestamp>

The time at which the order will be cancelled if it is not Filled.

Example:

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

attached_order_configuration.stop_limit_stop_limit_gtd.stop_direction

enum<string>

default:""

Available options:

STOP_DIRECTION_STOP_UP,

STOP_DIRECTION_STOP_DOWN

Example:

"20000.00"

attached_order_configuration.trigger_bracket_gtc

object

Show child attributes

attached_order_configuration.trigger_bracket_gtc.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

0.001

attached_order_configuration.trigger_bracket_gtc.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.trigger_bracket_gtc.stop_trigger_price

string

The price level (in quote currency) where the position will be exited. When triggered, a stop limit order is automatically placed with a limit price 5% higher for BUYS and 5% lower for SELLS.

Example:

"20000.00"

attached_order_configuration.trigger_bracket_gtd

object

Show child attributes

attached_order_configuration.trigger_bracket_gtd.base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

0.001

attached_order_configuration.trigger_bracket_gtd.limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

attached_order_configuration.trigger_bracket_gtd.stop_trigger_price

string

The price level (in quote currency) where the position will be exited. When triggered, a stop limit order is automatically placed with a limit price 5% higher for BUYS and 5% lower for SELLS.

Example:

"20000.00"

attached_order_configuration.trigger_bracket_gtd.end_time

string<RFC3339 Timestamp>

The time at which the order will be cancelled if it is not Filled.

Example:

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

attached_order_configuration.scaled_limit_gtc

scaled limit order allows user to specify the order size and price on the child · object

A scaled order enables users to divide a large order into multiple smaller limit orders, which are placed incrementally across a user-defined price range. Read more on Limit Orders.

Show child attributes

attached_order_configuration.scaled_limit_gtc.orders

object[]

Show child attributes

quote_size

string

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

"10.00"

base_size

string

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

"0.001"

limit_price

string

The specified price, or better, that the Order should be executed at. A Buy Order will execute at or lower than the limit price. A Sell Order will execute at or higher than the limit price.

Example:

"10000.00"

post_only

boolean

Enable or disable Post-only Mode. When enabled, only Maker Orders will be posted to the Order Book. Orders that will be posted as a Taker Order will be rejected.

Example:

false

attached_order_configuration.scaled_limit_gtc.quote_size

string

attached_order_configuration.scaled_limit_gtc.base_size

string

attached_order_configuration.scaled_limit_gtc.num_orders

integer<int32>

attached_order_configuration.scaled_limit_gtc.min_price

string

attached_order_configuration.scaled_limit_gtc.max_price

string

attached_order_configuration.scaled_limit_gtc.price_distribution

enum<string>

default:FLAT

Available options:

FLAT,

LINEAR_INCREASING,

LINEAR_DECREASING

attached_order_configuration.scaled_limit_gtc.size_distribution

enum<string>

default:UNKNOWN_DISTRIBUTION

Size distribution across the child orders.

Available options:

UNKNOWN_DISTRIBUTION,

INCREASING,

DECREASING,

EVENLY_SPLIT

attached_order_configuration.scaled_limit_gtc.size_diff

string

attached_order_configuration.scaled_limit_gtc.size_ratio

string

prediction_metadata

object

Request metadata specific to prediction market orders (YES/NO).

Show child attributes

prediction_metadata.prediction_side

enum<string>

default:PREDICTION_SIDE_UNKNOWN

Prediction market orders can be either a YES or NO.

Under the hood, there is only a YES order book; NO orders are technically short positions on the YES order book.

Available options:

PREDICTION_SIDE_UNKNOWN,

PREDICTION_SIDE_YES,

PREDICTION_SIDE_NO

Response

A successful response.

order_total

string

required

commission_total

string

required

Currency amount of the applied commission (so not the rate that was used on input)

errs

enum<string>[]

required

List of potential failure reasons were this order to be submitted

Available options:

UNKNOWN_PREVIEW_FAILURE_REASON,

PREVIEW_MISSING_COMMISSION_RATE,

PREVIEW_INVALID_SIDE,

PREVIEW_INVALID_ORDER_CONFIG,

PREVIEW_INVALID_PRODUCT_ID,

PREVIEW_INVALID_SIZE_PRECISION,

PREVIEW_INVALID_PRICE_PRECISION,

PREVIEW_MISSING_PRODUCT_PRICE_BOOK,

PREVIEW_INVALID_LEDGER_BALANCE,

PREVIEW_INSUFFICIENT_LEDGER_BALANCE,

PREVIEW_INVALID_LIMIT_PRICE_POST_ONLY,

PREVIEW_INVALID_LIMIT_PRICE,

PREVIEW_INVALID_NO_LIQUIDITY,

PREVIEW_INSUFFICIENT_FUND,

PREVIEW_INVALID_COMMISSION_CONFIGURATION,

PREVIEW_INVALID_STOP_PRICE,

PREVIEW_INVALID_BASE_SIZE_TOO_LARGE,

PREVIEW_INVALID_BASE_SIZE_TOO_SMALL,

PREVIEW_INVALID_QUOTE_SIZE_PRECISION,

PREVIEW_INVALID_QUOTE_SIZE_TOO_LARGE,

PREVIEW_INVALID_PRICE_TOO_LARGE,

PREVIEW_INVALID_QUOTE_SIZE_TOO_SMALL,

PREVIEW_INSUFFICIENT_FUNDS_FOR_FUTURES,

PREVIEW_BREACHED_PRICE_LIMIT,

PREVIEW_BREACHED_ACCOUNT_POSITION_LIMIT,

PREVIEW_BREACHED_COMPANY_POSITION_LIMIT,

PREVIEW_INVALID_MARGIN_HEALTH,

PREVIEW_RISK_PROXY_FAILURE,

PREVIEW_UNTRADABLE_FCM_ACCOUNT_STATUS,

PREVIEW_IN_LIQUIDATION,

PREVIEW_INVALID_MARGIN_TYPE,

PREVIEW_INVALID_LEVERAGE,

PREVIEW_UNTRADABLE_PRODUCT,

PREVIEW_INVALID_FCM_TRADING_SESSION,

PREVIEW_NOT_ALLOWED_BY_MARKET_STATE,

PREVIEW_BREACHED_OPEN_INTEREST_LIMIT,

PREVIEW_GEOFENCING_RESTRICTION,

PREVIEW_INVALID_END_TIME,

PREVIEW_OPPOSITE_MARGIN_TYPE_EXISTS,

PREVIEW_QUOTE_SIZE_NOT_ALLOWED_FOR_BRACKET,

PREVIEW_INVALID_BRACKET_PRICES,

PREVIEW_MISSING_MARKET_TRADE_DATA,

PREVIEW_INVALID_BRACKET_LIMIT_PRICE,

PREVIEW_INVALID_BRACKET_STOP_TRIGGER_PRICE,

PREVIEW_BRACKET_LIMIT_PRICE_OUT_OF_BOUNDS,

PREVIEW_STOP_TRIGGER_PRICE_OUT_OF_BOUNDS,

PREVIEW_BRACKET_ORDER_NOT_SUPPORTED,

PREVIEW_INVALID_STOP_PRICE_PRECISION,

PREVIEW_STOP_PRICE_ABOVE_LIMIT_PRICE,

PREVIEW_STOP_PRICE_BELOW_LIMIT_PRICE,

PREVIEW_STOP_PRICE_ABOVE_LAST_TRADE_PRICE,

PREVIEW_STOP_PRICE_BELOW_LAST_TRADE_PRICE,

PREVIEW_FOK_DISABLED,

PREVIEW_FOK_ONLY_ALLOWED_ON_LIMIT_ORDERS,

PREVIEW_POST_ONLY_NOT_ALLOWED_WITH_FOK,

PREVIEW_UBO_HIGH_LEVERAGE_QUANTITY_BREACHED,

PREVIEW_ECOSYSTEM_LEVERAGE_UTILIZATION_BREACHED,

PREVIEW_CLOSE_ONLY_FAILURE,

PREVIEW_UBO_HIGH_LEVERAGE_NOTIONAL_BREACHED,

PREVIEW_END_TIME_TOO_FAR_IN_FUTURE,

PREVIEW_LIMIT_PRICE_TOO_FAR_FROM_MARKET,

PREVIEW_FUTURES_AFTER_HOUR_INVALID_ORDER_TYPE,

PREVIEW_FUTURES_AFTER_HOUR_INVALID_TIME_IN_FORCE,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE,

PREVIEW_INVALID_ATTACHED_STOP_LOSS_PRICE,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE_PRECISION,

PREVIEW_INVALID_ATTACHED_STOP_LOSS_PRICE_PRECISION,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE_OUT_OF_BOUNDS,

PREVIEW_INVALID_ATTACHED_STOP_LOSS_PRICE_OUT_OF_BOUNDS,

PREVIEW_INVALID_BRACKET_ORDER_SIDE,

PREVIEW_BRACKET_ORDER_SIZE_EXCEEDS_POSITION,

PREVIEW_ORDER_SIZE_EXCEEDS_BRACKETED_POSITION,

PREVIEW_INVALID_LIMIT_PRICE_PRECISION,

PREVIEW_INVALID_STOP_TRIGGER_PRICE_PRECISION,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE_EXCEEDS_MAX_DISTANCE_FROM_ORIGINATING_PRICE,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_SIZE_BELOW_MIN,

PREVIEW_ATTACHED_ORDER_SIZE_MUST_BE_NIL,

PREVIEW_BELOW_MIN_SIZE_FOR_DURATION,

PREVIEW_MAX_DAILY_VOLUME_NOTIONAL_BREACHED,

PREVIEW_INVALID_SETTLEMENT_CURRENCY,

PREVIEW_DURATION_TOO_SMALL,

PREVIEW_INTX_FOK_ONLY_ALLOWED_ON_LIMIT_AND_MARKET_ORDERS,

PREVIEW_BUCKET_SIZE_SMALLER_THAN_QUOTE_MIN,

PREVIEW_BUCKET_SIZE_SMALLER_THAN_BASE_MIN,

PREVIEW_END_TIME_AFTER_CONTRACT_EXPIRATION,

PREVIEW_START_TIME_MUST_BE_SPECIFIED,

PREVIEW_ICEBERG_ORDERS_NOT_SUPPORTED,

PREVIEW_END_TIME_IS_IN_THE_PAST,

PREVIEW_GTD_ORDERS_MUST_HAVE_END_TIME,

PREVIEW_ATTACHED_ORDER_MUST_HAVE_POSITIVE_PRICES,

PREVIEW_INVALID_ORDER_SIDE_FOR_ATTACHED_TPSL,

PREVIEW_ATTACHED_ORDERS_ONLY_ALLOWED_ON_MARKET_LIMIT,

PREVIEW_INVALID_ORDER_TYPE_FOR_ATTACHED,

PREVIEW_PRICE_NOT_ALLOWED_FOR_MARKET_ORDERS,

PREVIEW_REDUCE_ONLY_NOT_ALLOWED_ON_VENUE,

PREVIEW_NON_NUMERIC_ORDER_SIZE,

PREVIEW_INVALID_INTX_CLIENT_ORDER_ID,

PREVIEW_DURATION_TOO_LARGE,

PREVIEW_REDUCE_ONLY_NOT_ALLOWED_ON_SPOT_PRODUCTS,

PREVIEW_LIMIT_ORDER_PRICE_EXCEEDS_PRICE_BAND_ON_BUY,

PREVIEW_LIMIT_ORDER_PRICE_EXCEEDS_PRICE_BAND_ON_SELL,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE_OUT_OF_BOUNDS_ON_AGGRESSIVE_ORDER,

PREVIEW_INVALID_ATTACHED_STOP_LOSS_PRICE_OUT_OF_BOUNDS_ON_AGGRESSIVE_ORDER,

PREVIEW_STOP_TRIGGERED,

PREVIEW_REPLACE_NOT_SUPPORTED,

PREVIEW_ORDER_IS_PENDING_CANCEL,

PREVIEW_POSITION_SIZE_INCREASE_REJECT,

PREVIEW_ASSET_BALANCE_INCREASE_REJECT,

PREVIEW_TOO_MANY_PENDING_REPLACES,

PREVIEW_INVALID_RFQ_BASE_SIZE_TOO_SMALL,

PREVIEW_INVALID_RFQ_BASE_SIZE_TOO_LARGE,

PREVIEW_INVALID_RFQ_QUOTE_SIZE_TOO_SMALL,

PREVIEW_INVALID_RFQ_QUOTE_SIZE_TOO_LARGE,

PREVIEW_REDUCE_ONLY_INCREASED_POSITION_SIZE,

PREVIEW_COMPLIANCE_PURCHASE_LIMIT_EXCEEDED,

PREVIEW_SCALED_PARAM_INFEASIBLE,

PREVIEW_SCALED_MIN_ORDER_VIOLATION,

PREVIEW_SCALED_MAX_ORDER_VIOLATION,

PREVIEW_POST_ONLY_NOT_ALLOWED_WITH_PEG,

PREVIEW_INVALID_PEG_OFFSET,

PREVIEW_INVALID_PEG_WIG_LEVEL,

PREVIEW_INVALID_PEG_VENUE_OPTIONS,

PREVIEW_PEG_INVALID_ORDER_TYPE,

PREVIEW_SINGLE_LEGGED_TPSL_NOT_ALLOWED,

PREVIEW_FRACTIONAL_ORDERS_NOT_ALLOWED_FOR_PRODUCT,

PREVIEW_QUOTE_ORDERS_NOT_ALLOWED_FOR_PRODUCT,

PREVIEW_NBBO_NOT_PROVIDED,

PREVIEW_INVALID_NBBO_BID_PRICE,

PREVIEW_INVALID_NBBO_ASK_PRICE,

PREVIEW_NOTIONAL_SIZE_BREACHES_FRACTIONAL_MINIMUM,

PREVIEW_MARKET_ORDERS_PROHIBITED_DURING_NON_CORE_SESSION,

PREVIEW_NOTIONAL_ORDERS_PROHIBITED_DURING_NON_CORE_SESSION,

PREVIEW_MAX_NOTIONAL_PER_ORDER_BREACHED_15C35_CHECK,

PREVIEW_MAX_SHARES_PER_ORDER_BREACHED_15C35_CHECK,

PREVIEW_INVALID_EQUITY_TRADING_SESSION,

PREVIEW_PRODUCT_TRADING_HALTED,

PREVIEW_TRADING_DISABLED,

PREVIEW_INVALID_BRACKET_LIMIT_PRICE_PRECISION

warning

enum<string>[]

required

Available options:

UNKNOWN,

BIG_ORDER,

SMALL_ORDER,

DURATION_EXTENDED_BY_MARKET_CLOSE,

OPEN_ORDERS_EXCEED_COMPLIANCE_PURCHASE_LIMIT_MAY_CANCEL

quote_size

string

required

The amount of the second Asset in the Trading Pair. For example, on the BTC/USD Order Book, USD is the Quote Asset.

Example:

10

base_size

string

required

The amount of the first Asset in the Trading Pair. For example, on the BTC-USD Order Book, BTC is the Base Asset.

Example:

0.001

best_bid

string

required

best_ask

string

required

is_max

boolean

required

Indicates whether tradable_balance should be set to the maximum amount.

order_margin_total

string

leverage

string

The amount of leverage for the order (default is 1.0).

Example:

"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

object

Expected PNL of an order. This value is an estimate and does not take into account fees and slippage.

Show child attributes

pnl_configuration.trigger_bracket_pnl

PNL Configurations · object

PNL configuration for a bracket order.

Show child attributes

pnl_configuration.trigger_bracket_pnl.take_profit_pnl

string

PNL if an attached order fills at the take profit price.

pnl_configuration.trigger_bracket_pnl.stop_loss_pnl

string

PNL if an attached order fills at the stop loss price

twap_bucket_metadata

Twap bucket metadata - size/duration of each suborder into which twap is broken into · object

Show child attributes

twap_bucket_metadata.bucket_duration

string

twap_bucket_metadata.bucket_size

string

twap_bucket_metadata.number_buckets

string

twap_bucket_metadata.start_time

string<RFC3339 Timestamp>

twap_bucket_metadata.end_time

string<RFC3339 Timestamp>

position_notional_limit

string

max_notional_at_requested_leverage

string

margin_ratio_data

New margin ratio fields replacing current_liquidation_buffer and projected_liquidation_buffer · object

Show child attributes

margin_ratio_data.current_margin_ratio

string

margin_ratio_data.projected_margin_ratio

string

commission_detail_total

CommissionDetailTotal contains the breakdown of commission charges for an order · object

Breakdown of commission charges for the order

Show child attributes

commission_detail_total.total_commission

string

commission_detail_total.gst_commission

string

commission_detail_total.withholding_commission

string

commission_detail_total.client_commission

string

commission_detail_total.venue_commission

string

commission_detail_total.regulatory_commission

string

commission_detail_total.clearing_commission

string

scaled_metadata

a list of scaled order distributions · object

Metadata for scaled orders containing the order distribution

Show child attributes

scaled_metadata.scaled_order_distribution

represents size / price of a scaled order in core proto · object[]

Show child attributes

size

string

price

string

errs

enum<string>[]

Available options:

UNKNOWN_PREVIEW_FAILURE_REASON,

PREVIEW_MISSING_COMMISSION_RATE,

PREVIEW_INVALID_SIDE,

PREVIEW_INVALID_ORDER_CONFIG,

PREVIEW_INVALID_PRODUCT_ID,

PREVIEW_INVALID_SIZE_PRECISION,

PREVIEW_INVALID_PRICE_PRECISION,

PREVIEW_MISSING_PRODUCT_PRICE_BOOK,

PREVIEW_INVALID_LEDGER_BALANCE,

PREVIEW_INSUFFICIENT_LEDGER_BALANCE,

PREVIEW_INVALID_LIMIT_PRICE_POST_ONLY,

PREVIEW_INVALID_LIMIT_PRICE,

PREVIEW_INVALID_NO_LIQUIDITY,

PREVIEW_INSUFFICIENT_FUND,

PREVIEW_INVALID_COMMISSION_CONFIGURATION,

PREVIEW_INVALID_STOP_PRICE,

PREVIEW_INVALID_BASE_SIZE_TOO_LARGE,

PREVIEW_INVALID_BASE_SIZE_TOO_SMALL,

PREVIEW_INVALID_QUOTE_SIZE_PRECISION,

PREVIEW_INVALID_QUOTE_SIZE_TOO_LARGE,

PREVIEW_INVALID_PRICE_TOO_LARGE,

PREVIEW_INVALID_QUOTE_SIZE_TOO_SMALL,

PREVIEW_INSUFFICIENT_FUNDS_FOR_FUTURES,

PREVIEW_BREACHED_PRICE_LIMIT,

PREVIEW_BREACHED_ACCOUNT_POSITION_LIMIT,

PREVIEW_BREACHED_COMPANY_POSITION_LIMIT,

PREVIEW_INVALID_MARGIN_HEALTH,

PREVIEW_RISK_PROXY_FAILURE,

PREVIEW_UNTRADABLE_FCM_ACCOUNT_STATUS,

PREVIEW_IN_LIQUIDATION,

PREVIEW_INVALID_MARGIN_TYPE,

PREVIEW_INVALID_LEVERAGE,

PREVIEW_UNTRADABLE_PRODUCT,

PREVIEW_INVALID_FCM_TRADING_SESSION,

PREVIEW_NOT_ALLOWED_BY_MARKET_STATE,

PREVIEW_BREACHED_OPEN_INTEREST_LIMIT,

PREVIEW_GEOFENCING_RESTRICTION,

PREVIEW_INVALID_END_TIME,

PREVIEW_OPPOSITE_MARGIN_TYPE_EXISTS,

PREVIEW_QUOTE_SIZE_NOT_ALLOWED_FOR_BRACKET,

PREVIEW_INVALID_BRACKET_PRICES,

PREVIEW_MISSING_MARKET_TRADE_DATA,

PREVIEW_INVALID_BRACKET_LIMIT_PRICE,

PREVIEW_INVALID_BRACKET_STOP_TRIGGER_PRICE,

PREVIEW_BRACKET_LIMIT_PRICE_OUT_OF_BOUNDS,

PREVIEW_STOP_TRIGGER_PRICE_OUT_OF_BOUNDS,

PREVIEW_BRACKET_ORDER_NOT_SUPPORTED,

PREVIEW_INVALID_STOP_PRICE_PRECISION,

PREVIEW_STOP_PRICE_ABOVE_LIMIT_PRICE,

PREVIEW_STOP_PRICE_BELOW_LIMIT_PRICE,

PREVIEW_STOP_PRICE_ABOVE_LAST_TRADE_PRICE,

PREVIEW_STOP_PRICE_BELOW_LAST_TRADE_PRICE,

PREVIEW_FOK_DISABLED,

PREVIEW_FOK_ONLY_ALLOWED_ON_LIMIT_ORDERS,

PREVIEW_POST_ONLY_NOT_ALLOWED_WITH_FOK,

PREVIEW_UBO_HIGH_LEVERAGE_QUANTITY_BREACHED,

PREVIEW_ECOSYSTEM_LEVERAGE_UTILIZATION_BREACHED,

PREVIEW_CLOSE_ONLY_FAILURE,

PREVIEW_UBO_HIGH_LEVERAGE_NOTIONAL_BREACHED,

PREVIEW_END_TIME_TOO_FAR_IN_FUTURE,

PREVIEW_LIMIT_PRICE_TOO_FAR_FROM_MARKET,

PREVIEW_FUTURES_AFTER_HOUR_INVALID_ORDER_TYPE,

PREVIEW_FUTURES_AFTER_HOUR_INVALID_TIME_IN_FORCE,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE,

PREVIEW_INVALID_ATTACHED_STOP_LOSS_PRICE,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE_PRECISION,

PREVIEW_INVALID_ATTACHED_STOP_LOSS_PRICE_PRECISION,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE_OUT_OF_BOUNDS,

PREVIEW_INVALID_ATTACHED_STOP_LOSS_PRICE_OUT_OF_BOUNDS,

PREVIEW_INVALID_BRACKET_ORDER_SIDE,

PREVIEW_BRACKET_ORDER_SIZE_EXCEEDS_POSITION,

PREVIEW_ORDER_SIZE_EXCEEDS_BRACKETED_POSITION,

PREVIEW_INVALID_LIMIT_PRICE_PRECISION,

PREVIEW_INVALID_STOP_TRIGGER_PRICE_PRECISION,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE_EXCEEDS_MAX_DISTANCE_FROM_ORIGINATING_PRICE,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_SIZE_BELOW_MIN,

PREVIEW_ATTACHED_ORDER_SIZE_MUST_BE_NIL,

PREVIEW_BELOW_MIN_SIZE_FOR_DURATION,

PREVIEW_MAX_DAILY_VOLUME_NOTIONAL_BREACHED,

PREVIEW_INVALID_SETTLEMENT_CURRENCY,

PREVIEW_DURATION_TOO_SMALL,

PREVIEW_INTX_FOK_ONLY_ALLOWED_ON_LIMIT_AND_MARKET_ORDERS,

PREVIEW_BUCKET_SIZE_SMALLER_THAN_QUOTE_MIN,

PREVIEW_BUCKET_SIZE_SMALLER_THAN_BASE_MIN,

PREVIEW_END_TIME_AFTER_CONTRACT_EXPIRATION,

PREVIEW_START_TIME_MUST_BE_SPECIFIED,

PREVIEW_ICEBERG_ORDERS_NOT_SUPPORTED,

PREVIEW_END_TIME_IS_IN_THE_PAST,

PREVIEW_GTD_ORDERS_MUST_HAVE_END_TIME,

PREVIEW_ATTACHED_ORDER_MUST_HAVE_POSITIVE_PRICES,

PREVIEW_INVALID_ORDER_SIDE_FOR_ATTACHED_TPSL,

PREVIEW_ATTACHED_ORDERS_ONLY_ALLOWED_ON_MARKET_LIMIT,

PREVIEW_INVALID_ORDER_TYPE_FOR_ATTACHED,

PREVIEW_PRICE_NOT_ALLOWED_FOR_MARKET_ORDERS,

PREVIEW_REDUCE_ONLY_NOT_ALLOWED_ON_VENUE,

PREVIEW_NON_NUMERIC_ORDER_SIZE,

PREVIEW_INVALID_INTX_CLIENT_ORDER_ID,

PREVIEW_DURATION_TOO_LARGE,

PREVIEW_REDUCE_ONLY_NOT_ALLOWED_ON_SPOT_PRODUCTS,

PREVIEW_LIMIT_ORDER_PRICE_EXCEEDS_PRICE_BAND_ON_BUY,

PREVIEW_LIMIT_ORDER_PRICE_EXCEEDS_PRICE_BAND_ON_SELL,

PREVIEW_INVALID_ATTACHED_TAKE_PROFIT_PRICE_OUT_OF_BOUNDS_ON_AGGRESSIVE_ORDER,

PREVIEW_INVALID_ATTACHED_STOP_LOSS_PRICE_OUT_OF_BOUNDS_ON_AGGRESSIVE_ORDER,

PREVIEW_STOP_TRIGGERED,

PREVIEW_REPLACE_NOT_SUPPORTED,

PREVIEW_ORDER_IS_PENDING_CANCEL,

PREVIEW_POSITION_SIZE_INCREASE_REJECT,

PREVIEW_ASSET_BALANCE_INCREASE_REJECT,

PREVIEW_TOO_MANY_PENDING_REPLACES,

PREVIEW_INVALID_RFQ_BASE_SIZE_TOO_SMALL,

PREVIEW_INVALID_RFQ_BASE_SIZE_TOO_LARGE,

PREVIEW_INVALID_RFQ_QUOTE_SIZE_TOO_SMALL,

PREVIEW_INVALID_RFQ_QUOTE_SIZE_TOO_LARGE,

PREVIEW_REDUCE_ONLY_INCREASED_POSITION_SIZE,

PREVIEW_COMPLIANCE_PURCHASE_LIMIT_EXCEEDED,

PREVIEW_SCALED_PARAM_INFEASIBLE,

PREVIEW_SCALED_MIN_ORDER_VIOLATION,

PREVIEW_SCALED_MAX_ORDER_VIOLATION,

PREVIEW_POST_ONLY_NOT_ALLOWED_WITH_PEG,

PREVIEW_INVALID_PEG_OFFSET,

PREVIEW_INVALID_PEG_WIG_LEVEL,

PREVIEW_INVALID_PEG_VENUE_OPTIONS,

PREVIEW_PEG_INVALID_ORDER_TYPE,

PREVIEW_SINGLE_LEGGED_TPSL_NOT_ALLOWED,

PREVIEW_FRACTIONAL_ORDERS_NOT_ALLOWED_FOR_PRODUCT,

PREVIEW_QUOTE_ORDERS_NOT_ALLOWED_FOR_PRODUCT,

PREVIEW_NBBO_NOT_PROVIDED,

PREVIEW_INVALID_NBBO_BID_PRICE,

PREVIEW_INVALID_NBBO_ASK_PRICE,

PREVIEW_NOTIONAL_SIZE_BREACHES_FRACTIONAL_MINIMUM,

PREVIEW_MARKET_ORDERS_PROHIBITED_DURING_NON_CORE_SESSION,

PREVIEW_NOTIONAL_ORDERS_PROHIBITED_DURING_NON_CORE_SESSION,

PREVIEW_MAX_NOTIONAL_PER_ORDER_BREACHED_15C35_CHECK,

PREVIEW_MAX_SHARES_PER_ORDER_BREACHED_15C35_CHECK,

PREVIEW_INVALID_EQUITY_TRADING_SESSION,

PREVIEW_PRODUCT_TRADING_HALTED,

PREVIEW_TRADING_DISABLED,

PREVIEW_INVALID_BRACKET_LIMIT_PRICE_PRECISION

warning

enum<string>[]

Available options:

UNKNOWN,

BIG_ORDER,

SMALL_ORDER,

DURATION_EXTENDED_BY_MARKET_CLOSE,

OPEN_ORDERS_EXCEED_COMPLIANCE_PURCHASE_LIMIT_MAY_CANCEL

compliance_limit_data

Compliance Limit service data · object

Optional compliance limit data

Show child attributes

compliance_limit_data.total_limit

object

Show child attributes

compliance_limit_data.total_limit.value

string

required

Amount of currency that this object represents.

Example:

"1.23"

compliance_limit_data.total_limit.currency

string

required

Denomination of the currency.

Example:

"BTC"

compliance_limit_data.remaining_limits

object

Show child attributes

compliance_limit_data.remaining_limits.value

string

required

Amount of currency that this object represents.

Example:

"1.23"

compliance_limit_data.remaining_limits.currency

string

required

Denomination of the currency.

Example:

"BTC"

est_average_filled_price

string

Estimated fill price for order.

REST API

Authorizations

Body

Response