Get 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.

Path Parameters

order_id

string

required

The ID of the order.

Query Parameters

client_order_id

string

(Deprecated) Client Order ID to fetch the order with.

user_native_currency

string

(Deprecated) Native currency to fetch order with. Default is USD.

Response

A successful response.

order

object

The retrieved order.

Show child attributes

order.order_id

string

required

The ID of the order.

Example:

"0000-000000-000000"

order.product_id

string

required

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

Example:

"BTC-USD"

order.user_id

string

required

The id of the User owning this Order

Example:

"2222-000000-000000"

order.order_configuration

object

required

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

Show child attributes

order.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.order_configuration.twap_limit_gtd.bucket_duration

string

The duration over which each sub order was executed

Example:

"300s"

order.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.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.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.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.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.order_configuration.stop_limit_stop_limit_gtd

object

Show child attributes

order.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.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.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.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.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.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.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.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.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.order_configuration.trigger_bracket_gtd

object

Show child attributes

order.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.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.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.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.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.order_configuration.scaled_limit_gtc.orders

object[]

Show child attributes

order.order_configuration.scaled_limit_gtc.orders.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.order_configuration.scaled_limit_gtc.orders.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.order_configuration.scaled_limit_gtc.orders.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.order_configuration.scaled_limit_gtc.orders.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.order_configuration.scaled_limit_gtc.quote_size

string

order.order_configuration.scaled_limit_gtc.base_size

string

order.order_configuration.scaled_limit_gtc.num_orders

integer<int32>

order.order_configuration.scaled_limit_gtc.min_price

string

order.order_configuration.scaled_limit_gtc.max_price

string

order.order_configuration.scaled_limit_gtc.price_distribution

enum<string>

default:FLAT

Available options:

FLAT,

LINEAR_INCREASING,

LINEAR_DECREASING

order.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.order_configuration.scaled_limit_gtc.size_diff

string

order.order_configuration.scaled_limit_gtc.size_ratio

string

order.side

enum<string>

default:""

required

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

Available options:

BUY,

SELL

order.client_order_id

string

required

The unique ID provided for the order (used for identification purposes).

Example:

"11111-000000-000000"

order.status

enum<string>

default:PENDING

required

The current state of the order

Available options:

PENDING,

OPEN,

FILLED,

CANCELLED,

EXPIRED,

FAILED,

UNKNOWN_ORDER_STATUS,

QUEUED,

CANCEL_QUEUED,

EDIT_QUEUED

order.created_time

string<RFC3339 Timestamp>

required

Timestamp for when the order was created

Example:

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

order.completion_percentage

string

required

The percent of total order amount that has been filled

Example:

"50"

order.average_filled_price

string

required

The average of all prices of fills for this order

Example:

"50"

order.number_of_fills

string

required

Number of fills that have been posted for this order

Example:

"2"

order.pending_cancel

boolean

required

Whether a cancel request has been initiated for the order, and not yet completed

Example:

true

order.size_in_quote

boolean

required

Whether the order was placed with quote currency

Example:

false

order.total_fees

string

required

The total fees for the order

Example:

"5.00"

order.size_inclusive_of_fees

boolean

required

Whether the order size includes fees

Example:

false

order.total_value_after_fees

string

required

derived field: filled_value + total_fees for buy orders and filled_value - total_fees for sell orders.

order.time_in_force

enum<string>

default:UNKNOWN_TIME_IN_FORCE

The client specified window for which the order can remain active

Available options:

UNKNOWN_TIME_IN_FORCE,

GOOD_UNTIL_DATE_TIME,

GOOD_UNTIL_CANCELLED,

IMMEDIATE_OR_CANCEL,

FILL_OR_KILL

order.filled_size

string

The portion (in base currency) of total order amount that has been filled

Example:

"0.001"

order.fee

string

(Deprecated) Commission amount

order.filled_value

string

The portion (in quote current) of total order amount that has been filled

Example:

"10000"

