|
37 | 37 | "paths": { |
38 | 38 | "/v0/trade/build-order": { |
39 | 39 | "post": { |
40 | | - "summary": "Build Order (Hosted)", |
| 40 | + "summary": "Build Order", |
41 | 41 | "description": "Build an order *without* placing it. Returns the order's typed-data payload (for the wallet to sign) plus a `built_order_id` to pass to `submitOrderHosted` once it's signed.\n\nUse this when you want a human to approve each trade before it submits — for example, surfacing the order details in a wallet popup. For everything else, use `createOrderHosted`, which builds + signs + submits in one call.", |
42 | 42 | "tags": [ |
43 | | - "Trading (Hosted)" |
| 43 | + "Trading" |
44 | 44 | ], |
45 | 45 | "operationId": "buildOrderHosted", |
46 | 46 | "requestBody": { |
|
144 | 144 | }, |
145 | 145 | "/v0/trade/submit-order": { |
146 | 146 | "post": { |
147 | | - "summary": "Submit Order (Hosted)", |
| 147 | + "summary": "Submit Order", |
148 | 148 | "description": "Submit a signed order returned by `buildOrderHosted` and get back the resulting order — id, fill status, average price, and the on-chain tx hash once it settles.\n\n`built_order_id` must come from a recent `buildOrderHosted` call and be submitted before its expiry. For one-shot order placement, use `createOrderHosted` instead.", |
149 | 149 | "tags": [ |
150 | | - "Trading (Hosted)" |
| 150 | + "Trading" |
151 | 151 | ], |
152 | 152 | "operationId": "submitOrderHosted", |
153 | 153 | "requestBody": { |
|
231 | 231 | }, |
232 | 232 | "/v0/trade/create-order": { |
233 | 233 | "post": { |
234 | | - "summary": "Create Order (Hosted)", |
| 234 | + "summary": "Create Order", |
235 | 235 | "description": "Place a buy or sell order on Polymarket or Opinion. Returns the resulting order with id, fill status, average price, fees, and the on-chain tx hash once it settles.\n\nMost callers pass an outcome straight from `client.fetch_markets()`:\n\n```python\nmarket = client.fetch_markets({\"query\": \"trump 2028\"})[0]\norder = client.create_order(outcome=market.yes, side=\"buy\", amount=10, order_type=\"limit\", price=0.55)\n```\n\nNeed to show the order to a user before they sign it (custom approval UX)? Use `buildOrderHosted` + `submitOrderHosted` instead — together they do the same thing.", |
236 | 236 | "tags": [ |
237 | | - "Trading (Hosted)" |
| 237 | + "Trading" |
238 | 238 | ], |
239 | 239 | "operationId": "createOrderHosted", |
240 | 240 | "requestBody": { |
|
338 | 338 | }, |
339 | 339 | "/v0/orders/cancel/build": { |
340 | 340 | "post": { |
341 | | - "summary": "Cancel Order -- Build (Hosted)", |
| 341 | + "summary": "Cancel Order", |
342 | 342 | "description": "Start a cancel on an existing open order. Returns the cancel payload for the wallet to sign — you then submit the signature to `POST /v0/orders/cancel`.\n\nThe SDK's `cancelOrder()` chains both steps. Call this endpoint directly only if you need to show the cancel to a user before signing.", |
343 | 343 | "tags": [ |
344 | | - "Trading (Hosted)" |
| 344 | + "Trading" |
345 | 345 | ], |
346 | 346 | "operationId": "cancelOrderHosted", |
347 | 347 | "requestBody": { |
|
425 | 425 | }, |
426 | 426 | "/v0/user/{address}/balances": { |
427 | 427 | "get": { |
428 | | - "summary": "Fetch Balance (Hosted)", |
| 428 | + "summary": "Fetch Balance", |
429 | 429 | "description": "Check the USDC available for trading. Returns the wallet's balance inside the PMXT escrow on Polygon — *not* the wallet's on-chain USDC balance.\n\nTop up by depositing at [pmxt.dev/dashboard/wallet](https://pmxt.dev/dashboard/wallet).", |
430 | 430 | "tags": [ |
431 | | - "Orders & Positions (Hosted)" |
| 431 | + "Orders & Positions" |
432 | 432 | ], |
433 | 433 | "operationId": "fetchBalanceHosted", |
434 | 434 | "parameters": [ |
|
503 | 503 | }, |
504 | 504 | "/v0/user/{address}/positions": { |
505 | 505 | "get": { |
506 | | - "summary": "Fetch Positions (Hosted)", |
| 506 | + "summary": "Fetch Positions", |
507 | 507 | "description": "List the open positions held by `address` across Polymarket and Opinion. Each position carries the market, outcome, share count, and average entry price.\n\nMark-to-market fields (`current_price`, `current_value`, `unrealized_pnl`) are reserved for a future release and currently return `null`.", |
508 | 508 | "tags": [ |
509 | | - "Orders & Positions (Hosted)" |
| 509 | + "Orders & Positions" |
510 | 510 | ], |
511 | 511 | "operationId": "fetchPositionsHosted", |
512 | 512 | "parameters": [ |
|
584 | 584 | }, |
585 | 585 | "/v0/orders/open": { |
586 | 586 | "get": { |
587 | | - "summary": "Fetch Open Orders (Hosted)", |
| 587 | + "summary": "Fetch Open Orders", |
588 | 588 | "description": "List the wallet's resting orders that haven't filled or been cancelled yet. Each entry has the market, outcome, side, size, price, and time-in-force.\n\nFilter by `venue` to scope to Polymarket or Opinion only.", |
589 | 589 | "tags": [ |
590 | | - "Orders & Positions (Hosted)" |
| 590 | + "Orders & Positions" |
591 | 591 | ], |
592 | 592 | "operationId": "fetchOpenOrdersHosted", |
593 | 593 | "parameters": [ |
|
667 | 667 | }, |
668 | 668 | "/v0/user/{address}/trades": { |
669 | 669 | "get": { |
670 | | - "summary": "Fetch My Trades (Hosted)", |
| 670 | + "summary": "Fetch My Trades", |
671 | 671 | "description": "List the wallet's historical fills on Polymarket and Opinion. Each trade carries the executed price (net of venue fees), size, and on-chain settlement tx hash.\n\nClosed orders are modelled as trades in hosted mode — use this endpoint instead of `fetchClosedOrders` / `fetchAllOrders` (which raise `NotSupported`).", |
672 | 672 | "tags": [ |
673 | | - "Orders & Positions (Hosted)" |
| 673 | + "Orders & Positions" |
674 | 674 | ], |
675 | 675 | "operationId": "fetchMyTradesHosted", |
676 | 676 | "parameters": [ |
|
738 | 738 | }, |
739 | 739 | "/v0/orders/{order_id}": { |
740 | 740 | "get": { |
741 | | - "summary": "Fetch Order (Hosted)", |
| 741 | + "summary": "Fetch Order", |
742 | 742 | "description": "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.\n\n`order_id` is what `createOrderHosted` (or `fetchOpenOrdersHosted`) returns.", |
743 | 743 | "tags": [ |
744 | | - "Orders & Positions (Hosted)" |
| 744 | + "Orders & Positions" |
745 | 745 | ], |
746 | 746 | "operationId": "fetchOrderHosted", |
747 | 747 | "parameters": [ |
|
0 commit comments