Cancel Order

DELETE

orders

{order_id}

Cancel Order

curl --request DELETE \
  --url https://api.polysimulator.com/v1/orders/{order_id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.polysimulator.com/v1/orders/{order_id}', 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/orders/{order_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polysimulator.com/v1/orders/{order_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/orders/{order_id}")

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

request = Net::HTTP::Delete.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "order_id": 123,
  "status": "<string>",
  "order_type": "<string>",
  "side": "<string>",
  "outcome": "<string>",
  "price": "<string>",
  "quantity": "<string>",
  "notional": "<string>",
  "fee": "<string>",
  "filled_at": "<string>",
  "cancelled_reason": "<string>",
  "price_source": "<string>",
  "fill_source": "<string>",
  "slippage_bps": 123,
  "quote_age_ms": 123,
  "spread_bps": 123,
  "impact_bps": 123,
  "book_walk_levels": 123,
  "account_balance": "<string>",
  "position": {},
  "client_order_id": "<string>",
  "magic": 123,
  "magic_label": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "amount_interpreted_as": "<string>",
  "is_replay": true,
  "warnings": [
    "<string>"
  ]
}

{
  "order_id": 123,
  "client_order_id": "<string>",
  "order_type": "<string>",
  "side": "<string>",
  "outcome": "<string>",
  "market_id": "<string>",
  "quantity_requested": "<string>",
  "accepted_at": "<string>",
  "status": "accepted",
  "price_requested": "<string>",
  "is_replay": false
}

{
  "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.

Path Parameters

order_id

integer

required

Response

Successful Response

order_id

integer

required

status

string

required

order_type

string

required

side

string

required

outcome

string

required

price

string

required

quantity

string

required

notional

string

required

fee

string

required

filled_at

string | null

cancelled_reason

string | null

Why a CANCELLED order was cancelled - a stable snake_case machine tag. An order cancelled inside the request that created it (a marketable IOC/FAK that could not fill) reports the no-fill cause, for example 'price_did_not_cross', 'fok_insufficient_depth', 'book_depleted', 'depth_required', 'no_live_price' or 'no_book_price'. An order cancelled while resting on the book reports for example 'gtd_expired', 'stale_market', 'stale_or_mismatched_book' or 'reset'. Null on non-cancelled statuses and on legacy rows, so branch on status to detect cancellation and on this field to learn the cause.

price_source

string | null

fill_source

string | null

slippage_bps

integer | null

quote_age_ms

integer | null

spread_bps

integer | null

impact_bps

integer | null

book_walk_levels

integer | null

account_balance

string | null

position

Position · object | null

client_order_id

string | null

magic

integer | null

magic_label

string | null

error

string | null

error_message

string | null

amount_interpreted_as

string | null

is_replay

boolean | null

warnings

string[] | null

Cancel Order

curl --request DELETE \
  --url https://api.polysimulator.com/v1/orders/{order_id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.polysimulator.com/v1/orders/{order_id}', 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/orders/{order_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polysimulator.com/v1/orders/{order_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/orders/{order_id}")

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

request = Net::HTTP::Delete.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "order_id": 123,
  "status": "<string>",
  "order_type": "<string>",
  "side": "<string>",
  "outcome": "<string>",
  "price": "<string>",
  "quantity": "<string>",
  "notional": "<string>",
  "fee": "<string>",
  "filled_at": "<string>",
  "cancelled_reason": "<string>",
  "price_source": "<string>",
  "fill_source": "<string>",
  "slippage_bps": 123,
  "quote_age_ms": 123,
  "spread_bps": 123,
  "impact_bps": 123,
  "book_walk_levels": 123,
  "account_balance": "<string>",
  "position": {},
  "client_order_id": "<string>",
  "magic": 123,
  "magic_label": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "amount_interpreted_as": "<string>",
  "is_replay": true,
  "warnings": [
    "<string>"
  ]
}

{
  "order_id": 123,
  "client_order_id": "<string>",
  "order_type": "<string>",
  "side": "<string>",
  "outcome": "<string>",
  "market_id": "<string>",
  "quantity_requested": "<string>",
  "accepted_at": "<string>",
  "status": "accepted",
  "price_requested": "<string>",
  "is_replay": false
}

{
  "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

Path Parameters

Response