pmxt-core 2.27.1 → 2.27.4

package/dist/server/openapi.yaml

@@ -77,13 +77,12 @@ paths:
           name: limit
           required: false
           schema:
-            type: integer
-            default: 10000
+            type: number
         - in: query
           name: offset
           required: false
           schema:
-            type: integer
+            type: number
         - in: query
           name: sort
           required: false
@@ -100,10 +99,10 @@ paths:
             type: string
             enum:
               - active
+              - inactive
               - closed
               - all
-            description: 'Filter by market status (default: active)'
-          description: 'Filter by market status (default: active)'
+          description: 'Filter by market status (default: ''active'', ''inactive'' and ''closed'' are interchangeable)'
         - in: query
           name: searchIn
           required: false
@@ -113,47 +112,49 @@ paths:
               - title
               - description
               - both
+          description: 'Where to search (default: ''title'')'
         - in: query
           name: query
           required: false
           schema:
             type: string
+          description: For keyword search
         - in: query
           name: slug
           required: false
           schema:
             type: string
+          description: For slug/ticker lookup
         - in: query
           name: marketId
           required: false
           schema:
             type: string
-            description: Direct lookup by market ID
           description: Direct lookup by market ID
         - in: query
           name: outcomeId
           required: false
           schema:
             type: string
-            description: Reverse lookup -- find market containing this outcome
           description: Reverse lookup -- find market containing this outcome
         - in: query
           name: eventId
           required: false
           schema:
             type: string
-            description: Find markets belonging to an event
           description: Find markets belonging to an event
         - in: query
           name: page
           required: false
           schema:
-            type: integer
+            type: number
+          description: For pagination (used by Limitless)
         - in: query
           name: similarityThreshold
           required: false
           schema:
             type: number
+          description: For semantic search (used by Limitless)
       responses:
         '200':
           description: Fetch Markets response
@@ -216,26 +217,26 @@ paths:
           required: false
           schema:
             type: string
+          description: For keyword search
         - in: query
-          name: sort
+          name: limit
           required: false
           schema:
-            type: string
-            enum:
-              - volume
-              - liquidity
-              - newest
+            type: number
         - in: query
-          name: limit
+          name: offset
           required: false
           schema:
-            type: integer
-            default: 10000
+            type: number
         - in: query
-          name: offset
+          name: sort
           required: false
           schema:
-            type: integer
+            type: string
+            enum:
+              - volume
+              - liquidity
+              - newest
         - in: query
           name: status
           required: false
@@ -243,10 +244,10 @@ paths:
             type: string
             enum:
               - active
+              - inactive
               - closed
               - all
-            description: 'Filter by event status (default: active)'
-          description: 'Filter by event status (default: active)'
+          description: 'Filter by event status (default: ''active'', ''inactive'' and ''closed'' are interchangeable)'
         - in: query
           name: searchIn
           required: false
@@ -261,14 +262,12 @@ paths:
           required: false
           schema:
             type: string
-            description: Direct lookup by event ID
           description: Direct lookup by event ID
         - in: query
           name: slug
           required: false
           schema:
             type: string
-            description: Lookup by event slug
           description: Lookup by event slug
       responses:
         '200':
@@ -297,13 +296,12 @@ paths:
           name: limit
           required: false
           schema:
-            type: integer
-            default: 10000
+            type: number
         - in: query
           name: offset
           required: false
           schema:
-            type: integer
+            type: number
         - in: query
           name: sort
           required: false
@@ -320,10 +318,10 @@ paths:
             type: string
             enum:
               - active
+              - inactive
               - closed
               - all
-            description: 'Filter by market status (default: active)'
-          description: 'Filter by market status (default: active)'
+          description: 'Filter by market status (default: ''active'', ''inactive'' and ''closed'' are interchangeable)'
         - in: query
           name: searchIn
           required: false
@@ -333,47 +331,49 @@ paths:
               - title
               - description
               - both
+          description: 'Where to search (default: ''title'')'
         - in: query
           name: query
           required: false
           schema:
             type: string
+          description: For keyword search
         - in: query
           name: slug
           required: false
           schema:
             type: string
