Skip to main content
POST
/
v1
/
order
/
preview
Preview order
curl --request POST \
  --url https://api.polymarket.us/v1/order/preview \
  --header 'Content-Type: application/json' \
  --header 'X-PM-Access-Key: <api-key>' \
  --header 'X-PM-Signature: <api-key>' \
  --header 'X-PM-Timestamp: <api-key>' \
  --data '
{
  "request": {
    "marketSlug": "<string>",
    "intent": "ORDER_INTENT_BUY_LONG",
    "type": "ORDER_TYPE_LIMIT",
    "price": {
      "value": "0.55",
      "currency": "USD"
    },
    "quantity": 123,
    "tif": "TIME_IN_FORCE_GOOD_TILL_CANCEL",
    "participateDontInitiate": true,
    "goodTillTime": "<string>",
    "cashOrderQty": {
      "value": "0.55",
      "currency": "USD"
    },
    "manualOrderIndicator": "MANUAL_ORDER_INDICATOR_MANUAL",
    "synchronousExecution": true,
    "maxBlockTime": "<string>",
    "slippageTolerance": {
      "currentPrice": {
        "value": "0.55",
        "currency": "USD"
      },
      "bips": 123,
      "ticks": 123
    }
  }
}
'
{
  "order": {
    "id": "<string>",
    "marketSlug": "<string>",
    "side": "ORDER_SIDE_BUY",
    "type": "ORDER_TYPE_LIMIT",
    "price": {
      "value": "0.55",
      "currency": "USD"
    },
    "quantity": 123,
    "cumQuantity": 123,
    "leavesQuantity": 123,
    "tif": "TIME_IN_FORCE_GOOD_TILL_CANCEL",
    "goodTillTime": "2023-11-07T05:31:56Z",
    "intent": "ORDER_INTENT_BUY_LONG",
    "marketMetadata": {
      "slug": "<string>",
      "icon": "<string>",
      "title": "<string>",
      "outcome": "<string>",
      "eventSlug": "<string>",
      "teamId": 123,
      "team": {
        "id": 123,
        "name": "<string>",
        "abbreviation": "<string>",
        "league": "<string>",
        "record": "<string>",
        "logo": "<string>",
        "alias": "<string>",
        "safeName": "<string>",
        "homeIcon": "<string>",
        "awayIcon": "<string>",
        "colorPrimary": "<string>",
        "ordering": "<string>",
        "ranking": "<string>",
        "conference": "<string>"
      }
    },
    "state": "ORDER_STATE_PARTIALLY_FILLED",
    "commissionNotionalTotalCollected": {
      "value": "0.55",
      "currency": "USD"
    },
    "commissionsBasisPoints": "<string>",
    "makerCommissionsBasisPoints": "<string>",
    "avgPx": {
      "value": "0.55",
      "currency": "USD"
    },
    "cashOrderQty": {
      "value": "0.55",
      "currency": "USD"
    },
    "insertTime": "2023-11-07T05:31:56Z",
    "createTime": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-PM-Access-Key
string
header
required

Your API key ID (UUID). Generate at polymarket.us/developer.

X-PM-Timestamp
string
header
required

Unix timestamp in milliseconds. Must be within 30 seconds of server time.

X-PM-Signature
string
header
required

Base64-encoded Ed25519 signature of timestamp + method + path. See Authentication for details.

Body

application/json

Request to preview an order

Request to preview an order

request
object

The order to preview

Response

Order previewed successfully

Response containing previewed order

order
object

Previewed order with calculated values