resolvedmarkets-com System API

openapi: 3.2.0
info:
  title: Resolved Markets System API
  version: 1.2.0
  summary: High-fidelity orderbook data for Polymarket prediction markets and Hyperliquid perpetual futures, plus a backtesting engine and saved-strategy store.
  description: 'REST API for live and historical orderbook snapshots, trades, platform statistics, and event-driven strategy backtesting. Public endpoints (health, public-stats, payment packs) require no authentication. Data endpoints require an `X-API-Key` header where the key starts with `rm_` — get one at https://resolvedmarkets.com/api-keys. Account, subscription, and payment endpoints require a Clerk browser session and are not callable with an API key. WebSocket endpoints exist at `/ws/orderbook` and `/ws/chat` (see Servers / x-websocket).


    Probabilities are USDC prices in 0.01..0.99. Each Polymarket binary market has two tokens — UP (Yes outcome) and DOWN (No outcome) — each with its own orderbook. UP price + DOWN price ≈ 1.00.'
  termsOfService: https://resolvedmarkets.com/pricing
  contact:
    name: Resolved Markets
    email: info@resolvedmarkets.com
    url: https://resolvedmarkets.com
  license:
    name: Commercial — see Pricing page
    url: https://resolvedmarkets.com/pricing
servers:
- url: https://api.resolvedmarkets.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: System
  description: Platform-wide stats and diagnostics.
paths:
  /v1/stats:
    get:
      tags:
      - System
      operationId: getSystemStats
      summary: Platform-wide statistics
      description: Snapshot totals, per-crypto breakdown, and pipeline counters. Reads exclusively from the small `market_stats` table.
      responses:
        '200':
          description: Stats object.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uptime_seconds:
                    type: integer
                  active_markets:
                    type: integer
                  expired_markets:
                    type: integer
                  snapshot_buffer_depth:
                    type: integer
                  trade_buffer_depth:
                    type: integer
                  total_snapshots:
                    type: integer
                  total_distinct_markets:
                    type: integer
                  earliest_snapshot:
                    type: string
                    format: date-time
                    nullable: true
                  latest_snapshot:
                    type: string
                    format: date-time
                    nullable: true
                  prices:
                    type: object
                    additionalProperties:
                      type: number
                      nullable: true
                  per_crypto:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                  pipeline:
                    type: object
                    additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/debug:
    get:
      tags:
      - System
      operationId: getDebugStats
      summary: Pipeline diagnostics
      description: Capture rates, buffer depths, error counts. Requires both a Clerk session and an API key.
      security:
      - ApiKeyAuth: []
        ClerkSession: []
      responses:
        '200':
          description: Debug stats.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/diagnostics/r2:
    get:
      tags:
      - System
      operationId: getR2Diagnostics
      summary: ClickHouse storage tier + S3/R2 diagnostics
      description: Storage-tier breakdown, merge/mutation stats, part-type breakdown, partition-wide part counts, and S3/R2 event diagnostics. Internal. Needs the `x-r2-diag-secret` header. Every request without the matching header gets 401, and every request gets 401 when `R2_DIAGNOSTICS_SECRET` is not set on the server.
      security: []
      parameters:
      - name: x-r2-diag-secret
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Diagnostics payload.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          description: Diagnostics secret required or invalid.
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key / Clerk session.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        status:
          type: integer
      required:
      - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key prefixed with `rm_`. Generate at https://resolvedmarkets.com/api-keys.
    ClerkSession:
      type: apiKey
      in: cookie
      name: __session
      description: Clerk browser session cookie. Used for account, payment, and admin endpoints. Not callable from API-key clients.
externalDocs:
  description: Interactive API docs and getting-started guides
  url: https://resolvedmarkets.com/docs
x-websocket:
  description: 'WebSocket endpoints. Authenticate via a `{ "type": "auth", "apiKey": "rm_..." }` message after connecting; the server replies `{ "type": "auth", "status": "ok" }` within 5 seconds or closes with code 4001.'
  endpoints:
  - path: /ws/orderbook
    description: 'Real-time orderbook stream. After auth, subscribe with `{ "type": "subscribe", "crypto": "BTC" }`.'
  - path: /ws/chat
    description: Operator chat. Admin connections require a one-time ticket from `POST /v1/admin/chat/ws-ticket`.