+          description: For slug/ticker lookup
         - in: query
           name: marketId
           required: false
           schema:
             type: string
-            description: Direct lookup by market ID
           description: Direct lookup by market ID
         - in: query
           name: outcomeId
           required: false
           schema:
             type: string
-            description: Reverse lookup -- find market containing this outcome
           description: Reverse lookup -- find market containing this outcome
         - in: query
           name: eventId
           required: false
           schema:
             type: string
-            description: Find markets belonging to an event
           description: Find markets belonging to an event
         - in: query
           name: page
           required: false
           schema:
-            type: integer
+            type: number
+          description: For pagination (used by Limitless)
         - in: query
           name: similarityThreshold
           required: false
           schema:
             type: number
+          description: For semantic search (used by Limitless)
       responses:
         '200':
           description: Fetch Market response
@@ -400,26 +400,26 @@ paths:
           required: false
           schema:
             type: string
+          description: For keyword search
         - in: query
-          name: sort
+          name: limit
           required: false
           schema:
-            type: string
-            enum:
-              - volume
-              - liquidity
-              - newest
+            type: number
         - in: query
-          name: limit
+          name: offset
           required: false
           schema:
-            type: integer
-            default: 10000
+            type: number
         - in: query
-          name: offset
+          name: sort
           required: false
           schema:
-            type: integer
+            type: string
+            enum:
+              - volume
+              - liquidity
+              - newest
         - in: query
           name: status
           required: false
@@ -427,10 +427,10 @@ paths:
             type: string
             enum:
               - active
+              - inactive
               - closed
               - all
-            description: 'Filter by event status (default: active)'
-          description: 'Filter by event status (default: active)'
+          description: 'Filter by event status (default: ''active'', ''inactive'' and ''closed'' are interchangeable)'
         - in: query
           name: searchIn
           required: false
@@ -445,14 +445,12 @@ paths:
           required: false
           schema:
             type: string
-            description: Direct lookup by event ID
           description: Direct lookup by event ID
         - in: query
           name: slug
           required: false
           schema:
             type: string
-            description: Lookup by event slug
           description: Lookup by event slug
       responses:
         '200':
@@ -481,10 +479,35 @@ paths:
           schema:
             type: string
         - in: query
-          name: params
-          required: true
+          name: resolution
+          required: false
+          schema:
+            type: string
+            enum:
+              - 1m
+              - 5m
+              - 15m
+              - 1h
+              - 6h
+              - 1d
+          description: Required for candle aggregation
+        - in: query
+          name: start
+          required: false
+          schema:
+            type: string
+            format: date-time
+        - in: query
+          name: end
+          required: false
           schema:
             type: string
+            format: date-time
+        - in: query
+          name: limit
+          required: false
+          schema:
+            type: number
       responses:
         '200':
           description: Fetch O H L C V response
@@ -538,10 +561,22 @@ paths:
           schema:
             type: string
         - in: query
-          name: params
-          required: true
+          name: start
+          required: false
+          schema:
+            type: string
+            format: date-time
+        - in: query
+          name: end
+          required: false
           schema:
             type: string
+            format: date-time
+        - in: query
+          name: limit
+          required: false
+          schema:
+            type: number
       responses:
         '200':
           description: Fetch Trades response
@@ -764,15 +799,13 @@ paths:
           required: false
           schema:
             type: string
-            description: Filter to specific outcome/ticker
-          description: Filter to specific outcome/ticker
+          description: filter to specific outcome/ticker
         - in: query
           name: marketId
           required: false
           schema:
             type: string
-            description: Filter to specific market
-          description: Filter to specific market
+          description: filter to specific market
         - in: query
           name: since
           required: false
@@ -789,14 +822,13 @@ paths:
           name: limit
           required: false
           schema:
-            type: integer
+            type: number
         - in: query
           name: cursor
           required: false
           schema:
             type: string
-            description: For Kalshi cursor pagination
-          description: For Kalshi cursor pagination
+          description: for Kalshi cursor pagination
       responses:
         '200':
           description: Fetch My Trades response
@@ -822,8 +854,7 @@ paths:
           required: false
           schema:
             type: string
