Skip to content

fix: align cached exchange specs with live APIs #866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
realfishsam wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: align cached exchange specs with live APIs #866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64ef8fd
fix: align cached exchange specs with live APIs
realfishsam Jun 5, 2026
9e9573a
docs: sync generated API references
realfishsam Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions core/api-doc-config.generated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"_generated": "Auto-generated by extract-jsdoc.js on 2026-06-02T00:34:44.916Z. Do not edit manually.",
"_generated": "Auto-generated by extract-jsdoc.js on 2026-06-05T12:47:31.910Z. Do not edit manually.",
"methods": {
"has": {
"summary": "HTTP verb for the endpoint (e.g. GET, POST). */",
Expand Down Expand Up @@ -566,7 +566,7 @@
"type": "UnifiedEvent[]",
"description": "Filtered array of events"
},
"source": "BaseExchange.ts:1317"
"source": "BaseExchange.ts:1318"
},
"watchOrderBook": {
"summary": "Watch order book updates in real-time via WebSocket.",
Expand Down Expand Up @@ -595,7 +595,7 @@
"type": "OrderBook",
"description": "Promise that resolves with the current orderbook state"
},
"source": "BaseExchange.ts:1413"
"source": "BaseExchange.ts:1414"
},
"watchOrderBooks": {
"summary": "Watch multiple order books simultaneously via WebSocket.",
Expand Down Expand Up @@ -624,7 +624,7 @@
"type": "Record<string, OrderBook>",
"description": "Promise that resolves with order books keyed by ID"
},
"source": "BaseExchange.ts:1426"
"source": "BaseExchange.ts:1427"
},
"unwatchOrderBook": {
"summary": "Unsubscribe from a previously watched order book stream.",
Expand All @@ -641,7 +641,7 @@
"type": "void",
"description": "Result"
},
"source": "BaseExchange.ts:1454"
"source": "BaseExchange.ts:1455"
},
"watchTrades": {
"summary": "Watch trade executions in real-time via WebSocket.",
Expand Down Expand Up @@ -676,7 +676,7 @@
"type": "Trade[]",
"description": "Promise that resolves with recent trades"
},
"source": "BaseExchange.ts:1467"
"source": "BaseExchange.ts:1468"
},
"watchAddress": {
"summary": "Stream activity for a public wallet address",
Expand All @@ -699,7 +699,7 @@
"type": "SubscribedAddressSnapshot",
"description": "Promise that resolves with the latest SubscribedAddressSnapshot snapshot"
},
"source": "BaseExchange.ts:1481"
"source": "BaseExchange.ts:1482"
},
"unwatchAddress": {
"summary": "Stop watching a previously registered wallet address and release its resource updates.",
Expand All @@ -716,7 +716,7 @@
"type": "void",
"description": "Result"
},
"source": "BaseExchange.ts:1494"
"source": "BaseExchange.ts:1495"
},
"close": {
"summary": "Close all WebSocket connections and clean up resources.",
Expand All @@ -726,7 +726,7 @@
"type": "void",
"description": "Result"
},
"source": "BaseExchange.ts:1503"
"source": "BaseExchange.ts:1504"
},
"fetchMarketMatches": {
"summary": "Find the same or related market on other venues. Two modes:",
Expand All @@ -743,7 +743,7 @@
"type": "MatchResult[]",
"description": "Array of matched markets with relation and confidence"
},
"source": "BaseExchange.ts:1517"
"source": "BaseExchange.ts:1518"
},
"fetchMatches": {
"summary": "fetchMatches",
Expand All @@ -760,7 +760,7 @@
"type": "MatchResult[]",
"description": "Result"
},
"source": "BaseExchange.ts:1533"
"source": "BaseExchange.ts:1534"
},
"fetchEventMatches": {
"summary": "Find the same or related event on other venues. Two modes:",
Expand All @@ -777,7 +777,7 @@
"type": "EventMatchResult[]",
"description": "Array of matched events with market-level match details"
},
"source": "BaseExchange.ts:1541"
"source": "BaseExchange.ts:1542"
},
"compareMarketPrices": {
"summary": "Compare live prices for the same market across venues. Finds identity matches and returns side-by-side best bid/ask prices so you can spot price differences at a glance.",
Expand All @@ -794,7 +794,7 @@
"type": "PriceComparison[]",
"description": "Array of price comparisons across venues"
},
"source": "BaseExchange.ts:1557"
"source": "BaseExchange.ts:1558"
},
"fetchRelatedMarkets": {
"summary": "Find related markets across venues. Discovers subset/superset market relationships",
Expand All @@ -811,7 +811,7 @@
"type": "PriceComparison[]",
"description": "Array of subset/superset matches with live prices"
},
"source": "BaseExchange.ts:1567"
"source": "BaseExchange.ts:1568"
},
"fetchMatchedMarkets": {
"summary": "fetchMatchedMarkets",
Expand All @@ -828,7 +828,7 @@
"type": "MatchedMarketPair[]",
"description": "Result"
},
"source": "BaseExchange.ts:1578"
"source": "BaseExchange.ts:1579"
},
"fetchMatchedPrices": {
"summary": "fetchMatchedPrices",
Expand All @@ -845,7 +845,7 @@
"type": "MatchedPricePair[]",
"description": "Array of matched market pairs with prices from each venue"
},
"source": "BaseExchange.ts:1586"
"source": "BaseExchange.ts:1587"
},
"fetchHedges": {
"summary": "fetchHedges",
Expand All @@ -862,7 +862,7 @@
"type": "PriceComparison[]",
"description": "Array of subset/superset matches with live prices"
},
"source": "BaseExchange.ts:1597"
"source": "BaseExchange.ts:1598"
},
"fetchArbitrage": {
"summary": "fetchArbitrage",
Expand All @@ -879,7 +879,7 @@
"type": "ArbitrageOpportunity[]",
"description": "Array of arbitrage opportunities sorted by spread"
},
"source": "BaseExchange.ts:1607"
"source": "BaseExchange.ts:1608"
},
"watchPrices": {
"summary": "Watch AMM price updates for a market address (Limitless only).",
Expand Down
2 changes: 1 addition & 1 deletion core/specs/kalshi/Kalshi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ info:
description: Manually defined OpenAPI spec for endpoints being migrated to spec-first approach

servers:
- url: https://{env}.elections.kalshi.com/trade-api/v2
- url: https://{env}.external-api.kalshi.com/trade-api/v2
description: Kalshi Trade API
variables:
env:
Expand Down
9 changes: 5 additions & 4 deletions core/specs/metaculus/Metaculus.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,11 +431,12 @@ components:
must be 1.0, otherwise no more than 0.999 - meaning at least
0.1% of the probability mass must be assigned above the upper bound.<br><br>

At least 1% of the probability mass must be assigned uniformly within
bounds, which means that the CDF must be strictly increasing by at
least 0.01/200 = 0.0005 per step. No two adjacent values of the CDF
can differ by more than 0.59, which is the largest number obtainable
At least 1% of the probability mass must be assigned uniformly within
bounds, which means that the CDF must be strictly increasing by at
least 0.01/200 = 0.0005 per step. No two adjacent values of the CDF
can differ by more than 0.20, which is the largest number obtainable
via the sliders.

type: array
items:
type: number
Expand Down
12 changes: 11 additions & 1 deletion core/specs/myriad/myriad.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,12 @@ paths:
in: query
schema:
type: string
enum: [open, closed, resolved]
enum: [open, closed, resolved, voided]
- name: trading_model
in: query
description: Filter markets by trading model (e.g. CLOB, AMM)
schema:
type: string
- name: token_address
in: query
schema:
Expand Down Expand Up @@ -1046,6 +1051,11 @@ paths:
in: query
schema:
type: string
- name: trading_model
in: query
description: Filter portfolio results by trading model (e.g. CLOB, AMM)
schema:
type: string
- name: token_address
in: query
schema:
Expand Down
28 changes: 28 additions & 0 deletions core/specs/opinion/opinion-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -822,6 +822,34 @@ paths:
"400":
$ref: "#/components/responses/BadRequestError"

/market/slug/{slug}:
get:
tags: [Market]
summary: Get market detail by slug
description: Get detailed information about a specific market using its slug
operationId: getMarketDetailBySlug
parameters:
- name: slug
in: path
required: true
description: Market slug
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/APIBaseResponse"
- type: object
properties:
result:
$ref: "#/components/schemas/MarketDetailResponse"
"400":
$ref: "#/components/responses/BadRequestError"

/market/categorical/{marketId}:
get:
tags: [Market]
Expand Down
55 changes: 49 additions & 6 deletions core/specs/polymarket/PolymarketClobAPI.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ components:
type: string
tick_size:
type: string
last_trade_price:
type: string
neg_risk:
type: boolean

Expand Down Expand Up @@ -331,14 +333,24 @@ components:
properties:
success:
type: boolean
errorMsg:
orderID:
type: string
status:
type: string
orderId:
makingAmount:
type: string
orderHashes:
takingAmount:
type: string
transactionsHashes:
type: array
items:
type: string
tradeIDs:
type: array
items:
type: string
errorMsg:
type: string

CancelResponse:
type: object
Expand Down Expand Up @@ -838,6 +850,23 @@ paths:
schema:
$ref: '#/components/schemas/CancelResponse'

/v1/heartbeats:
post:
summary: Refresh authenticated session heartbeat
tags: [Orders]
description: Keep an authenticated Polymarket session or websocket subscription alive.
security:
- L2Auth: []
parameters:
- $ref: '#/components/parameters/L2Headers'
responses:
'200':
description: Heartbeat acknowledged
content:
application/json:
schema:
type: object

/data/order/{id}:
get:
summary: Get Order
Expand Down Expand Up @@ -881,15 +910,29 @@ paths:
in: query
schema:
type: string
- name: next_cursor
in: query
description: Cursor for keyset pagination
schema:
type: string
responses:
'200':
description: List of active orders
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OpenOrder'
type: object
properties:
limit:
type: integer
next_cursor:
type: string
count:
type: integer
data:
type: array
items:
$ref: '#/components/schemas/OpenOrder'

/data/trades:
get:
Expand Down
26 changes: 16 additions & 10 deletions core/specs/probable/probable.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ components:
type: object
properties:
id:
type: integer
type: string
slug:
type: string
title:
Expand All @@ -223,7 +223,7 @@ components:
type: object
properties:
id:
type: integer
type: string
question:
type: string
market_slug:
Expand Down Expand Up @@ -428,14 +428,9 @@ paths:
content:
application/json:
schema:
type: object
properties:
events:
type: array
items:
$ref: '#/components/schemas/Event'
pagination:
type: object
type: array
items:
$ref: '#/components/schemas/Event'

/public/api/v1/events/{id}:
get:
Expand Down Expand Up @@ -510,6 +505,17 @@ paths:
responses:
'200':
description: List of markets
content:
application/json:
schema:
type: object
properties:
markets:
type: array
items:
$ref: '#/components/schemas/Market'
pagination:
type: object

/public/api/v1/markets/{id}:
get:
Expand Down
Loading
Loading