Clob Order

POST

clob

order

Clob Order

curl --request POST \
  --url https://api.polysimulator.com/v1/clob/order \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "token_id": "<string>",
  "price": "<string>",
  "quantity": "<string>",
  "order_type": "GTC",
  "fee_rate_bps": 1,
  "nonce": "<string>",
  "taker": "<string>",
  "client_order_id": "<string>",
  "expiration": "<string>",
  "post_only": false,
  "magic": 4611686018427388000,
  "magic_label": "<string>"
}
'

import requests

url = "https://api.polysimulator.com/v1/clob/order"

payload = {
    "token_id": "<string>",
    "price": "<string>",
    "quantity": "<string>",
    "order_type": "GTC",
    "fee_rate_bps": 1,
    "nonce": "<string>",
    "taker": "<string>",
    "client_order_id": "<string>",
    "expiration": "<string>",
    "post_only": False,
    "magic": 4611686018427388000,
    "magic_label": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    token_id: '<string>',
    price: '<string>',
    quantity: '<string>',
    order_type: 'GTC',
    fee_rate_bps: 1,
    nonce: '<string>',
    taker: '<string>',
    client_order_id: '<string>',
    expiration: '<string>',
    post_only: false,
    magic: 4611686018427388000,
    magic_label: '<string>'
  })
};

fetch('https://api.polysimulator.com/v1/clob/order', 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.polysimulator.com/v1/clob/order",
  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([
    'token_id' => '<string>',
    'price' => '<string>',
    'quantity' => '<string>',
    'order_type' => 'GTC',
    'fee_rate_bps' => 1,
    'nonce' => '<string>',
    'taker' => '<string>',
    'client_order_id' => '<string>',
    'expiration' => '<string>',
    'post_only' => false,
    'magic' => 4611686018427388000,
    'magic_label' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.polysimulator.com/v1/clob/order"

	payload := strings.NewReader("{\n  \"token_id\": \"<string>\",\n  \"price\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"order_type\": \"GTC\",\n  \"fee_rate_bps\": 1,\n  \"nonce\": \"<string>\",\n  \"taker\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"expiration\": \"<string>\",\n  \"post_only\": false,\n  \"magic\": 4611686018427388000,\n  \"magic_label\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.polysimulator.com/v1/clob/order")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"token_id\": \"<string>\",\n  \"price\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"order_type\": \"GTC\",\n  \"fee_rate_bps\": 1,\n  \"nonce\": \"<string>\",\n  \"taker\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"expiration\": \"<string>\",\n  \"post_only\": false,\n  \"magic\": 4611686018427388000,\n  \"magic_label\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/clob/order")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"token_id\": \"<string>\",\n  \"price\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"order_type\": \"GTC\",\n  \"fee_rate_bps\": 1,\n  \"nonce\": \"<string>\",\n  \"taker\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"expiration\": \"<string>\",\n  \"post_only\": false,\n  \"magic\": 4611686018427388000,\n  \"magic_label\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "orderID": "<string>",
  "status": "<string>",
  "price": "<string>",
  "size": "<string>",
  "side": "<string>",
  "success": true,
  "transactID": "<string>",
  "errorMsg": "<string>",
  "takingAmount": "<string>",
  "makingAmount": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

Authorizations

X-API-Key

string

header

required

Issue from /v1/keys (or admin-issued for enterprise tier).

Headers

X-API-Key

string | null

Your PolySimulator API key

POLY_API_KEY

string | null

Polymarket-CLOB-compat alias for X-API-Key (underscore form). SDK clients ported from Polymarket can authenticate without changing header names. X-API-Key takes precedence when both are provided.

Poly-API-Key

string | null

PM-CLOB-compat dashed-form alias for X-API-Key. Same value semantics as POLY_API_KEY but with HTTP-conventional dash separators. Both spellings are accepted end-to-end.

authorization

string | null

PM-CLOB-compat: Authorization: Bearer ps_live_... (or ps_test_...) is accepted as an alias for X-API-Key so py-clob-client and other ported SDKs authenticate without header name changes. Bearer JWTs are NOT accepted here — use the dashboard-auth endpoints for those.

Body

application/json

CLOB-compatible order request using token_id instead of condition_id.

Mirrors the real Polymarket CLOB API POST /order schema so a bot written for Polymarket's order fields can be tested here. Orders are only simulated; PolySimulator never forwards them to Polymarket.

token_id

string

required

CLOB token ID

side

enum<string>

required

Available options:

BUY,

SELL

price

string

required

Limit price as decimal string (0.01-1.00)

quantity

string

required

Number of shares as decimal string

order_type

enum<string>

default:GTC

Available options:

GTC,

FOK,

IOC,

GTD

fee_rate_bps

integer | null

Fee rate in basis points (ignored in virtual mode)

Required range: x >= 0

nonce

string | null

Optional nonce (ignored in virtual mode)

taker

string | null

Optional taker address (ignored in virtual mode)

client_order_id

string | null

Maximum string length: 256

expiration

string | null

Unix-seconds expiration for order_type=GTD (PM convention). Honored while ORDER_SEMANTICS_PM_V2_ENABLED is rolling out; otherwise advisory (GTD routes through GTC).

post_only

boolean | null

default:false

PM's postOnly: reject (don't execute) when marketable at placement; GTC/GTD only. Rolling out behind ORDER_SEMANTICS_PM_V2_ENABLED; advisory until then.

magic

integer | null

Bot / strategy identifier (MetaTrader 5 style magic number), 0..9223372036854775807. Not unique: every order a bot places can share it, so the bot can later filter GET /v1/orders, export trades and cancel-all with ?magic= without touching other bots on the same account. Omitted: the API key's default_magic applies, if configured.

Required range: 0 <= x <= 9223372036854776000

magic_label

string | null

Optional human-readable bot name shown next to the magic number (max 32 printable characters, trimmed; blank means none), e.g. 'arb-v1'. Omitted: the API key's default_magic_label applies, if configured.

Maximum string length: 32

Response

Successful Response

Response matching Polymarket CLOB order response shape.

orderID

string

required

status

string

required

price

string

required

size

string

required

side

string

required

success

boolean

default:true

transactID

string | null

errorMsg

string | null

takingAmount

string | null

makingAmount

string | null

Clob Order

curl --request POST \
  --url https://api.polysimulator.com/v1/clob/order \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "token_id": "<string>",
  "price": "<string>",
  "quantity": "<string>",
  "order_type": "GTC",
  "fee_rate_bps": 1,
  "nonce": "<string>",
  "taker": "<string>",
  "client_order_id": "<string>",
  "expiration": "<string>",
  "post_only": false,
  "magic": 4611686018427388000,
  "magic_label": "<string>"
}
'

