preview_order
Preview an order to project margin, equity, and fee impact without submitting to the matching engine. Takes the same arguments as placing an order but does not execute.
Instructions
Preview an order without submitting it: projects the margin, equity, and fee impact of the order. Takes the same arguments as place_order. Nothing reaches the matching engine. Requires API credentials.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| side | Yes | Order side. | |
| size | Yes | Order quantity in base units, as a positive decimal string (> 0). | |
| type | Yes | Order type. | |
| price | No | Limit price as a positive decimal string (> 0). Required for limit orders, ignored for market. | |
| market_id | Yes | Market id, e.g. "BTC-USDX-PERP". | |
| reduce_only | No | If true, only reduces an existing position. | |
| time_in_force | No | Time in force. Defaults to GTC for limit, IOC for market. `PostOnly` rejects the order if it would take liquidity on entry, guaranteeing it rests as a maker. |