order.trigger_status

enum<string>

default:UNKNOWN_TRIGGER_STATUS

The trigger status of the order, with respect to stop price.

Available options:

UNKNOWN_TRIGGER_STATUS,

INVALID_ORDER_TYPE,

STOP_PENDING,

STOP_TRIGGERED

order.order_type

enum<string>

default:UNKNOWN_ORDER_TYPE

Type of the order

Available options:

UNKNOWN_ORDER_TYPE,

MARKET,

LIMIT,

STOP,

STOP_LIMIT,

BRACKET,

TWAP,

ROLL_OPEN,

ROLL_CLOSE,

LIQUIDATION,

SCALED

order.reject_reason

enum<string>

default:REJECT_REASON_UNSPECIFIED

Reason the order was rejected.

Available options:

REJECT_REASON_UNSPECIFIED,

HOLD_FAILURE,

TOO_MANY_OPEN_ORDERS,

REJECT_REASON_INSUFFICIENT_FUNDS,

RATE_LIMIT_EXCEEDED

order.settled

boolean

True if the order is fully filled, false otherwise.

order.product_type

enum<string>

default:UNKNOWN_PRODUCT_TYPE

The type of order, i.e. Spot or Future

Available options:

UNKNOWN_PRODUCT_TYPE,

SPOT,

FUTURE

order.reject_message

string

Message stating why the order was rejected.

order.cancel_message

string

Message stating why the order was canceled.

order.order_placement_source

enum<string>

default:UNKNOWN_PLACEMENT_SOURCE

Message stating which source an order was placed from.

Available options:

UNKNOWN_PLACEMENT_SOURCE,

RETAIL_SIMPLE,

RETAIL_ADVANCED

order.outstanding_hold_amount

string

The remaining hold amount (holdAmount - holdAmountReleased). [value is 0 if holdReleased is true]

order.is_liquidation

boolean

True if order is of liquidation type.

order.last_fill_time

string<RFC3339 Timestamp>

Time of the most recent fill for this order

order.edit_history

object[]

An array of the latest 5 edits per order

Show child attributes

order.edit_history.price

string

The update price of the order.

Example:

"19000.00"

order.edit_history.size

string

The updated size of the order.

Example:

"0.001"

order.edit_history.replace_accept_timestamp

string<RFC3339 Timestamp>

order.leverage

string

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

order.margin_type

enum<string>

default:""

Margin Type for this order (default is CROSS).

Available options:

CROSS,

ISOLATED

order.retail_portfolio_id

string

The ID of the portfolio this order is associated with.

Example:

"b87a2d3f-8a1e-49b3-a4ea-402d8c389aca"

order.originating_order_id

string

The ID of the parent order of an attached order.

Example:

"b87a2d3f-8a1e-49b3-a4ea-402d8c389aca"

order.attached_order_id

string

The ID of the attached order of a parent order.

Example:

"b87a2d3f-8a1e-49b3-a4ea-402d8c389aca"

order.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 originating or parent order.

Show child attributes

order.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

order.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"

order.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"

order.attached_order_configuration.market_market_fok

object

Show child attributes

order.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"

order.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"

order.attached_order_configuration.sor_limit_ioc

object

Show child attributes

order.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"

order.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"

order.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"

order.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

order.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"

order.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"

order.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"

order.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

order.attached_order_configuration.limit_limit_gtd

object

Show child attributes

order.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"

order.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"

order.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"

order.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"

order.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

order.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

order.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"

order.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"

order.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"

order.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

order.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"

order.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"

order.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"

order.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"

order.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"

order.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"

order.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"

order.attached_order_configuration.twap_limit_gtd.bucket_duration

string

The duration over which each sub order was executed

Example:

"300s"

order.attached_order_configuration.stop_limit_stop_limit_gtc

object

Show child attributes

order.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"

order.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"

order.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"

order.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"

order.attached_order_configuration.stop_limit_stop_limit_gtd

object

Show child attributes

