Skip to main content
POST
/
v1
/
trading
/
orders
/
preview
Preview order
curl --request POST \
  --url https://api.prod.polymarketexchange.com/v1/trading/orders/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "request": {
    "orderQty": "<string>",
    "symbol": "<string>",
    "price": "<string>",
    "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,
    "ignorePriceValidityChecks": true
  }
}
'
import requests

url = "https://api.prod.polymarketexchange.com/v1/trading/orders/preview"

payload = { "request": {
"orderQty": "<string>",
"symbol": "<string>",
"price": "<string>",
"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,
"ignorePriceValidityChecks": True
} }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
request: {
orderQty: '<string>',
symbol: '<string>',
price: '<string>',
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,
ignorePriceValidityChecks: true
}
})
};

fetch('https://api.prod.polymarketexchange.com/v1/trading/orders/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.polymarketexchange.com/v1/trading/orders/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'request' => [
'orderQty' => '<string>',
'symbol' => '<string>',
'price' => '<string>',
'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,
'ignorePriceValidityChecks' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.prod.polymarketexchange.com/v1/trading/orders/preview"

payload := strings.NewReader("{\n \"request\": {\n \"orderQty\": \"<string>\",\n \"symbol\": \"<string>\",\n \"price\": \"<string>\",\n \"clordId\": \"<string>\",\n \"account\": \"<string>\",\n \"stopPrice\": \"<string>\",\n \"minQty\": \"<string>\",\n \"selfMatchPreventionId\": \"<string>\",\n \"quote\": \"<string>\",\n \"allOrNone\": true,\n \"sessionId\": \"<string>\",\n \"user\": \"<string>\",\n \"clientAccountId\": \"<string>\",\n \"clientParticipantId\": \"<string>\",\n \"participateDontInitiate\": true,\n \"cashOrderQty\": \"<string>\",\n \"strictLimit\": true,\n \"goodTillTime\": \"2023-11-07T05:31:56Z\",\n \"bestLimit\": true,\n \"immediatelyExecutableLimit\": true,\n \"ignorePriceValidityChecks\": true\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.prod.polymarketexchange.com/v1/trading/orders/preview")
.header("Content-Type", "application/json")
.body("{\n \"request\": {\n \"orderQty\": \"<string>\",\n \"symbol\": \"<string>\",\n \"price\": \"<string>\",\n \"clordId\": \"<string>\",\n \"account\": \"<string>\",\n \"stopPrice\": \"<string>\",\n \"minQty\": \"<string>\",\n \"selfMatchPreventionId\": \"<string>\",\n \"quote\": \"<string>\",\n \"allOrNone\": true,\n \"sessionId\": \"<string>\",\n \"user\": \"<string>\",\n \"clientAccountId\": \"<string>\",\n \"clientParticipantId\": \"<string>\",\n \"participateDontInitiate\": true,\n \"cashOrderQty\": \"<string>\",\n \"strictLimit\": true,\n \"goodTillTime\": \"2023-11-07T05:31:56Z\",\n \"bestLimit\": true,\n \"immediatelyExecutableLimit\": true,\n \"ignorePriceValidityChecks\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.prod.polymarketexchange.com/v1/trading/orders/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"request\": {\n \"orderQty\": \"<string>\",\n \"symbol\": \"<string>\",\n \"price\": \"<string>\",\n \"clordId\": \"<string>\",\n \"account\": \"<string>\",\n \"stopPrice\": \"<string>\",\n \"minQty\": \"<string>\",\n \"selfMatchPreventionId\": \"<string>\",\n \"quote\": \"<string>\",\n \"allOrNone\": true,\n \"sessionId\": \"<string>\",\n \"user\": \"<string>\",\n \"clientAccountId\": \"<string>\",\n \"clientParticipantId\": \"<string>\",\n \"participateDontInitiate\": true,\n \"cashOrderQty\": \"<string>\",\n \"strictLimit\": true,\n \"goodTillTime\": \"2023-11-07T05:31:56Z\",\n \"bestLimit\": true,\n \"immediatelyExecutableLimit\": true,\n \"ignorePriceValidityChecks\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "previewOrder": {
    "id": "<string>",
    "orderQty": "<string>",
    "symbol": "<string>",
    "clordId": "<string>",
    "account": "<string>",
    "cumQty": "<string>",
    "avgPx": "<string>",
    "leavesQty": "<string>",
    "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>",
    "ignorePriceValidityChecks": true,
    "lastTransactTime": "2023-11-07T05:31:56Z",
    "makerCommissionsBasisPoints": "<string>",
    "fractionalQuantityScale": "<string>",
    "priceToQuantityFilled": {}
  }
}

Body

application/json
request
object

Response

200 - application/json

A successful response.

previewOrder
object