Skip to main content
POST
/
v1
/
trading
/
orders
/
preview
Preview order
curl --request POST \
  --url https://api.polymarketexchange.com/v1/trading/orders/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "request": {
    "type": "ORDER_TYPE_MARKET_TO_LIMIT",
    "side": "SIDE_BUY",
    "orderQty": "<string>",
    "symbol": "<string>",
    "price": "<string>",
    "timeInForce": "TIME_IN_FORCE_DAY",
    "clordId": "<string>",
    "account": "<string>",
    "stopPrice": "<string>",
    "minQty": "<string>",
    "selfMatchPreventionId": "<string>",
    "quote": "<string>",
    "allOrNone": true,
    "sessionId": "<string>",
    "user": "<string>",
    "clientAccountId": "<string>",
    "clientParticipantId": "<string>",
    "participateDontInitiate": true,
    "cashOrderQty": "<string>",
    "strictLimit": true,
    "goodTillTime": "2023-11-07T05:31:56Z",
    "bestLimit": true,
    "immediatelyExecutableLimit": true,
    "selfMatchPreventionInstruction": "SELF_MATCH_PREVENTION_INSTRUCTION_REJECT_AGGRESSOR",
    "orderCapacity": "ORDER_CAPACITY_AGENCY",
    "ignorePriceValidityChecks": true,
    "manualOrderIndicator": "MANUAL_ORDER_INDICATOR_MANUAL"
  }
}
'
{
  "previewOrder": {
    "id": "<string>",
    "type": "ORDER_TYPE_MARKET_TO_LIMIT",
    "side": "SIDE_BUY",
    "orderQty": "<string>",
    "symbol": "<string>",
    "clordId": "<string>",
    "timeInForce": "TIME_IN_FORCE_DAY",
    "account": "<string>",
    "cumQty": "<string>",
    "avgPx": "<string>",
    "leavesQty": "<string>",
    "state": "ORDER_STATE_PARTIALLY_FILLED",
    "participant": "<string>",
    "price": "<string>",
    "insertTime": "2023-11-07T05:31:56Z",
    "stopPrice": "<string>",
    "minQty": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "allOrNone": true,
    "crossId": "<string>",
    "hostCrossId": "<string>",
    "submittingParticipant": "<string>",
    "clientAccountId": "<string>",
    "clientParticipantId": "<string>",
    "parentOrderId": "<string>",
    "commissionsBasisPoints": "<string>",
    "participateDontInitiate": true,
    "cashOrderQty": "<string>",
    "strictLimit": true,
    "goodTillTime": "2023-11-07T05:31:56Z",
    "bestLimit": true,
    "immediatelyExecutableLimit": true,
    "lastTradeId": "<string>",
    "commissionNotionalTotalCollected": "<string>",
    "selfMatchPreventionInstruction": "SELF_MATCH_PREVENTION_INSTRUCTION_REJECT_AGGRESSOR",
    "orderCapacity": "ORDER_CAPACITY_AGENCY",
    "ignorePriceValidityChecks": true,
    "lastTransactTime": "2023-11-07T05:31:56Z",
    "makerCommissionsBasisPoints": "<string>",
    "manualOrderIndicator": "MANUAL_ORDER_INDICATOR_MANUAL"
  }
}

Body

application/json
request
object

Response

200 - application/json

A successful response.

previewOrder
object