-            description: Required for Limitless (slug)
-          description: Required for Limitless (slug)
+          description: required for Limitless (slug)
         - in: query
           name: since
           required: false
@@ -840,7 +871,7 @@ paths:
           name: limit
           required: false
           schema:
-            type: integer
+            type: number
         - in: query
           name: cursor
           required: false
@@ -871,8 +902,7 @@ paths:
           required: false
           schema:
             type: string
-            description: Required for Limitless (slug)
-          description: Required for Limitless (slug)
+          description: required for Limitless (slug)
         - in: query
           name: since
           required: false
@@ -889,7 +919,7 @@ paths:
           name: limit
           required: false
           schema:
-            type: integer
+            type: number
         - in: query
           name: cursor
           required: false
@@ -1069,10 +1099,97 @@ paths:
                       - type: array
                         items:
                           $ref: '#/components/schemas/UnifiedMarket'
-                      - oneOf:
-                          - type: string
-                          - type: object
-                          - type: object
+                      - type: string
+                      - type: object
+                        properties:
+                          text:
+                            type: string
+                          searchIn:
+                            type: array
+                            items:
+                              type: string
+                              enum:
+                                - title
+                                - description
+                                - category
+                                - tags
+                                - outcomes
+                          volume24h:
+                            type: object
+                            properties:
+                              min:
+                                type: number
+                              max:
+                                type: number
+                          volume:
+                            type: object
+                            properties:
+                              min:
+                                type: number
+                              max:
+                                type: number
+                          liquidity:
+                            type: object
+                            properties:
+                              min:
+                                type: number
+                              max:
+                                type: number
+                          openInterest:
+                            type: object
+                            properties:
+                              min:
+                                type: number
+                              max:
+                                type: number
+                          resolutionDate:
+                            type: object
+                            properties:
+                              before:
+                                type: string
+                                format: date-time
+                              after:
+                                type: string
+                                format: date-time
+                          category:
+                            type: string
+                          tags:
+                            type: array
+                            items:
+                              type: string
+                          price:
+                            type: object
+                            properties:
+                              outcome:
+                                type: string
+                                enum:
+                                  - 'yes'
+                                  - 'no'
+                                  - up
+                                  - down
+                              min:
+                                type: number
+                              max:
+                                type: number
+                            required:
+                              - outcome
+                          priceChange24h:
+                            type: object
+                            properties:
+                              outcome:
+                                type: string
+                                enum:
+                                  - 'yes'
+                                  - 'no'
+                                  - up
+                                  - down
+                              min:
+                                type: number
+                              max:
+                                type: number
+                            required:
+                              - outcome
+                      - type: object
                 credentials:
                   $ref: '#/components/schemas/ExchangeCredentials'
               required:
@@ -1116,10 +1233,41 @@ paths:
                       - type: array
                         items:
                           $ref: '#/components/schemas/UnifiedEvent'
-                      - oneOf:
-                          - type: string
-                          - type: object
-                          - type: object
+                      - type: string
+                      - type: object
+                        properties:
+                          text:
+                            type: string
+                          searchIn:
+                            type: array
+                            items:
+                              type: string
+                              enum:
+                                - title
+                                - description
+                                - category
+                                - tags
+                          category:
+                            type: string
+                          tags:
+                            type: array
+                            items:
+                              type: string
+                          marketCount:
+                            type: object
+                            properties:
+                              min:
+                                type: number
+                              max:
+                                type: number
+                          totalVolume:
+                            type: object
+                            properties:
+                              min:
+                                type: number
+                              max:
+                                type: number
+                      - type: object
                 credentials:
                   $ref: '#/components/schemas/ExchangeCredentials'
               required:
@@ -1382,6 +1530,9 @@ components:
         marketId:
           type: string
           description: The unique identifier for this market
+        eventId:
+          type: string
+          description: Link to parent event
         title:
           type: string
         description:
@@ -1392,9 +1543,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/MarketOutcome'
-        eventId:
-          type: string
-          description: Link to parent event
         resolutionDate:
           type: string
           format: date-time
