resolvedmarkets-com Public API

openapi: 3.2.0
info:
  title: Resolved Markets Public 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: Public
  description: No authentication required.
paths:
  /health:
    get:
      tags:
      - Public
      operationId: getHealth
      summary: Service health
      description: Returns ClickHouse, Redis, pipeline, and WebSocket health. No authentication required. Result is cached for 5s.
      security: []
      responses:
        '200':
          description: Service is operational (or degraded but reachable).
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - operational
                    - starting
                    - degraded
                  clickhouse:
                    type: boolean
                  redis:
                    type: boolean
                  pipeline_ready:
                    type: boolean
                  uptime:
                    type: integer
                  ws_clob:
                    type: boolean
                  ws_trade:
                    type: boolean
        '503':
          description: Core dependencies unhealthy.
  /v1/public-stats:
    get:
      tags:
      - Public
      operationId: getPublicStats
      summary: Public platform statistics
      description: Snapshot count, active markets, current crypto prices, and exchange data freshness. No authentication required.
      security: []
      responses:
        '200':
          description: Public statistics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  snapshot_count:
                    type: integer
                  active_markets:
                    type: integer
                  prices:
                    type: object
                    properties:
                      BTC:
                        type: number
                        nullable: true
                      ETH:
                        type: number
                        nullable: true
                      SOL:
                        type: number
                        nullable: true
                      XRP:
                        type: number
                        nullable: true
                  exchange:
                    type: object
                    properties:
                      snapshots_last_5min:
                        type: integer
                      latest_snapshot:
                        type: string
                        format: date-time
                        nullable: true
  /v1/public-stats/schema.json:
    get:
      tags:
      - Public
      operationId: getDatasetSchema
      summary: schema.org Dataset descriptor
      description: JSON-LD Dataset descriptor used by search engines and LLMs to discover the snapshot dataset. Served as `application/ld+json`.
      security: []
      responses:
        '200':
          description: JSON-LD Dataset object.
          content:
            application/ld+json:
              schema:
                type: object
                additionalProperties: true
  /v1/payments/packs:
    get:
      tags:
      - Public
      operationId: listCreditPacks
      summary: Tier and credit pack pricing
      description: Subscription tiers and prepaid credit pack pricing. No authentication required.
      security: []
      responses:
        '200':
          description: Tier and pack catalog.
          content:
            application/json:
              schema:
                type: object
                properties:
                  packs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        tier:
                          type: string
                          nullable: true
                          enum:
                          - pro
                          - enterprise
                          - null
                        priceUsd:
                          type: number
                        credits:
                          type: integer
                  tiers:
                    type: object
                    additionalProperties: true
components:
  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`.