Orders
Get Order Preview
Retrieve an order preview.
POST
Get Order Preview
Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples
For more information, please visit the Prime Java SDK.
- Java
- .NET
- Go
- Python
- CLI
- TS/JS
Body
application/json
- UNKNOWN_ORDER_TYPE: nil value
- MARKET: A market order
- LIMIT: A limit order
- TWAP: A time-weighted average price order
- BLOCK: A block trade
- VWAP: A volume-weighted average price order
- STOP_LIMIT: A conditional order combined of stop order and limit order
- RFQ: A request for quote
- PEG: A pegged order that dynamically adjust based on market conditions while maintaining execution discretion and avoiding adverse selection
Available options:
MARKET, LIMIT, TWAP, BLOCK, VWAP, STOP_LIMIT, RFQ, PEG - UNKNOWN_TIME_IN_FORCE: nil value
- GOOD_UNTIL_DATE_TIME: Expires at a certain date/time
- GOOD_UNTIL_CANCELLED: Order stays on the books until cancelled
- IMMEDIATE_OR_CANCEL: Order is executed immediately at submission or is cancelled
- FILL_OR_KILL: Order is executed immediately and fully at submission or is cancelled
Available options:
GOOD_UNTIL_DATE_TIME, GOOD_UNTIL_CANCELLED, IMMEDIATE_OR_CANCEL, FILL_OR_KILL - UNKNOWN_PEG_OFFSET_TYPE: nil value
- PEG_OFFSET_TYPE_PRICE: Offset specified in price units
- PEG_OFFSET_TYPE_BPS: Offset specified in basis points (BPS)
- PEG_OFFSET_TYPE_DEPTH: Offset specified in depth
Available options:
PEG_OFFSET_TYPE_PRICE, PEG_OFFSET_TYPE_BPS, PEG_OFFSET_TYPE_DEPTH Response
200 - application/json
A successful response.
- UNKNOWN_ORDER_TYPE: nil value
- MARKET: A market order
- LIMIT: A limit order
- TWAP: A time-weighted average price order
- BLOCK: A block trade
- VWAP: A volume-weighted average price order
- STOP_LIMIT: A conditional order combined of stop order and limit order
- RFQ: A request for quote
- PEG: A pegged order that dynamically adjust based on market conditions while maintaining execution discretion and avoiding adverse selection
Available options:
MARKET, LIMIT, TWAP, BLOCK, VWAP, STOP_LIMIT, RFQ, PEG - UNKNOWN_TIME_IN_FORCE: nil value
- GOOD_UNTIL_DATE_TIME: Expires at a certain date/time
- GOOD_UNTIL_CANCELLED: Order stays on the books until cancelled
- IMMEDIATE_OR_CANCEL: Order is executed immediately at submission or is cancelled
- FILL_OR_KILL: Order is executed immediately and fully at submission or is cancelled
Available options:
GOOD_UNTIL_DATE_TIME, GOOD_UNTIL_CANCELLED, IMMEDIATE_OR_CANCEL, FILL_OR_KILL