@@ -1402,6 +1550,7 @@ components:
           type: number
         volume:
           type: number
+          description: Total / Lifetime volume
         liquidity:
           type: number
         openInterest:
@@ -1433,6 +1582,15 @@ components:
           $ref: '#/components/schemas/MarketOutcome'
         down:
           $ref: '#/components/schemas/MarketOutcome'
+      required:
+        - marketId
+        - title
+        - description
+        - outcomes
+        - resolutionDate
+        - volume24h
+        - liquidity
+        - url
     MarketOutcome:
       type: object
       properties:
@@ -1441,7 +1599,7 @@ components:
           description: 'Outcome ID for trading operations (CLOB Token ID for Polymarket, Market Ticker for Kalshi)'
         marketId:
           type: string
-          description: The market this outcome belongs to (set automatically)
+          description: The market this outcome belongs to (set automatically when outcomes are built)
         label:
           type: string
         price:
@@ -1450,11 +1608,15 @@ components:
           type: number
         metadata:
           type: object
-          additionalProperties: true
+          additionalProperties: {}
           description: 'Exchange-specific metadata (e.g., clobTokenId for Polymarket)'
+      required:
+        - outcomeId
+        - label
+        - price
     UnifiedEvent:
       type: object
-      description: 'A grouped collection of related markets (e.g., "Who will be Fed Chair?" contains multiple candidate markets)'
+      description: 'A grouped collection of related markets (e.g., "Who will be Fed Chair?" contains multiple candidate markets).'
       properties:
         id:
           type: string
@@ -1483,11 +1645,19 @@ components:
           type: array
           items:
             type: string
+      required:
+        - id
+        - title
+        - description
+        - slug
+        - markets
+        - volume24h
+        - url
     PriceCandle:
       type: object
       properties:
         timestamp:
-          type: integer
+          type: number
         open:
           type: number
         high:
@@ -1498,6 +1668,12 @@ components:
           type: number
         volume:
           type: number
+      required:
+        - timestamp
+        - open
+        - high
+        - low
+        - close
     OrderBook:
       type: object
       properties:
@@ -1510,19 +1686,29 @@ components:
           items:
             $ref: '#/components/schemas/OrderLevel'
         timestamp:
-          type: integer
+          type: number
+      required:
+        - bids
+        - asks
     OrderLevel:
       type: object
       properties:
         price:
           type: number
+          description: 0.0 to 1.0 (probability)
         size:
           type: number
+          description: contracts/shares
+      required:
+        - price
+        - size
     Trade:
       type: object
       properties:
         id:
           type: string
+        timestamp:
+          type: number
         price:
           type: number
         amount:
@@ -1533,13 +1719,21 @@ components:
             - buy
             - sell
             - unknown
-        timestamp:
-          type: integer
+        outcomeId:
+          type: string
+      required:
+        - id
+        - timestamp
+        - price
+        - amount
+        - side
     UserTrade:
       type: object
       properties:
         id:
           type: string
+        timestamp:
+          type: number
         price:
           type: number
         amount:
@@ -1550,14 +1744,16 @@ components:
             - buy
             - sell
             - unknown
-        timestamp:
-          type: integer
-        orderId:
-          type: string
         outcomeId:
           type: string
-        marketId:
+        orderId:
           type: string
+      required:
+        - id
+        - timestamp
+        - price
+        - amount
+        - side
     Order:
       type: object
       properties:
@@ -1575,12 +1771,14 @@ components:
         type:
           type: string
           enum:
-            - limit
             - market
+            - limit
         price:
           type: number
+          description: For limit orders
         amount:
           type: number
+          description: Size in contracts/shares
         status:
           type: string
           enum:
@@ -1591,12 +1789,25 @@ components:
             - rejected
         filled:
           type: number
+          description: Amount filled
         remaining:
           type: number
+          description: Amount remaining
         timestamp:
-          type: integer
+          type: number
         fee:
           type: number
+      required:
+        - id
+        - marketId
+        - outcomeId
+        - side
+        - type
+        - amount
+        - status
+        - filled
+        - remaining
+        - timestamp
     Position:
       type: object
       properties:
