Interface: AdvTradeGlobalPlaceOrderRequest
Properties
| Property | Type | Description |
|---|---|---|
advanced? | AdvTradeGlobalRequestAdvanced | Advanced option order type. (Only for options. Advanced USD orders are not supported for linear options.) |
allocated_margin? | number | Optional initial margin amount transferred from the main account to the isolated subaccount for this order. Only applicable when isolated = true. On risk-increasing orders, must meet the required minimum margin or placement fails with error 14033 (isolated_allocated_too_low). |
amount? | number | Requested order size. Use the base coin for spot, options, and linear instruments, including linear perpetuals. Use USD for inverse futures and inverse perpetuals. amount is required when contracts is omitted. If both are provided, they must specify the same size or the request fails. |
contracts? | number | It represents the requested order size in contract units and can be passed instead of amount. The contracts is a mandatory parameter if amount parameter is missing. If both contracts and amount parameter are passed they must match each other otherwise error is returned. |
display_amount? | number | Initial display amount for iceberg order. Has to be at least 100 times minimum amount for instrument and ratio of hidden part vs visible part has to be less than 100 as well. |
instrument_name | string | Instrument name |
isolated? | boolean | If true, places the order under isolated margin mode. A managed subaccount is claimed or provisioned and bound to the instrument. Available to main accounts for futures orders only; not supported for algo, advanced, or linked orders. Default - false |
label? | string | user defined label for the order (maximum 64 characters) |
linked_order_type? | | "one_triggers_other" | "one_cancels_other" | "one_triggers_one_cancels_other" | The type of the linked order. "one_triggers_other" - Execution of primary order triggers the placement of one or more secondary orders. "one_cancels_other" - The execution of one order in a pair automatically cancels the other, typically used to set a stop-loss and take-profit simultaneously. "one_triggers_one_cancels_other" - The execution of a primary order triggers two secondary orders (a stop-loss and take-profit pair), where the execution of one secondary order cancels the other. |
mmp? | boolean | Order MMP flag, only for order_type 'limit' |
otoco_config? | AdvTradeGlobalRequestOtocoConfig[] | List of secondary orders to place or cancel when the primary order is filled. Each entry in the array defines one secondary order. amount and direction are required; all other fields are optional. |
post_only? | boolean | Place a maker-only order. If the price would execute immediately, it is adjusted to remain on the maker side of the spread unless reject_post_only is true, in which case the order is rejected. Only valid with time_in_force: "good_til_cancelled". For spot orders routed to Coinbase Exchange, set reject_post_only: true; prices are never adjusted and orders that would match immediately are rejected. |
price? | number | Order price in the instrument’s price units. Required for limit and stop-limit orders. For option orders with advanced: "usd", specify the price in USD. With advanced: "implv", specify implied volatility as a percentage, for example 100 for 100%. |
reduce_only? | boolean | If true, the order is considered reduce-only which is intended to only reduce a current position |
reject_post_only? | boolean | If an order is considered post-only and this field is set to true then the order is put to the order book unmodified or the request is rejected. Only valid in combination with "post_only" set to true For spot trading routed to Coinbase Exchange, this must be set to true whenever "post_only" is true; otherwise the request is rejected with post_only_not_allowed. |
time_in_force? | | "good_til_cancelled" | "good_til_day" | "fill_or_kill" | "immediate_or_cancel" | Specifies how long the order remains in effect. Default "good_til_cancelled" "good_til_cancelled" - unfilled order remains in order book until cancelled "good_til_day" - unfilled order remains in order book till the end of the trading session "fill_or_kill" - execute a transaction immediately and completely or not at all "immediate_or_cancel" - execute a transaction immediately, and any portion of the order that cannot be immediately filled is cancelled For spot trading, only "good_til_cancelled", "immediate_or_cancel" and "fill_or_kill" are supported. "good_til_day" is not supported and will be rejected. |
trigger? | AdvTradeGlobalRequestTrigger | Defines the trigger type. Required for "Stop-Loss", "Take-Profit" and "Trailing" trigger orders For stop-limit orders routed to Coinbase Exchange, only "last_price" is allowed. |
trigger_fill_condition? | "first_hit" | "complete_fill" | "incremental" | The fill condition of the linked order (Only for linked order types), default: first_hit. "first_hit" - any execution of the primary order will fully cancel/place all secondary orders. "complete_fill" - a complete execution (meaning the primary order no longer exists) will cancel/place the secondary orders. "incremental" - any fill of the primary order will cause proportional partial cancellation/placement of the secondary order. The amount that will be subtracted/added to the secondary order will be rounded down to the contract size. |
trigger_offset? | number | The maximum deviation from the price peak beyond which the order will be triggered |
trigger_price? | number | Trigger price, required for trigger orders only (Stop-loss or Take-profit orders) |
type? | | "limit" | "trailing_stop" | "stop_limit" | "stop_market" | "take_limit" | "take_market" | "market" | "market_limit" | The order type, default: "limit" stop_limit, stop_market, take_limit, take_market, and trailing_stop (trigger/algo order types) are not supported for option and option_combo instruments. For spot trading routed to Coinbase Exchange, only "market", "limit" and "stop_limit" orders are supported. Other order types will be rejected. |
valid_until? | number | Timestamp, when provided server will start processing request in Matching Engine only before given timestamp, in other cases timed_out error will be responded. Remember that the given timestamp should be consistent with the server's time, use /public/time method to obtain current server time. |