# Hoox

> Edge-Native Algorithmic Trading on the Cloudflare Edge. Free, open-source framework for trade signal ingestion, risk management, and execution at the edge.

## Docs

- [Agent usage statistics](https://docs.hoox.sh/api-reference/ai-agent/agent-usage-statistics.md): Proxied by the gateway to the dashboard's `/api/agent/usage` endpoint. Returns aggregated AI provider usage, including token counts, request counts, and cost estimates for the configured window.
- [Agent worker status](https://docs.hoox.sh/api-reference/ai-agent/agent-worker-status.md): Internal endpoint on `agent-worker`. Returns the current provider manager configuration and active trailing-stop keys.
- [AI chat completion](https://docs.hoox.sh/api-reference/ai-agent/ai-chat-completion.md): Internal endpoint on `agent-worker`. Sends a chat-style prompt to the configured multi-provider AI manager and returns the completion. Supports custom system prompts, temperature, and max tokens.
- [AI provider health](https://docs.hoox.sh/api-reference/ai-agent/ai-provider-health.md): Returns the health status of all configured AI providers. This endpoint is called via service binding and is not externally authenticated.
- [Generate text embedding](https://docs.hoox.sh/api-reference/ai-agent/generate-text-embedding.md): Internal endpoint on `agent-worker`. Generates a vector embedding for the supplied text via Workers AI (or the chosen provider override).
- [Multimodal vision audit](https://docs.hoox.sh/api-reference/ai-agent/multimodal-vision-audit.md): Internal endpoint proxied by the gateway to a vision-capable AI provider. Accepts a base64-encoded image (typically a chart screenshot) and an analysis prompt.
- [Execute single SQL statement](https://docs.hoox.sh/api-reference/database/execute-single-sql-statement.md): Internal endpoint on `d1-worker`. Executes a single parameterised SQL statement against the D1 database. Only `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and `REPLACE` are allowed. String literals and `UNION` are rejected.
- [Execute transactional SQL batch](https://docs.hoox.sh/api-reference/database/execute-transactional-sql-batch.md): Internal endpoint on `d1-worker`. Executes multiple SQL statements atomically via D1's `db.batch()`. Each statement is validated against the same allowlist as `/query`.
- [Forward direct email signal](https://docs.hoox.sh/api-reference/email/forward-direct-email-signal.md): Internal endpoint on `email-worker`. Accepts a JSON body containing the email `text` or `body`, parses it for a trade signal, and forwards to `trade-worker`. Use this for programmatic email-to-signal pipelines that bypass the Mailgun webhook.
- [List recent trade signals](https://docs.hoox.sh/api-reference/signals/list-recent-trade-signals.md): Internal endpoint on `trade-worker`. Returns the most recent trade signals persisted to D1, newest first.
- [Persist trade signal](https://docs.hoox.sh/api-reference/signals/persist-trade-signal.md): Internal endpoint on `trade-worker`. Inserts a new trade signal record into the `trade_signals` D1 table.
- [System health check](https://docs.hoox.sh/api-reference/system/system-health-check.md): Probes the gateway worker's connectivity to critical edge infrastructure — D1 database, KV store, and Queue — and returns the health status of each binding.
- [Telegram Bot API webhook](https://docs.hoox.sh/api-reference/telegram/telegram-bot-api-webhook.md): Webhook URL configured with Telegram via `setWebhook`. The `{secret}` path parameter must match the `TELEGRAM_WEBHOOK_SECRET` binding; otherwise the request is rejected with 401. Receives interactive update payloads (messages, callback queries, inline queries) and routes them to the bot's command di…
- [Ingest trade signal](https://docs.hoox.sh/api-reference/trades/ingest-trade-signal.md): Primary endpoint for receiving automated trade signals from TradingView webhooks, cURL scripts, or any HTTP client.
- [Execute wallet operation](https://docs.hoox.sh/api-reference/wallet/execute-wallet-operation.md): Proxies DeFi wallet operations to the web3-wallet-worker via service binding. Supports EVM chain operations including swaps, balance checks, and token approvals.
- [API Endpoint Directory](https://docs.hoox.sh/docs/devops/api/endpoints.md): Exhaustive HTTP REST API directory for the Hoox edge gateway, webhooks, analytics telemetry, and database queries.
- [Request Payload Schemas](https://docs.hoox.sh/docs/devops/api/payloads.md): High-integrity JSON request payload specifications, TypeScript interfaces, and validation rules across Hoox microservices.
- [Standard Response Schemas](https://docs.hoox.sh/docs/devops/api/responses.md): High-integrity JSON response templates, success envelopes, edge error codes, and shared error middleware specs.
- [adrs](https://docs.hoox.sh/docs/devops/architecture/adrs.md)
- [See /docs/devops/bindings](https://docs.hoox.sh/docs/devops/architecture/bindings.md): Stub — the canonical Cloudflare Workers bindings registry lives at /docs/devops/bindings.
- [🔗 Isolate Communication Spec](https://docs.hoox.sh/docs/devops/architecture/communication.md): Detailed specification of Cloudflare Service Bindings, zero-overhead V8 isolate routing, and standard cross-worker auth middleware.
- [🌊 System Data Routing Spec](https://docs.hoox.sh/docs/devops/architecture/data-flow.md): Comprehensive data routing, transaction sequence diagrams, time-series metrics pipelines, and global storage mapping.
- [Visual Tokens & Design System](https://docs.hoox.sh/docs/devops/architecture/design-system.md): Production design system and visual token specifications, covering OKLCH color palettes, typography, and visual SVG icon maps.
- [Internal Endpoints Map](https://docs.hoox.sh/docs/devops/architecture/endpoints.md): Architectural routing flow and service-binding topology for the Hoox microservice mesh, with the canonical endpoint directory living under the API reference.
- [System Topology & Overview](https://docs.hoox.sh/docs/devops/architecture/overview.md): High-level architectural blueprint of the Hoox trading ecosystem, detailing edge microservice layouts, and multi-layered security models.
- [Storage & Data Engineering Spec](https://docs.hoox.sh/docs/devops/architecture/storage.md): High-integrity architecture specifications for edge SQLite D1 databases, zero-egress R2 object stores, and eventually consistent KV cache namespaces.
- [Cloudflare® Workers Bindings & Environment Variables](https://docs.hoox.sh/docs/devops/bindings.md): Comprehensive reference for Cloudflare bindings (D1, R2, KV, DO, Queues, Workers AI, Vectorize, Analytics Engine) used across Hoox workers.
- [CLI Architecture & Features](https://docs.hoox.sh/docs/devops/cli-features.md): Detailed specification of the Hoox Command-Line Interface, monorepo workspaces compilation, and task-management engines.
- [CI/CD Pipeline Automation](https://docs.hoox.sh/docs/devops/deployment/cicd.md): How to automate the Hoox deployment pipeline using GitHub Actions, including code style checks, TypeScript type-checking, Bun unit testing, and Cloudflare edge uploads.
- [Observability & Telemetry](https://docs.hoox.sh/docs/devops/deployment/monitoring.md): How to configure Cloudflare Analytics Engine, set up 100% head sampling observability, and deploy real-time alarm systems.
- [Production Deployment Runbook](https://docs.hoox.sh/docs/devops/deployment/production.md): High-integrity production deployment guide, covering API token configurations, custom routes mapping, and edge isolate hardening strategies.
- [Zero Trust & Security Hardening](https://docs.hoox.sh/docs/devops/deployment/zero-trust.md): How to configure Cloudflare Access (Zero Trust), enforce Multi-Factor Authentication (MFA), and configure WAF firewall allow-lists for TradingView webhook IPs.
- [Edge Debugging & Telemetry](https://docs.hoox.sh/docs/devops/development/debugging.md): Detailed system troubleshooting guide, covering local console logging, production wrangler tailing telemetry, and distributed trace ID tracking.
- [Local Development Setup](https://docs.hoox.sh/docs/devops/development/local-dev.md): Detailed operational guide for local development setups, covering Wrangler CLI native dev parameters, Docker Compose profiles, and local .dev.vars mocking.
- [Testing Framework & QA Standards](https://docs.hoox.sh/docs/devops/development/testing.md): Detailed QA operations guide, covering Bun test suites, Miniflare integration testing, E2E cli lifecycles, and live Cloudflare resource audits.
- [⚙️ DevOps Manual](https://docs.hoox.sh/docs/devops/index.md): Infrastructure provisioning, deployment sequences, secret management, and edge operations reference for Hoox administrators.
- [Cloudflare® Workers Setup Flow](https://docs.hoox.sh/docs/devops/installation-flow.md): Detailed system onboarding, toolchain validation steps, wrangler.jsonc schemas, and Secret Store binding architectures.
- [Workers pattern consolidation](https://docs.hoox.sh/docs/devops/refactoring/workers-pattern-consolidation.md)
- [Security Testing & Hardening](https://docs.hoox.sh/docs/devops/security/overview.md): Comprehensive security testing infrastructure, auth hardening, and CI/CD security scanning for the Hoox trading platform.
- [Hoox Trading System — Complete Setup & Operations Guide](https://docs.hoox.sh/docs/devops/setup-and-operations.md): **Version:** 2.0.0
- [TUI Code Architecture](https://docs.hoox.sh/docs/devops/tui.md): High-integrity architecture specifications, Zustand store configurations, and connection state machines of the Hoox Terminal UI.
- [agent-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/agent-worker.md): Comprehensive engineering specification for the Hoox Agent Cron Worker, covering multi-provider AI Gateway configurations, vision analysis, and risk protection loops.
- [analytics-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/analytics-worker.md): Comprehensive engineering specification for the Hoox Analytics Observability Worker, covering Analytics Engine datasets, latency metrics, and dashboard API queries.
- [d1-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/d1-worker.md): Comprehensive engineering specification for the Hoox D1 SQLite Database Proxy Worker, covering SQL query interfaces, batch operations, and dashboard statistics aggregation.
- [Next.js Dashboard & OpenNext Isolate](https://docs.hoox.sh/docs/devops/workers/dashboard.md): Comprehensive engineering specification for the Next.js 16 Hoox Dashboard, covering Turbopack builds, OpenNext adapters, and Cloudflare Workers hosting.
- [📧 email-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/email-worker.md): Engineering specification for the Hoox email parsing worker, covering Mailgun webhook ingestion, direct JSON signal parsing, KV-configured regex patterns, and service bindings.
- [pine-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/pine-worker.md): Comprehensive engineering specification for the pine-worker Pine Script evaluator, covering ANTLR4 parsing, AST evaluation, strategy event emission, and cross-worker trade forwarding.
- [report-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/report-worker.md): Comprehensive engineering specification for the Hoox PDF Report Worker, covering Cloudflare Browser Rendering APIs, Puppeteer Chrome automation, and R2 bucketing.
- [telegram-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/telegram-worker.md): Comprehensive engineering specification for the Hoox Telegram Notification & Command Worker, covering RAG vectorized indexes, R2 uploads, and alert payloads.
- [trade-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/trade-worker.md): Comprehensive engineering specification for the Hoox Trade Execution Worker, covering multi-exchange client architectures, HMAC signing, and D1 database ledgers.
- [web3-wallet-worker Isolate Profile](https://docs.hoox.sh/docs/devops/workers/web3-wallet-worker.md): Comprehensive engineering specification for the Hoox EVM & DeFi On-Chain Wallet Worker, covering mnemonics, private keys, and smart contract signature routing.
- [AI Risk Manager & AI Gateway](https://docs.hoox.sh/docs/enduser/concepts/ai-risk-manager.md): How the agent-worker runs 5-minute cron checks to calculate trailing stops, evaluate max daily drawdowns, and govern a multi-provider fallback AI gateway.
- [Cloudflare Services Map](https://docs.hoox.sh/docs/enduser/concepts/cloudflare-services.md): How D1 edge-SQLite, KV, R2, Queues, Durable Objects, Vectorize, and Browser Rendering power our distributed edge monorepo.
- [Edge architecture](https://docs.hoox.sh/docs/enduser/concepts/edge-architecture.md)
- [How Hoox Works](https://docs.hoox.sh/docs/enduser/concepts/how-hoox-works.md): High-level overview of the pipeline turning a trade signal into an executed edge order.
- [idempotency](https://docs.hoox.sh/docs/enduser/concepts/idempotency.md)
- [Signals and trades](https://docs.hoox.sh/docs/enduser/concepts/signals-and-trades.md)
- [Platform Configuration](https://docs.hoox.sh/docs/enduser/getting-started/configuration.md): Master reference for environment variables, Cloudflare secrets, wrangler V8 profiles, and dynamic KV runtime manifests.
- [Installation Guide](https://docs.hoox.sh/docs/enduser/getting-started/installation.md): Prepare your local machine, install the hoox CLI tool, bootstrap workspaces, and verify system prerequisites.
- [5-Minute Quick Start](https://docs.hoox.sh/docs/enduser/getting-started/quick-start.md): Deploy your first edge-native trading infrastructure on the Cloudflare Edge and fire a simulated trade webhook in under 5 minutes.
- [database-ops](https://docs.hoox.sh/docs/enduser/guides/database-ops.md)
- [deploy-workers](https://docs.hoox.sh/docs/enduser/guides/deploy-workers.md)
- [Local Development](https://docs.hoox.sh/docs/enduser/guides/local-development.md): How to run, hot-reload, and test Hoox workers locally using native wrangler runtimes or Docker Compose containers.
- [Infrastructure Management](https://docs.hoox.sh/docs/enduser/guides/manage-infra.md): How to provision and manage Cloudflare D1 databases, KV namespaces, R2 buckets, Queues, and Vectorize indexes using hoox infra.
- [monitor-trading](https://docs.hoox.sh/docs/enduser/guides/monitor-trading.md)
- [repair](https://docs.hoox.sh/docs/enduser/guides/repair.md)
- [Secrets & Network Security](https://docs.hoox.sh/docs/enduser/guides/secrets-security.md): How to manage encrypted Cloudflare Worker Secrets, secure Zero Trust service boundaries, and configure edge firewalls and IP allowlists.
- [Terminal UI (TUI)](https://docs.hoox.sh/docs/enduser/guides/tui.md): Master reference for the full-screen terminal operations cockpit, keyboard shortcuts, view registries, and resilience engines.
- [API Endpoint Specification](https://docs.hoox.sh/docs/enduser/reference/api-endpoints.md): Complete REST API reference for the Hoox gateway, webhooks, health checks, AI chat streams, and edge error models.
- [CLI Commands Reference](https://docs.hoox.sh/docs/enduser/reference/cli-commands.md): Comprehensive CLI directory detailing all 25 command groups, 60+ subcommands, global flags, and positional options for the hoox binary.
- [Configuration Dictionary](https://docs.hoox.sh/docs/enduser/reference/configuration.md): Exhaustive matrix of all 31 environment variable keys and 16 Cloudflare KV dynamic manifest parameters.
- [Faq](https://docs.hoox.sh/docs/enduser/reference/faq.md)
- [glossary](https://docs.hoox.sh/docs/enduser/reference/glossary.md)
- [Email Signal Routing](https://docs.hoox.sh/docs/enduser/tutorials/email-signals.md): How to configure the email-worker parsing microservice, set up regex scanning patterns, and securely route SMTP/IMAP signals.
- [Telegram Bot Setup](https://docs.hoox.sh/docs/enduser/tutorials/telegram-bot.md): How to provision a secure Telegram Bot via BotFather, bind credentials, deploy webhooks, and execute commands.
- [TradingView Webhook Integration](https://docs.hoox.sh/docs/enduser/tutorials/tradingview-webhook.md): How to configure TradingView alerts, write copy-paste Pine Script v5 indicators, and link webhook signals to your edge gateway.
- [Hoox Documentation](https://docs.hoox.sh/docs/index.md): Edge-Native Algorithmic Trading on the Cloudflare Edge

## OpenAPI Specs

- [openapi-minimal](https://docs.hoox.sh/openapi-minimal.yaml)