order.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

order.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"

order.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"

order.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"

order.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"

order.attached_order_configuration.trigger_bracket_gtc

object

Show child attributes

order.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

order.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"

order.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"

order.attached_order_configuration.trigger_bracket_gtd

object

Show child attributes

order.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

order.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"

order.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"

order.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"

order.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

order.attached_order_configuration.scaled_limit_gtc.orders

object[]

Show child attributes

order.attached_order_configuration.scaled_limit_gtc.orders.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.attached_order_configuration.scaled_limit_gtc.orders.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.attached_order_configuration.scaled_limit_gtc.orders.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.attached_order_configuration.scaled_limit_gtc.orders.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.attached_order_configuration.scaled_limit_gtc.quote_size

string

order.attached_order_configuration.scaled_limit_gtc.base_size

string

order.attached_order_configuration.scaled_limit_gtc.num_orders

integer<int32>

order.attached_order_configuration.scaled_limit_gtc.min_price

string

order.attached_order_configuration.scaled_limit_gtc.max_price

string

order.attached_order_configuration.scaled_limit_gtc.price_distribution

enum<string>

default:FLAT

Available options:

FLAT,

LINEAR_INCREASING,

LINEAR_DECREASING

order.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

order.attached_order_configuration.scaled_limit_gtc.size_diff

string

order.attached_order_configuration.scaled_limit_gtc.size_ratio

string

order.current_pending_replace

object

Price/Size of the current edit

Show child attributes

order.current_pending_replace.price

string

The update price of the order.

Example:

"19000.00"

order.current_pending_replace.size

string

The updated size of the order.

Example:

"0.001"

order.current_pending_replace.replace_accept_timestamp

string<RFC3339 Timestamp>

order.commission_detail_total

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

Breakdown of commission charges for the order

Show child attributes

order.commission_detail_total.total_commission

string

order.commission_detail_total.gst_commission

string

order.commission_detail_total.withholding_commission

string

order.commission_detail_total.client_commission

string

order.commission_detail_total.venue_commission

string

order.commission_detail_total.regulatory_commission

string

order.commission_detail_total.clearing_commission

string

order.workable_size

string

The size of order in the originating order which is filled.

Example:

"3"

order.workable_size_completion_pct

string

Percentage of the originating order which is filled

Example:

"50"

order.product_details

Product details, where the oneof corresponds to the ProductType Currently skipping FutureProductDetails as it's not used · object

Product-specific details, the oneof corresponds to the ProductType

Show child attributes

order.product_details.equity_details

Equity-specific product details · object

Show child attributes

order.product_details.equity_details.base_cbrn

string

order.product_details.equity_details.ticker

string

order.product_details.equity_details.quote_id

string

order.cost_basis_method

enum<string>

default:COST_BASIS_METHOD_UNSPECIFIED

The cost basis method for the order

Available options:

COST_BASIS_METHOD_UNSPECIFIED,

COST_BASIS_METHOD_HIFO,

COST_BASIS_METHOD_LIFO,

COST_BASIS_METHOD_FIFO

order.displayed_order_config

enum<string>

default:UNKNOWN_DISPLAYED_ORDER_CONFIG

Indicates how an order configuration is displayed to the user by the front end

Available options:

UNKNOWN_DISPLAYED_ORDER_CONFIG,

INSTANT_GFD,

LIMIT_GFD

order.equity_trading_session

enum<string>

default:UNKNOWN_EQUITY_TRADING_SESSION

Trading session for equity orders

Available options:

UNKNOWN_EQUITY_TRADING_SESSION,

EQUITY_TRADING_SESSION_NORMAL,

EQUITY_TRADING_SESSION_AFTER_HOURS,

EQUITY_TRADING_SESSION_MULTI_SESSION,

EQUITY_TRADING_SESSION_OVERNIGHT,

EQUITY_TRADING_SESSION_PRE_MARKET

REST API

Authorizations

Path Parameters

Query Parameters

Response