riskmodels-app Account API

openapi: 3.2.0
info:
  title: RiskModels Account API
  version: 3.0.0-agent
  description: 'POST /decompose returns variance shares and ETF hedge ratios for any US equity, separating factor exposure from the residual bet so you can hedge what you don''t want. Daily history to 2000 across ~3,000 US equities.

    Precision equity risk intelligence platform with AI agent integration.


    **New in v3.0.0-agent:**

    - OAuth2 client credentials flow for machine-to-machine auth

    - Plaid Investments integration for live portfolio sync

    - MCP (Model Context Protocol) server for AI agent tools

    - Compliance manifests for AI marketplace integration

    - Per-key rate limiting and scoped access control


    **Data**: Universe `uni_mc_3000` (top ~3,000 US stocks by market cap), date range 2000 to present (deep panel; stock-specific skill series from ~2001 after warmup), updated daily end-of-day. Model outputs are computed by the ERM3 regression system (Huber/Ridge), with Zarr v2 archives on Google Cloud Storage for research pipelines. The live API reads primarily from Supabase **V3** tables: long-form `security_history` (returns, volatility, L1/L2/L3 hedge ratios and explained-risk metrics), wide latest rows in `security_history_latest`, identity in `symbols`, plus supporting surfaces such as `trading_calendar`, `erm3_landing_chart_cache`, and `macro_factors`. Cross-sectional **rankings** (`GET /rankings/*`) are served from precomputed rank metric keys in `security_history`, not a separate `erm3_rankings` table. Hedge ratios (`*_hr`) are **dollar_ratio** ETF notionals per $1 stock and are distinct from regression **betas** (`l1_mkt_beta`, `l2_sec_beta`, `l3_sub_beta`), which are dimensionless coefficients from the hierarchical L1/L2/L3 regression. Both are exposed under `MetricsV3` and on `security_history_latest`. See `SEMANTIC_ALIASES.md` for the full HR-vs-beta convention.


    **Authentication Methods:**

    1. Session cookies (web app)

    2. API Key/Secret via Bearer token (external integrations)

    3. OAuth2 client credentials (AI agents, npm package)


    **Security Features:**

    - GCP KMS envelope encryption for portfolio data

    - Cryptographic shredding on key deletion

    - HMAC-SHA256 webhook verification

    - Row-level security (RLS) via Supabase


    **Pricing**: Per-request billing with prepaid balance. Cached responses are free. Many metered responses include `_agent.cost_usd` in the JSON body; others bill silently — always check the `X-API-Cost-USD` response header when present. Metered operations also expose `x-pricing` (OpenAPI extension) with `capability_id`, `tier` (`baseline` | `premium`), `model`, `cost_usd`, `billing_code`, and optional `min_charge` / per-token fields — aligned with `GET /pricing` and `lib/agent/capabilities.ts`.

    **Lineage**: JSON data responses include `_metadata` (model version, data_as_of, factor set) and headers `X-Risk-Model-Version`, `X-Data-As-Of`, `X-Factor-Set-Id`, `X-Universe-Size`. Parquet and CSV bodies omit `_metadata`; use the same `X-Risk-*` headers on the HTTP response.

    **Tabular exports (Parquet / CSV):** For bulk historical loads, time-series endpoints accept `format=parquet` or `format=csv`, or (when `format` is omitted) `Accept: application/vnd.apache.parquet` or `Accept: text/csv`. Successful responses use `Content-Type: application/vnd.apache.parquet` or `text/csv; charset=utf-8` and `Content-Disposition: attachment` with a descriptive filename. Each export is a single flat table; column names and types match the per-operation schemas referenced in the response media type descriptions (aligned with JSON row objects or zipped parallel arrays). Parquet is produced via schema inference from the first row (UTF8 strings, DOUBLE floats, INT64 integers, BOOLEAN, TIMESTAMP_MILLIS for JavaScript Date values). CSV uses a header row, comma separators, UTF-8, and RFC 4180-style quoting when needed. Prefer Parquet for typed columnar stacks (pandas, Polars, Arrow); use CSV for spreadsheets and lightweight scripting.'
  contact:
    name: RiskModels Support
    email: service@riskmodels.app
    url: https://riskmodels.app
  termsOfService: https://riskmodels.app/legal
  license:
    name: Commercial
    url: https://riskmodels.app/legal