import requests

url = "https://api.polysimulator.com/v1/clob/order"

payload = {
    "token_id": "<string>",
    "price": "<string>",
    "quantity": "<string>",
    "order_type": "GTC",
    "fee_rate_bps": 1,
    "nonce": "<string>",
    "taker": "<string>",
    "client_order_id": "<string>",
    "expiration": "<string>",
    "post_only": False,
    "magic": 4611686018427388000,
    "magic_label": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    token_id: '<string>',
    price: '<string>',
    quantity: '<string>',
    order_type: 'GTC',
    fee_rate_bps: 1,
    nonce: '<string>',
    taker: '<string>',
    client_order_id: '<string>',
    expiration: '<string>',
    post_only: false,
    magic: 4611686018427388000,
    magic_label: '<string>'
  })
};

fetch('https://api.polysimulator.com/v1/clob/order', 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.polysimulator.com/v1/clob/order",
  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([
    'token_id' => '<string>',
    'price' => '<string>',
    'quantity' => '<string>',
    'order_type' => 'GTC',
    'fee_rate_bps' => 1,
    'nonce' => '<string>',
    'taker' => '<string>',
    'client_order_id' => '<string>',
    'expiration' => '<string>',
    'post_only' => false,
    'magic' => 4611686018427388000,
    'magic_label' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.polysimulator.com/v1/clob/order"

	payload := strings.NewReader("{\n  \"token_id\": \"<string>\",\n  \"price\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"order_type\": \"GTC\",\n  \"fee_rate_bps\": 1,\n  \"nonce\": \"<string>\",\n  \"taker\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"expiration\": \"<string>\",\n  \"post_only\": false,\n  \"magic\": 4611686018427388000,\n  \"magic_label\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.polysimulator.com/v1/clob/order")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"token_id\": \"<string>\",\n  \"price\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"order_type\": \"GTC\",\n  \"fee_rate_bps\": 1,\n  \"nonce\": \"<string>\",\n  \"taker\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"expiration\": \"<string>\",\n  \"post_only\": false,\n  \"magic\": 4611686018427388000,\n  \"magic_label\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/clob/order")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"token_id\": \"<string>\",\n  \"price\": \"<string>\",\n  \"quantity\": \"<string>\",\n  \"order_type\": \"GTC\",\n  \"fee_rate_bps\": 1,\n  \"nonce\": \"<string>\",\n  \"taker\": \"<string>\",\n  \"client_order_id\": \"<string>\",\n  \"expiration\": \"<string>\",\n  \"post_only\": false,\n  \"magic\": 4611686018427388000,\n  \"magic_label\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "orderID": "<string>",
  "status": "<string>",
  "price": "<string>",
  "size": "<string>",
  "side": "<string>",
  "success": true,
  "transactID": "<string>",
  "errorMsg": "<string>",
  "takingAmount": "<string>",
  "makingAmount": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

Overview

Endpoints

Authorizations

Headers

Body

Response