@@ -1608,6 +1819,7 @@ components:
           type: string
         size:
           type: number
+          description: 'Positive for long, negative for short'
         entryPrice:
           type: number
         currentPrice:
@@ -1616,17 +1828,32 @@ components:
           type: number
         realizedPnL:
           type: number
+      required:
+        - marketId
+        - outcomeId
+        - outcomeLabel
+        - size
+        - entryPrice
+        - currentPrice
+        - unrealizedPnL
     Balance:
       type: object
       properties:
         currency:
           type: string
+          description: 'e.g., ''USDC'''
         total:
           type: number
         available:
           type: number
         locked:
           type: number
+          description: In open orders
+      required:
+        - currency
+        - total
+        - available
+        - locked
     ExecutionPriceResult:
       type: object
       properties:
@@ -1636,25 +1863,32 @@ components:
           type: number
         fullyFilled:
           type: boolean
+      required:
+        - price
+        - filledAmount
+        - fullyFilled
     PaginatedMarketsResult:
       type: object
+      description: Shape returned by fetchMarketsPaginated
       properties:
         data:
           type: array
           items:
             $ref: '#/components/schemas/UnifiedMarket'
         total:
-          type: integer
+          type: number
         nextCursor:
           type: string
+      required:
+        - data
+        - total
     MarketFilterParams:
       type: object
       properties:
         limit:
-          type: integer
-          default: 10000
+          type: number
         offset:
-          type: integer
+          type: number
         sort:
           type: string
           enum:
@@ -1665,19 +1899,23 @@ components:
           type: string
           enum:
             - active
+            - inactive
             - closed
             - all
-          description: 'Filter by market status (default: active)'
+          description: 'Filter by market status (default: ''active'', ''inactive'' and ''closed'' are interchangeable)'
         searchIn:
           type: string
           enum:
             - title
             - description
             - both
+          description: 'Where to search (default: ''title'')'
         query:
           type: string
+          description: For keyword search
         slug:
           type: string
+          description: For slug/ticker lookup
         marketId:
           type: string
           description: Direct lookup by market ID
@@ -1688,32 +1926,35 @@ components:
           type: string
           description: Find markets belonging to an event
         page:
-          type: integer
+          type: number
+          description: For pagination (used by Limitless)
         similarityThreshold:
           type: number
+          description: For semantic search (used by Limitless)
     EventFetchParams:
       type: object
       properties:
         query:
           type: string
+          description: For keyword search
+        limit:
+          type: number
+        offset:
+          type: number
         sort:
           type: string
           enum:
             - volume
             - liquidity
             - newest
-        limit:
-          type: integer
-          default: 10000
-        offset:
-          type: integer
         status:
           type: string
           enum:
             - active
+            - inactive
             - closed
             - all
-          description: 'Filter by event status (default: active)'
+          description: 'Filter by event status (default: ''active'', ''inactive'' and ''closed'' are interchangeable)'
         searchIn:
           type: string
           enum:
@@ -1739,6 +1980,7 @@ components:
             - 1h
             - 6h
             - 1d
+          description: Optional for backward compatibility
         start:
           type: string
           format: date-time
@@ -1746,11 +1988,9 @@ components:
           type: string
           format: date-time
         limit:
-          type: integer
+          type: number
     OHLCVParams:
       type: object
-      required:
-        - resolution
       properties:
         resolution:
           type: string
@@ -1761,7 +2001,7 @@ components:
             - 1h
             - 6h
             - 1d
-          description: Candle interval for aggregation
+          description: Required for candle aggregation
         start:
           type: string
           format: date-time
@@ -1769,7 +2009,9 @@ components:
           type: string
           format: date-time
         limit:
-          type: integer
+          type: number
+      required:
+        - resolution
     TradesParams:
       type: object
       description: Parameters for fetching trade history. No resolution parameter - trades are discrete events.
@@ -1781,15 +2023,9 @@ components:
           type: string
           format: date-time
         limit:
-          type: integer
+          type: number
     CreateOrderParams:
       type: object
-      required:
-        - marketId
-        - outcomeId
-        - side
-        - type
-        - amount
       properties:
         marketId:
           type: string
