PMpmxt-dev
Orders & Positions

Fetch Order

Changed on

Look up a single order by id. Returns the order's current status, filled / remaining size, average fill price, and — once settled — the on-chain tx hash.

order_id is what createOrderHosted (or fetchOpenOrdersHosted) returns.

get/v0/orders/{order_id}

Request

  • Base URL
    https://trade.pmxt.dev
  • URL
    https://trade.pmxt.dev/v0/orders/{order_id}
  • Auth
    HTTP bearer

Path parameters

order_idstring required

Unified order id.

Response

The order.

idstring required

Unified order id. Stable across the order's lifetime; reuse it in fetchOrderHosted and cancelOrderHosted.

side'buy' | 'sell' nullable

Order direction. null on cancel responses, which only carry id and status.

type'market' | 'limit' nullable

Order type echoed from the build. null on cancel responses.

amountnumber nullable

Order size in outcome shares. For market submits, this is the shares actually obtained (tokens_bought / tokens_sold); for resting limit orders it is the total shares originally requested. null on cancel responses.

pricenumber nullable

Limit price in probability units [0, 1] for limit orders. null for market orders and cancel responses.

fillednumber

Shares filled so far. For market submits this equals the shares obtained on-chain; for resting limit orders it is the running fill total.

remainingnumber

Shares still outstanding (amount - filled, floored at 0). Reaches 0 when the order is fully filled or cancelled.

statusstring required

Lifecycle status. Open-order values include resting and partial; submit responses pass through the upstream status string (failed when an error was raised); cancel responses return the venue's cancel-acknowledgement status.

feenumber nullable

Total fee charged for this order, in USDC dollars. null until the venue reports fees (typically after settlement).

timestampstring nullable

ISO-8601 timestamp the order was created on the venue side. null on cancel responses.

tx_hashstring nullable

On-chain settlement transaction hash on Polygon. null until the order settles on-chain (resting limit orders stay null until matched).

chainstring nullable

Chain the order settled on. Always polygon for hosted orders today (Opinion settles cross-chain via the same Polygon escrow). null on cancel responses.

block_numberinteger nullable

Polygon block height at which the order settled. null until settlement.

Changes

  • 6c1e54fea3a3Revision changes
    • info

      api tag Orders & Positions added

    • info

      api tag Orders & Positions (Hosted) removed

  • d2fae1223132Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status