Skip to content

Commit 1a204e4

Browse files
committed
docs(hosted): drop (Hosted) suffix, hide self-host API ref group (2.49.5)
Sidebar groups, op summaries, and tags in openapi-hosted-trading.json all drop the (Hosted) disambiguator. The parallel Self-host API reference group is removed from docs.json — the hosted endpoints are the canonical Group A surface; self-hosters consume openapi.json directly or via /guides/self-hosted.
1 parent 956f875 commit 1a204e4

3 files changed

Lines changed: 45 additions & 50 deletions

File tree

changelog.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [2.49.5] - 2026-06-09
6+
7+
Sidebar cleanup: drop "(Hosted)" suffixes everywhere and hide the parallel self-hosted Group A reference. The hosted endpoints are now the only Group A surface in the sidebar; the API reference reads as "Trading → Create Order" instead of "Trading (Hosted) → Create Order (Hosted)."
8+
9+
### Changed
10+
11+
- **Sidebar group labels (`docs.json`)**: `"Trading (Hosted)"``"Trading"`, `"Orders & Positions (Hosted)"``"Orders & Positions"` inside the API Reference tab. The "(Hosted)" disambiguation made sense when a sibling self-hosted group existed in the same sidebar; with that group removed (see below), the suffix is just noise.
12+
- **Operation summaries (`openapi-hosted-trading.json`)**: All 9 hosted op `summary` fields drop the `(Hosted)` suffix — `"Create Order (Hosted)"``"Create Order"`, etc. `"Cancel Order -- Build (Hosted)"` collapses to `"Cancel Order"` (the build / sign / submit two-step is already explained in the operation description; the user-facing name shouldn't telegraph internal mechanics).
13+
- **Operation tags (`openapi-hosted-trading.json`)**: `"Trading (Hosted)"``"Trading"`, `"Orders & Positions (Hosted)"``"Orders & Positions"` on every op. Mintlify derives URL slugs from the tag, so the rendered hosted endpoint URLs go from `/api-reference/trading-hosted/create-order` to `/api-reference/trading/create-order` (and equivalent for Orders & Positions). No external links pointed at the previous slugs.
14+
15+
### Removed
16+
17+
- **`"Self-host API reference"` sidebar group (`docs.json`)**: The 11-page nested group rendering the self-hosted Group A endpoints from `openapi.json` (each operation flagged with a `"Local Only"` badge) is dropped from the Documentation tab sidebar. It duplicated the hosted endpoints' purpose for most readers and made the sidebar feel cluttered (a "Trading" group with "Local Only"–badged entries sitting alongside the prominent hosted "Trading" group on the API Reference tab). The underlying `openapi.json` file is unchanged — self-hosters who want the full reference can still consume the spec directly or reach the per-method pages via the existing `/guides/self-hosted` narrative. Net effect on the rendered sidebar: one canonical "Trading" group in the API Reference tab, no parallel "Local Only" entries elsewhere.
18+
519
## [2.49.4] - 2026-06-09
620

721
Hosted-trading docs QA pass. This patch also ships the 2.49.2 doc restructure work that had accumulated dirty in the working tree but never landed (Pattern E sidebar split, custody page, prediction-markets-101 glossary, terminology cleanup, etc. — see the 2.49.2 entry below for the full list).

docs/api-reference/openapi-hosted-trading.json

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@
3737
"paths": {
3838
"/v0/trade/build-order": {
3939
"post": {
40-
"summary": "Build Order (Hosted)",
40+
"summary": "Build Order",
4141
"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.",
4242
"tags": [
43-
"Trading (Hosted)"
43+
"Trading"
4444
],
4545
"operationId": "buildOrderHosted",
4646
"requestBody": {
@@ -144,10 +144,10 @@
144144
},
145145
"/v0/trade/submit-order": {
146146
"post": {
147-
"summary": "Submit Order (Hosted)",
147+
"summary": "Submit Order",
148148
"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.",
149149
"tags": [
150-
"Trading (Hosted)"
150+
"Trading"
151151
],
152152
"operationId": "submitOrderHosted",
153153
"requestBody": {
@@ -231,10 +231,10 @@
231231
},
232232
"/v0/trade/create-order": {
233233
"post": {
234-
"summary": "Create Order (Hosted)",
234+
"summary": "Create Order",
235235
"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.",
236236
"tags": [
237-
"Trading (Hosted)"
237+
"Trading"
238238
],
239239
"operationId": "createOrderHosted",
240240
"requestBody": {
@@ -338,10 +338,10 @@
338338
},
339339
"/v0/orders/cancel/build": {
340340
"post": {
341-
"summary": "Cancel Order -- Build (Hosted)",
341+
"summary": "Cancel Order",
342342
"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.",
343343
"tags": [
344-
"Trading (Hosted)"
344+
"Trading"
345345
],
346346
"operationId": "cancelOrderHosted",
347347
"requestBody": {
@@ -425,10 +425,10 @@
425425
},
426426
"/v0/user/{address}/balances": {
427427
"get": {
428-
"summary": "Fetch Balance (Hosted)",
428+
"summary": "Fetch Balance",
429429
"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).",
430430
"tags": [
431-
"Orders & Positions (Hosted)"
431+
"Orders & Positions"
432432
],
433433
"operationId": "fetchBalanceHosted",
434434
"parameters": [
@@ -503,10 +503,10 @@
503503
},
504504
"/v0/user/{address}/positions": {
505505
"get": {
506-
"summary": "Fetch Positions (Hosted)",
506+
"summary": "Fetch Positions",
507507
"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`.",
508508
"tags": [
509-
"Orders & Positions (Hosted)"
509+
"Orders & Positions"
510510
],
511511
"operationId": "fetchPositionsHosted",
512512
"parameters": [
@@ -584,10 +584,10 @@
584584
},
585585
"/v0/orders/open": {
586586
"get": {
587-
"summary": "Fetch Open Orders (Hosted)",
587+
"summary": "Fetch Open Orders",
588588
"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.",
589589
"tags": [
590-
"Orders & Positions (Hosted)"
590+
"Orders & Positions"
591591
],
592592
"operationId": "fetchOpenOrdersHosted",
593593
"parameters": [
@@ -667,10 +667,10 @@
667667
},
668668
"/v0/user/{address}/trades": {
669669
"get": {
670-
"summary": "Fetch My Trades (Hosted)",
670+
"summary": "Fetch My Trades",
671671
"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`).",
672672
"tags": [
673-
"Orders & Positions (Hosted)"
673+
"Orders & Positions"
674674
],
675675
"operationId": "fetchMyTradesHosted",
676676
"parameters": [
@@ -738,10 +738,10 @@
738738
},
739739
"/v0/orders/{order_id}": {
740740
"get": {
741-
"summary": "Fetch Order (Hosted)",
741+
"summary": "Fetch Order",
742742
"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.",
743743
"tags": [
744-
"Orders & Positions (Hosted)"
744+
"Orders & Positions"
745745
],
746746
"operationId": "fetchOrderHosted",
747747
"parameters": [

docs/docs.json

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -92,23 +92,6 @@
9292
"guides/self-hosted",
9393
"sdk/server"
9494
]
95-
},
96-
{
97-
"group": "Self-host API reference",
98-
"openapi": "api-reference/openapi.json",
99-
"pages": [
100-
"POST /api/{exchange}/createOrder",
101-
"POST /api/{exchange}/buildOrder",
102-
"POST /api/{exchange}/submitOrder",
103-
"POST /api/{exchange}/cancelOrder",
104-
"GET /api/{exchange}/fetchOrder",
105-
"GET /api/{exchange}/fetchOpenOrders",
106-
"GET /api/{exchange}/fetchMyTrades",
107-
"GET /api/{exchange}/fetchClosedOrders",
108-
"GET /api/{exchange}/fetchAllOrders",
109-
"GET /api/{exchange}/fetchPositions",
110-
"GET /api/{exchange}/fetchBalance"
111-
]
11295
}
11396
]
11497
},
@@ -190,26 +173,24 @@
190173
},
191174
{
192175
"group": "Trading",
176+
"openapi": "api-reference/openapi-hosted-trading.json",
193177
"pages": [
194-
"POST /api/{exchange}/createOrder",
195-
"POST /api/{exchange}/buildOrder",
196-
"POST /api/{exchange}/submitOrder",
197-
"POST /api/{exchange}/cancelOrder"
198-
],
199-
"openapi": "api-reference/openapi.json"
178+
"POST /v0/trade/create-order",
179+
"POST /v0/trade/build-order",
180+
"POST /v0/trade/submit-order",
181+
"POST /v0/orders/cancel/build"
182+
]
200183
},
201184
{
202185
"group": "Orders & Positions",
186+
"openapi": "api-reference/openapi-hosted-trading.json",
203187
"pages": [
204-
"GET /api/{exchange}/fetchOrder",
205-
"GET /api/{exchange}/fetchOpenOrders",
206-
"GET /api/{exchange}/fetchMyTrades",
207-
"GET /api/{exchange}/fetchClosedOrders",
208-
"GET /api/{exchange}/fetchAllOrders",
209-
"GET /api/{exchange}/fetchPositions",
210-
"GET /api/{exchange}/fetchBalance"
211-
],
212-
"openapi": "api-reference/openapi.json"
188+
"GET /v0/orders/{order_id}",
189+
"GET /v0/orders/open",
190+
"GET /v0/user/{address}/trades",
191+
"GET /v0/user/{address}/positions",
192+
"GET /v0/user/{address}/balances"
193+
]
213194
},
214195
{
215196
"group": "Realtime",

0 commit comments

Comments
 (0)