@@ -1803,36 +2039,44 @@ components:
         type:
           type: string
           enum:
-            - limit
             - market
+            - limit
         amount:
           type: number
         price:
           type: number
+          description: Required for limit orders
         fee:
           type: number
+          description: 'Optional fee rate (e.g., 1000 for 0.1%)'
         tickSize:
           type: number
           description: Optional override for Limitless/Polymarket
         negRisk:
           type: boolean
           description: Optional override to skip neg-risk lookup (Polymarket)
+      required:
+        - marketId
+        - outcomeId
+        - side
+        - type
+        - amount
     BuiltOrder:
       type: object
-      description: 'An order built but not yet submitted, ready for inspection or middleware forwarding'
       properties:
         exchange:
           type: string
-          description: The exchange name this order was built for
+          description: The exchange name this order was built for.
         params:
-          $ref: '#/components/schemas/CreateOrderParams'
+          allOf:
+            - $ref: '#/components/schemas/CreateOrderParams'
+          description: The original params used to build this order.
         signedOrder:
           type: object
-          additionalProperties: true
-          description: 'For CLOB exchanges (Polymarket): the EIP-712 signed order ready to POST'
+          additionalProperties: {}
+          description: 'For CLOB exchanges (Polymarket): the EIP-712 signed order ready to POST to the exchange''s order endpoint.'
         tx:
           type: object
-          description: 'For on-chain AMM exchanges: the EVM transaction payload (reserved for future use)'
           properties:
             to:
               type: string
@@ -1841,18 +2085,30 @@ components:
             value:
               type: string
             chainId:
-              type: integer
+              type: number
+          required:
+            - to
+            - data
+            - value
+            - chainId
+          description: >-
+            For on-chain AMM exchanges: the EVM transaction payload. Reserved for future exchanges; no current exchange
+            populates this.
         raw:
           description: 'The raw, exchange-native payload. Always present.'
+      required:
+        - exchange
+        - params
+        - raw
     MyTradesParams:
       type: object
       properties:
         outcomeId:
           type: string
-          description: Filter to specific outcome/ticker
+          description: filter to specific outcome/ticker
         marketId:
           type: string
-          description: Filter to specific market
+          description: filter to specific market
         since:
           type: string
           format: date-time
@@ -1860,16 +2116,16 @@ components:
           type: string
           format: date-time
         limit:
-          type: integer
+          type: number
         cursor:
           type: string
-          description: For Kalshi cursor pagination
+          description: for Kalshi cursor pagination
     OrderHistoryParams:
       type: object
       properties:
         marketId:
           type: string
-          description: Required for Limitless (slug)
+          description: required for Limitless (slug)
         since:
           type: string
           format: date-time
@@ -1877,30 +2133,30 @@ components:
           type: string
           format: date-time
         limit:
-          type: integer
+          type: number
         cursor:
           type: string
     ExchangeCredentials:
       type: object
-      description: Optional authentication credentials for exchange operations
+      description: Optional authentication credentials for exchange operations.
       properties:
         apiKey:
           type: string
-          description: API key for the exchange
-        privateKey:
-          type: string
-          description: Private key for signing transactions
         apiSecret:
           type: string
-          description: API secret (if required by exchange)
         passphrase:
           type: string
-          description: Passphrase (if required by exchange)
-        funderAddress:
+        apiToken:
+          type: string
+          description: 'Metaculus: `Authorization: Token <apiToken>` for higher rate limits'
+        privateKey:
           type: string
-          description: The address funding the trades (Proxy address)
+          description: Required for Polymarket L1 auth
         signatureType:
           oneOf:
-            - type: integer
+            - type: number
             - type: string
-          description: 'Signature type (0=EOA, 1=Poly Proxy, 2=Gnosis Safe, or names like ''gnosis_safe'')'
+          description: '0 = EOA, 1 = Poly Proxy, 2 = Gnosis Safe (Can also use ''eoa'', ''polyproxy'', ''gnosis_safe'')'
+        funderAddress:
+          type: string
+          description: The address funding the trades (defaults to signer address)