resolvedmarkets-com Account API

openapi: 3.2.0
info:
  title: Resolved Markets Account 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: Account
  description: API key management and tier information (Clerk session required).
paths:
  /v1/api-keys/validate:
    get:
      tags:
      - Account
      operationId: validateApiKey
      summary: Validate an API key
      description: Verify that a key is active. Accepts either the `X-API-Key` header or a `?key=` query parameter.
      security: []
      parameters:
      - name: key
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Validation result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  label:
                    type: string
                  created_at:
                    type: string
        '400':
          description: No key provided.
  /v1/api-keys:
    get:
      tags:
      - Account
      operationId: listApiKeys
      summary: List your API keys
      description: Requires a Clerk session (browser-only) — not callable with an `rm_` key.
      security:
      - ClerkSession: []
      responses:
        '200':
          description: Keys with previews and usage stats.
          content:
            application/json:
              schema:
                type: object
                properties:
                  keys:
                    type: array
                    items:
                      type: object
                      properties:
                        key_preview:
                          type: string
                        key_id:
                          type: string
                          description: Server-side hash; pass to DELETE.
                        label:
                          type: string
                        created_at:
                          type: string
                        last_used_at:
                          type: string
                        request_count:
                          type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      tags:
      - Account
      operationId: createApiKey
      summary: Generate a new API key
      description: 'Requires a Clerk session. Plaintext key is returned once and never again. Tier-limited (free: 1, pro: 5, enterprise: 20).'
      security:
      - ClerkSession: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  maxLength: 100
      responses:
        '201':
          description: Newly created key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  key:
                    type: string
                    description: Plaintext API key. Store immediately — not retrievable later.
                  label:
                    type: string
                  created_at:
                    type: string
                  message:
                    type: string
        '403':
          description: Per-tier max keys reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/api-keys/{key}:
    delete:
      tags:
      - Account
      operationId: revokeApiKey
      summary: Revoke an API key
      description: Requires a Clerk session. `key` may be either the raw key (hashed server-side) or the `key_id` hash returned from the list endpoint.
      security:
      - ClerkSession: []
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Key revoked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/user/tier:
    get:
      tags:
      - Account
      operationId: getUserTier
      summary: Current tier and credits
      description: Requires a Clerk session.
      security:
      - ClerkSession: []
      responses:
        '200':
          description: Tier and credit info.
          content:
            application/json:
              schema:
                type: object
                properties:
                  tier:
                    type: string
                    enum:
                    - free
                    - pro
                    - enterprise
                  creditsRemaining:
                    type: integer
                  creditsTotal:
                    type: integer
                  rateLimitRpm:
                    type: integer
                  wsConnectionsMax:
                    type: integer
                  historyDepthHours:
                    type: integer
                    nullable: true
                  mcpAccess:
                    type: string
                  expiresAt:
                    type: string
                    format: date-time
                  limits:
                    type: object
                    additionalProperties: true
        '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'
    NotFound:
      description: Resource not found.
      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`.