servers:
- url: https://riskmodels.app/api
  description: Production — all metered endpoints (`/metrics`, `/snapshot`, `/decompose`, `/batch/analyze`, `/portfolio/*`, etc.).
- url: https://riskmodels.app
  description: Discovery origin — `/.well-known/*` manifests (`mcp.json`, `ai-plugin.json`, `agentic-disclosure.json`) live at the site origin without the `/api` prefix. Generated clients that hard-code the first server entry must strip `/api` before requesting these paths.
security:
- BearerAuth: []
tags:
- name: Account
  description: Balance, billing, and invoice management.
paths:
  /balance:
    get:
      summary: Account balance and rate limits
      description: Returns current prepaid balance, account status, and rate-limit settings for the authenticated token.
      operationId: getBalance
      tags:
      - Account
      responses:
        '200':
          description: Account balance and status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  email:
                    type: string
                    example: user@example.com
                  balance_usd:
                    type: number
                    format: float
                    example: 24.85
                  currency:
                    type: string
                    example: USD
                  account_type:
                    type: string
                    example: pay_as_you_go
                  status:
                    type: object
                    properties:
                      account:
                        type: string
                        example: active
                      billing:
                        type: string
                        example: ok
                      can_make_requests:
                        type: boolean
                  limits:
                    type: object
                    properties:
                      rate_limit_per_minute:
                        type: integer
                        example: 60
                      daily_request_limit:
                        type:
                        - integer
                        - 'null'
                  last_updated:
                    type: string
                    format: date-time
        '401':
          description: Missing or invalid Bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Insufficient balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientBalance'
        '429':
          description: Rate limit exceeded.
          headers:
            Retry-After:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitExceeded'
    patch:
      summary: Update auto-refill settings
      description: Updates prepaid auto-refill on `agent_accounts`. When `enabled` is true, `refill_amount_usd` (20, 50, or 100) and `min_threshold_tokens` (maps to USD threshold between $5 and $50) are required.
      operationId: patchBalanceAutoRefill
      tags:
      - Account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - enabled
              properties:
                enabled:
                  type: boolean
                  description: Enable or disable auto top-up.
                refill_amount_usd:
                  type: number
                  enum:
                  - 20
                  - 50
                  - 100
                  description: Required when enabling auto-refill.
                min_threshold_tokens:
                  type: number
                  description: 'Token threshold; converted to USD for storage. Implied USD must be between 5 and 50 when enabling.

                    '
      responses:
        '200':
          description: Updated settings or current state.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Validation error.
        '401':
          description: Unauthorized.
        '500':
          description: Server error.
  /user/billing-config:
    get:
      summary: Auto-refill billing preferences
      description: Current auto-refill flags and amounts from `agent_accounts`. Same semantics as portal settings; use `PATCH /balance` for the alternate auto-refill field names (`enabled`, `refill_amount_usd`).
      operationId: getUserBillingConfig
      tags:
      - Account
      responses:
        '200':
          description: Billing preferences.
          content:
            application/json:
              schema:
                type: object
                properties:
                  auto_top_up:
                    type: boolean
                  auto_top_up_amount:
                    type: number
                  auto_top_up_threshold:
                    type: number
                  has_payment_method:
                    type: boolean
                  allowed_refill_amounts:
                    type: array
                    items:
                      type: number
                  threshold_bounds:
                    type: object
                    properties:
                      min:
                        type: number
                      max:
                        type: number
        '401':
          description: Unauthorized.
        '404':
          description: Agent account not found.
        '500':
          description: Server error.
    patch:
      summary: Update auto-refill billing preferences
      description: Partial update of `auto_top_up`, `auto_top_up_amount` (must be 20, 50, or 100), and/or `auto_top_up_threshold` (USD, 5–50). Requires a saved payment method to enable auto-refill.
      operationId: patchUserBillingConfig
      tags:
      - Account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                auto_top_up:
                  type: boolean
                auto_top_up_amount:
                  type: number
                  enum:
                  - 20
                  - 50
                  - 100
                auto_top_up_threshold:
                  type: number
                  minimum: 5
                  maximum: 50
      responses:
        '200':
          description: Updated fields.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  auto_top_up:
                    type: boolean
                  auto_top_up_amount:
                    type: number
                  auto_top_up_threshold:
                    type: number
        '400':
          description: Validation or missing payment method.
        '401':
          description: Unauthorized.
        '500':
          description: Server error.
  /invoices:
    get:
      summary: Invoice history and spend summary
      description: Returns paginated invoice history and a summary of spend by period (month/quarter/year).
      operationId: getInvoices
      tags:
      - Account
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
        description: Maximum number of invoices to return.
      - name: period
        in: query
        required: false
        schema:
          type: string
          enum:
          - month
          - quarter
          - year
          default: month
        description: Aggregation period for spend summary.
      responses:
        '200':
          description: Invoice list and spend summary.
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoices:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        amount_usd:
                          type: number
                          format: float
                  summary:
                    type: object
                    properties:
                      period:
                        type: string
                      total_invoices:
                        type: integer
                      total_spent_usd:
                        type: number
                        format: float
                      total_requests:
                        type: integer
                      current_period_cost_usd:
                        type: number
                        format: float
        '401':
          description: Missing or invalid Bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Insufficient balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientBalance'
        '429':
          description: Rate limit exceeded.
          headers:
            Retry-After:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitExceeded'
