CLOB Compat

Get USDC + conditional-token balance/allowance (PM keys — paper trading: huge)

PM-compat GET /balance-allowance. py-clob-client calls this before every order to pre-flight that the connected wallet has approved spending on the on-chain Exchange contract. Polysim is paper-trading — there’s no on-chain allowance — so we return effectively-unlimited sentinel values under PM’s keys (balance / allowance, base-unit strings: 1.00 USDC = "1000000"), letting the SDK satisfy its pre-flight check and proceed to /v1/orders. These sentinels are NOT your simulated cash balance — read GET /v1/account/balance for real sizing decisions. The legacy collateral / conditional keys (decimal dollars) remain as polysim extras. asset_type (COLLATERAL default | CONDITIONAL) and token_id / signature_type are accepted per the PM SDK call shape; both asset types report the same unlimited sentinel.

GET

balance-allowance

curl --request GET \
  --url https://api.polysimulator.com/v1/balance-allowance \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.polysimulator.com/v1/balance-allowance"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.polysimulator.com/v1/balance-allowance', 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/balance-allowance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/balance-allowance"

	req, _ := http.NewRequest("GET", 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))

}

HttpResponse<String> response = Unirest.get("https://api.polysimulator.com/v1/balance-allowance")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/balance-allowance")

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

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

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

{
  "balance": "<string>",
  "allowance": "<string>",
  "collateral": "<string>",
  "conditional": "<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

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.

Query Parameters

asset_type

string | null

PM SDK param: COLLATERAL (default) or CONDITIONAL. Accepted for call-shape parity; paper trading reports the same unlimited sentinel for both.

token_id

string | null

PM SDK param — the conditional token to query (PM requires it when asset_type=CONDITIONAL). Accepted and unused: paper trading has no per-token allowance.

signature_type

integer | null

PM SDK param. Accepted and unused (no chain here).

Response

Successful Response

GET /v1/balance-allowance response — PM keys + legacy extras.

balance

string

required

allowance

string

required

collateral

string

required

conditional

string

required

List user trades (PM-compat — reads from filled orders).PM-compat ``GET /data/trades``. py-clob-client uses this in bot fill-tracking loops to surface fills the client can correlate by ``client_order_id`` or ``id``. Polysim reads from the ``orders`` table where ``status='FILLED'`` and emits PM-shape rows. Filters: ``market``, ``asset_id``, ``before`` / ``after`` (unix-seconds timestamps, PM convention), ``next_cursor`` / ``cursor`` (same semantics as ``/v1/data/orders``). AF-13: end-of-list ``next_cursor`` is ``"LTE="`` (base64 of ``-1``) matching py-clob-client's documented exit condition.

Get USDC + conditional-token balance/allowance (PM keys — paper trading: huge)

curl --request GET \
  --url https://api.polysimulator.com/v1/balance-allowance \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.polysimulator.com/v1/balance-allowance"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.polysimulator.com/v1/balance-allowance', 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/balance-allowance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/balance-allowance"

	req, _ := http.NewRequest("GET", 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))

}

HttpResponse<String> response = Unirest.get("https://api.polysimulator.com/v1/balance-allowance")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/balance-allowance")

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

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

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

{
  "balance": "<string>",
  "allowance": "<string>",
  "collateral": "<string>",
  "conditional": "<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

Get USDC + conditional-token balance/allowance (PM keys — paper trading: huge)

Authorizations

Headers

Query Parameters

Response