Get Execution Price

Calculate the volume-weighted average execution price for a given order size. Returns 0 if the order cannot be fully filled.

POST /api/{exchange}/getExecutionPrice

Python

Polymarket

import pmxt

# API key optional — enables faster catalog-backed lookups
exchange = pmxt.Polymarket(
    pmxt_api_key="YOUR_PMXT_API_KEY",
)
order_book = pmxt.OrderBook(
    bids=[pmxt.OrderLevel(price=0.52, size=100)],
    asks=[pmxt.OrderLevel(price=0.54, size=100)],
)
result = exchange.get_execution_price(order_book, "buy", 10)

200

{
  "success": true,
  "error": {
    "message": "<string>",
    "code": "HOSTED_TRADING_ERROR",
    "retryable": true,
    "exchange": "<string>",
    "detail": {}
  },
  "data": 123
}

Path Parameters

exchange · enum<string> · required

The prediction market exchange to target.

Available options: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, gemini-titan, hyperliquid, suibets, rain, hunch, router

Body

application/json

args · (object | enum<string> | number)[] · required

Required array length: 3 elements

Show child attributes

credentials · object

Optional authentication credentials for exchange operations.

Show child attributes

Response

200 - application/json

Get Execution Price response

success · boolean

Example:

true

error · object

Structured error envelope returned inside BaseResponse.error and ErrorResponse.error. Hosted-mode endpoints populate code, retryable, and optionally exchange / detail; legacy local-mode endpoints may still return only message.

Show child attributes

data · number