components:
  schemas:
    RateLimitExceeded:
      type: object
      description: Returned when the per-minute rate limit is exceeded (HTTP 429).
      properties:
        error:
          type: string
          enum:
          - RATE_LIMIT_EXCEEDED
          example: RATE_LIMIT_EXCEEDED
        message:
          type: string
          example: Rate limit exceeded. Retry after 2026-03-08T12:34:56Z
        retry_after:
          type: string
          format: date-time
          description: ISO timestamp after which the client may retry.
          example: '2026-03-08T12:34:56Z'
        limit:
          type: integer
          description: Requests allowed per minute for this key.
          example: 60
    InsufficientBalance:
      type: object
      description: Returned when the account prepaid balance is exhausted (HTTP 402).
      properties:
        error:
          type: string
          enum:
          - INSUFFICIENT_BALANCE
          example: INSUFFICIENT_BALANCE
        message:
          type: string
          example: 'Insufficient balance. Current balance: $0.00. Top up at https://riskmodels.app/billing'
        balance_usd:
          type: number
          format: float
          example: 0
        top_up_url:
          type: string
          format: uri
          example: https://riskmodels.app/billing
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code.
          example: TICKER_NOT_FOUND
        message:
          type: string
          description: Human-readable error description with suggested action.
          example: Ticker 'XYZABC' not found in universe 'uni_mc_3000'. Check ticker spelling or try a different universe.
        code:
          type: integer
          description: HTTP status code.
          example: 404
        history_starts:
          type: string
          format: date
          description: 'Earliest non-null daily close or return date for the resolved security. Present only when a historical request ends before the security''s own history begins.

            '
        details:
          type: object
          properties:
            field:
              type: string
              example: ticker
            received:
              type: string
              example: XYZABC
            universe:
              type: string
              example: uni_mc_3000
            suggestion:
              type: string
              example: Check for typos or use ticker search endpoint
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rm_agent_{environment}_{random}_{checksum}
      description: 'API key in format `rm_agent_{live|test}_{random}_{checksum}` or `rm_user_{random}_{checksum}`. Obtain via `POST /api/auth/provision` or from riskmodels.app/settings → API Keys. Include as: `Authorization: Bearer rm_agent_live_...`

        '
    OAuth2AuthorizationCode:
      type: oauth2
      description: 'OAuth 2.0 authorization code flow with PKCE (S256), used by MCP clients (Claude Desktop, Cursor, ChatGPT Developer Mode, Grok) that self-register via `POST /api/oauth/register`. Public clients only — no `client_secret` is issued and `token_endpoint_auth_method` is `none`.


        The access token this flow returns **is** an `rm_user_*` API key (1 h TTL, 30 d rotating refresh token), so it authenticates every `BearerAuth` operation below, not just `/api/mcp/sse`. Scope is currently informational: the API records the presented scope for telemetry but authorises by key validity and account balance, not by scope.


        Discovery metadata: `/.well-known/oauth-authorization-server`.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://riskmodels.app/oauth/authorize
          tokenUrl: https://riskmodels.app/api/oauth/token
          refreshUrl: https://riskmodels.app/api/oauth/token
          scopes:
            mcp:read: Read access to risk analytics (the only scope the authorization server advertises)