resolvedmarkets-com Exchange API

openapi: 3.2.0
info:
  title: Resolved Markets Exchange 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: Exchange
  description: Hyperliquid perpetual futures L2 book.
paths:
  /v1/exchange/orderbook:
    get:
      tags:
      - Exchange
      operationId: getExchangeOrderbook
      summary: Hyperliquid perpetual futures live book
      description: Live L2 book for a Hyperliquid perpetual. Free tier has no exchange access.
      parameters:
      - name: exchange
        in: query
        required: true
        schema:
          type: string
          enum:
          - hyperliquid_perp
      - name: symbol
        in: query
        required: true
        schema:
          type: string
          enum:
          - BTC
          - ETH
          - SOL
          - XRP
      responses:
        '200':
          description: Live exchange orderbook (single row).
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Missing or invalid `exchange`/`symbol`.
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: No recent data for this exchange/symbol.
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/exchange/snapshots:
    get:
      tags:
      - Exchange
      operationId: listExchangeSnapshots
      summary: Hyperliquid historical snapshots
      description: Defaults to the last 24 hours when `from` is omitted. Bids/asks arrays are excluded from the list view.
      parameters:
      - name: exchange
        in: query
        required: true
        schema:
          type: string
          enum:
          - hyperliquid_perp
      - name: symbol
        in: query
        required: true
        schema:
          type: string
          enum:
          - BTC
          - ETH
          - SOL
          - XRP
      - $ref: '#/components/parameters/From'
      - $ref: '#/components/parameters/To'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 5000
          default: 500
      responses:
        '200':
          description: Snapshot rows (no bids/asks).
          content:
            application/json:
              schema:
                type: object
                properties:
                  exchange:
                    type: string
                  symbol:
                    type: string
                  count:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        '400':
          description: Missing or invalid `exchange`/`symbol`.
        '403':
          $ref: '#/components/responses/Forbidden'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Forbidden:
      description: Authenticated, but the caller's tier or role does not permit this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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
  parameters:
    To:
      name: to
      in: query
      required: false
      description: ISO-8601 exclusive upper bound for capture timestamp.
      schema:
        type: string
        format: date-time
    From:
      name: from
      in: query
      required: false
      description: ISO-8601 inclusive lower bound for capture timestamp.
      schema:
        type: string
        format: date-time
  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`.