AlgoVault API

openapi: 3.1.0
info:
  title: AlgoVault API
  version: '2026-11-01'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 18 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; AlgoVault has published no machine-readable contract that the
    pipeline could find. Engine: oss.'
  x-evidence-tiers:
    code-example: 8
    documentation: 10
    pages-with-code: 1
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-01'
  x-generator: generate-contract-from-docs.py
  x-engine: oss
  x-sources:
  - https://algovault.com/verify
  - https://algovault.com/docs.html
servers:
- url: https://api.algovault.com
paths:
  /api/chat:
    post:
      operationId: post_api_chat
      tags:
      - Api
      summary: POST /api/chat
      x-source: https://algovault.com/docs.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiChatRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiChatResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://api.algovault.com/api/chat  -H "Content-Type: application/json"  -d ''{"question":"how do I get a BTC trade
          call","model":"claude-haiku-4-5-20251001"}'''
  /api/performance-public:
    get:
      operationId: get_api_performance_public
      tags:
      - Api
      summary: Pull GET /api/performance-public for any call.id.
      x-source: https://algovault.com/verify
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/search:
    post:
      operationId: post_api_search
      tags:
      - Api
      summary: POST /api/search
      x-source: https://algovault.com/docs.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSearchRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSearchResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://api.algovault.com/api/search  -H "Content-Type: application/json"  -d ''{"query":"BTC stop loss","limit":3}'''
  /api/verify-signal:
    get:
      operationId: get_api_verify_signal
      tags:
      - Api
      summary: Returns call details, hash, Merkle proof and verification status for a signal.
      x-source: https://algovault.com/docs.html
      parameters:
      - name: signalId
        in: query
        required: true
        schema:
          type: string
        description: Identifier of the signal to verify.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/webhooks:
    get:
      operationId: get_api_webhooks
      tags:
      - Api
      summary: Lists active webhook subscriptions.
      x-source: https://algovault.com/docs.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_webhooks
      tags:
      - Api
      summary: POST /api/webhooks
      x-source: https://algovault.com/docs.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiWebhooksRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.algovault.com/api/webhooks  -H \"Authorization: Bearer av_live_...\"  -H \"Content-Type: application/json\"\
          \  -d '{\n \"url\": \"https://your-server.com/hook\",\n \"events\": [\"trade_call\", \"regime_shift\"],\n \"timeframes\": [\"15m\",\
          \ \"1h\"],\n \"assets\": [\"BTC\", \"ETH\", \"top:25\"],\n \"min_confidence\": 60\n }' \n Filters are optional — omit them to receive\
          \ every call. assets accepts coin symbols or"
  /api/webhooks/{id}:
    delete:
      operationId: delete_api_webhooks_id
      tags:
      - Api
      summary: Removes a webhook subscription by its ID.
      x-source: https://algovault.com/docs.html
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/webhooks/{id}/test:
    post:
      operationId: post_api_webhooks_id_test
      tags:
      - Api
      summary: Sends a test delivery to a webhook endpoint to verify wiring.
      x-source: https://algovault.com/docs.html
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /health:
    get:
      operationId: get_health
      tags:
      - Health
      summary: GET /health
      x-source: https://algovault.com/docs.html
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHealthResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS https://api.algovault.com/health \n Returns {\"status\":\"ok\",\"server\":\"crypto-quant-signal-mcp\",\"version\":\"\
          <current release>\",\"stripe\":true} . \n Codex — setup walkthrough \n Codex reads MCP servers from ~/.codex/config.toml . Add a table\
          \ for AlgoVault: \n [mcp_servers.algovault]\nurl = \"https://api.algovault.com/mcp?src=docs\"\nbearer_token_env_var = \"AV_API_KEY\"\
          \n[mcp_servers.algovault.http_heade"
  /krakenfx/kraken-cli/releases/latest/download/kraken-cli-installer.sh:
    get:
      operationId: get_krakenfx_kraken_cli_releases_latest_download_kraken_cli_installer_sh
      tags:
      - Krakenfx
      summary: GET /krakenfx/kraken-cli/releases/latest/download/kraken-cli-installer.sh
      x-source: https://algovault.com/docs.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/krakenfx/kraken-cli/releases/latest/download/kraken-cli-installer.sh\
          \ | sh\nkraken mcp -s all \n The kraken paper engine needs no keys and no account. Run --validate before any live order; arm cancel-after\
          \ as a dead-man's switch. \n Full tutorial + runnable demo → \n Alpaca — setup walkthrough \n Run Alpaca's crypto MCP Server zero-install,\
          \ scoped"
  /mcp:
    get:
      operationId: get_mcp
      tags:
      - Mcp
      summary: GET /mcp
      x-source: https://algovault.com/docs.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \"Authorization: Bearer av_live_…\" https://api.algovault.com/mcp … or paste the key into your Claude Desktop / Cursor\
          \ / Claude Code MCP config. Need to find your key later? Visit /account . \n ◆ FAQ \n How often should I call get_trade_call?\n Match\
          \ your call frequency to the timeframe. A 5m trade call is stale after ~5 minutes, while a 4h call is relevant for several hours. For\
          \ most agents, c"
    post:
      operationId: post_mcp
      tags:
      - Mcp
      summary: POST /mcp
      x-source: https://algovault.com/docs.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostMcpRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s -X POST https://api.algovault.com/mcp  -H \"Authorization: Bearer $ALGOVAULT_API_KEY\"  -H \"Content-Type: application/json\"\
          \  -H \"Accept: application/json, text/event-stream\"  -d '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"tools/call\",\"params\":{\"name\"\
          :\"scan_market_regimes\",\"arguments\":{\"exchange\":\"BINANCE\",\"timeframe\":\"1h\",\"regime\":[\"TRENDING_UP\"],\"minConfidence\"\
          :60,\"limit\":3}}}' \n The response is an "
  /mcp/agentic:
    get:
      operationId: get_mcp_agentic
      tags:
      - Mcp
      summary: GET /mcp/agentic
      x-source: https://algovault.com/docs.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: httpie
        snippet: 'http https://agent.binance.com/mcp/agentic · OAuth, no API keys '
  /openApi/swap/v2/trade/getVst:
    post:
      operationId: post_openApi_swap_v2_trade_getVst
      tags:
      - Openapi
      summary: Retrieves a VST (virtual) balance top‑up on the BingX demo host.
      x-source: https://algovault.com/docs.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /openApi/swap/v2/trade/order/test:
    post:
      operationId: post_openApi_swap_v2_trade_order_test
      tags:
      - Openapi
      summary: Validates a trade order without executing it on the BingX VST sandbox.
      x-source: https://algovault.com/docs.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /x402/get_market_regime:
    post:
      operationId: post_x402_get_market_regime
      tags:
      - X402
      summary: Classifies the current market regime for any asset on a supported venue.
      x-source: https://algovault.com/docs.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostX402GetMarketRegimeRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostX402GetMarketRegimeResponse'
      x-evidence:
        kind: documentation
  /x402/get_trade_call:
    post:
      operationId: post_x402_get_trade_call
      tags:
      - X402
      summary: Returns a composite BUY/SELL/HOLD trade call with confidence percentage, regime context, and reasoning.
      x-source: https://algovault.com/docs.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostX402GetTradeCallRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostX402GetTradeCallResponse'
      x-evidence:
        kind: documentation
  /x402/scan_funding_arb:
    post:
      operationId: post_x402_scan_funding_arb
      tags:
      - X402
      summary: Scans cross‑venue funding rate differences and returns top arbitrage opportunities.
      x-source: https://algovault.com/docs.html
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostX402ScanFundingArbRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostX402ScanFundingArbResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiChatRequest:
      type: object
      properties:
        question:
          type: string
        model:
          type: string
    PostApiChatResponse:
      type: object
      properties:
        jsonrpc:
          type: string
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
        id:
          type:
          - string
          - 'null'
    PostApiSearchRequest:
      type: object
      properties:
        query:
          type: string
        limit:
          type: integer
    PostApiSearchResponse:
      type: object
      properties:
        jsonrpc:
          type: string
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
        id:
          type:
          - string
          - 'null'
    PostApiWebhooksRequest:
      type: object
      properties:
        url:
          type: string
        events:
          type: array
          items:
            type: string
        timeframes:
          type: array
          items:
            type: string
        assets:
          type: array
          items:
            type: string
        min_confidence:
          type: integer
    GetHealthResponse:
      type: object
      properties:
        status:
          type: string
        server:
          type: string
        version:
          type: string
        stripe:
          type: boolean
    PostMcpRequest:
      type: object
      properties:
        jsonrpc:
          type: string
        id:
          type: integer
        method:
          type: string
        params:
          type: object
          properties:
            name:
              type: string
            arguments:
              type: object
              properties:
                exchange:
                  type: string
                timeframe:
                  type: string
                regime:
                  type: array
                  items:
                    type: string
                minConfidence:
                  type: integer
                limit:
                  type: integer
    PostX402GetMarketRegimeRequest:
      type: object
      properties:
        coin:
          type: string
          description: Asset symbol.
        timeframe:
          type: string
          description: 'Candle interval. 1h 4h 1d. Default: 4h.'
        exchange:
          type: string
          description: 'Venue to query. HL BINANCE BYBIT OKX BITGET ASTER BINGX GATE HTX KUCOIN MEXC PHEMEX WHITEBIT XT WEEX. Default: HL.'
      required:
      - coin
    PostX402GetMarketRegimeResponse:
      type: object
      properties:
        regime:
          type: string
          description: 'Classification: TRENDING_UP, TRENDING_DOWN, RANGING, VOLATILE.'
        confidence:
          type: number
          description: How strongly the metrics agree, 0–100.
        metrics:
          type: object
          description: Readings behind the call (ADX, volatility, etc.).
        suggestion:
          type: string
          description: Strategic suggestion based on the regime.
        timestamp:
          type: number
          description: Unix seconds at evaluation.
        coin:
          type: string
          description: Asset evaluated.
        timeframe:
          type: string
          description: Candle interval used.
        _algovault:
          type: object
          description: Envelope metadata.
    PostX402GetTradeCallRequest:
      type: object
      properties:
        coin:
          type: string
          description: Asset symbol. BTC, ETH, TSLA, GOLD.
        timeframe:
          type: string
          description: Candle interval. 1m 3m 5m 15m 30m 1h 2h 4h 8h 12h 1d.
        exchange:
          type: string
          description: Venue to query. HL BINANCE BYBIT OKX BITGET ASTER BINGX GATE HTX KUCOIN MEXC PHEMEX WHITEBIT XT WEEX.
        assetClass:
          type: string
          description: Force the engine instead of letting the router infer it from the symbol. perp, equity.
        includeReasoning:
          type: boolean
          description: 'Include human‑readable reasoning. Default: true.'
      required:
      - coin
    PostX402GetTradeCallResponse:
      type: object
      properties:
        call:
          type: string
          description: The verdict. BUY, SELL or HOLD.
        confidence:
          type: number
          description: Conviction, 0–100.
        price:
          type: number
          description: Mark price at evaluation time, in USD.
        indicators:
          type: object
          description: Raw factor readings behind the verdict (funding, OI change, volume, etc.).
        regime:
          type: string
          description: Market regime classification.
        reasoning:
          type: string
          description: Human‑readable rationale (omitted when includeReasoning is false).
        timestamp:
          type: number
          description: Unix seconds at evaluation.
        coin:
          type: string
          description: Echo of the resolved asset symbol.
        timeframe:
          type: string
          description: Echo of the resolved candle interval.
        _algovault:
          type: object
          description: Call metadata – server version, tool name, etc.
        _receipts:
          type: object
          description: Audit trail for the verdict.
        closest_tradeable:
          type: object
          description: Present on HOLD – nearest higher‑confidence setup.
        also_see:
          type: array
          description: Present on HOLD – ranked list of alternative setups.
    PostX402ScanFundingArbRequest:
      type: object
      properties:
        minSpreadBps:
          type: number
          description: Minimum spread in basis points to include.
        limit:
          type: number
          description: Max results to return.
    PostX402ScanFundingArbResponse:
      type: object
      properties:
        opportunities:
          type: array
          description: List of arbitrage opportunities per asset.
        scannedPairs:
          type: number
          description: Number of venue pairs compared.
        timestamp:
          type: number
          description: Unix seconds at evaluation.
        _algovault:
          type: object
          description: Envelope metadata.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Health
- name: Krakenfx
- name: Mcp
- name: Openapi
- name: X402