Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperoru.com/llms.txt

Use this file to discover all available pages before exploring further.

An AI Trader is the core unit of Hyperoru. Each trader is an independent trading account with its own exchange wallet, its own language-model configuration, and its own strategy. You can run many in parallel, each pursuing a different thesis.

What a trader holds

PartRole
Exchange walletThe Hyperliquid API Wallet or Binance key/secret used to sign orders.
LLM configurationProvider, model, API key, and base URL for prompt-based strategies.
Strategy bindingThe prompt or program the trader consults when a signal fires.
Risk settingsMaximum leverage, notional, and concurrent positions.
Trade historyEvery decision, prompt, reasoning, order, and fill.
Traders are fully isolated. A bug or misconfiguration in one trader never affects another.

Creating a trader

You can create a trader from the app’s AI Traders screen or via the API.
1

Create the trader

curl -X POST https://api.production.hyperoru.com/api/account/ \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "BTC Momentum",
    "description": "Trend-following strategy for BTC perpetuals",
    "llm_provider": "openai",
    "llm_model": "gpt-4o"
  }'
The response includes the new account_id. You will use it in every subsequent call.
2

Configure the language model

Update LLM settings via PUT /api/account/{account_id}:
curl -X PUT https://api.production.hyperoru.com/api/account/$ACCOUNT_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "llm_provider": "openai",
    "llm_model": "gpt-4o",
    "llm_api_key": "sk-your-api-key",
    "llm_base_url": "https://api.openai.com/v1"
  }'
Hyperoru speaks the OpenAI chat-completions protocol. Anthropic, Google, DeepSeek, and any OpenAI-compatible gateway all work by changing llm_base_url and llm_model.
3

Connect an exchange wallet

See Exchange setup for per-exchange instructions. Hyperliquid uses an API Wallet; Binance uses an API key and secret (without withdrawal permission).
4

Bind a strategy

Attach a prompt or program so the trader knows what to do when a signal fires:
curl -X PUT https://api.production.hyperoru.com/api/account/$ACCOUNT_ID/strategy \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "strategy_id": "strat_abc", "strategy_kind": "prompt" }'
See Prompt strategies and Program strategies.

LLM providers

Any provider that exposes the OpenAI chat-completions API works. Typical configurations:
Providerllm_base_urlExample models
OpenAIhttps://api.openai.com/v1gpt-4o, gpt-4o-mini
Anthropichttps://api.anthropic.com/v1claude-sonnet-4-20250514, claude-3-5-haiku-20241022
Google Geminihttps://generativelanguage.googleapis.com/v1betagemini-2.0-flash
DeepSeekhttps://api.deepseek.com/v1deepseek-chat, deepseek-reasoner
LLM Gateway (aggregator)Your gateway URLAny model the gateway exposes
Any OpenAI-compatible providerTheir OpenAI-compatible base URLAny model they expose
Hyperoru stores your LLM key encrypted at rest and never exposes it back to the browser. See Trust and safety.

Trader lifecycle

Start trading

Toggle the trader on in the app, or set it active via the API. Once active, the trader listens for signal fires and runs its strategy.
The fastest way to halt new orders without losing configuration. Existing positions remain open at the exchange.
curl -X POST https://api.production.hyperoru.com/api/account/$ACCOUNT_ID/disable-trading \
  -H "Authorization: Bearer $TOKEN"
Useful for testing a strategy without waiting for a signal:
curl -X POST https://api.production.hyperoru.com/api/account/$ACCOUNT_ID/trigger-ai-trade \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "symbol": "BTC" }'
Soft-delete. The trader stops executing but trade history is preserved for analytics:
curl -X DELETE https://api.production.hyperoru.com/api/account/$ACCOUNT_ID \
  -H "Authorization: Bearer $TOKEN"

Dashboard status

Traders surface on the dashboard with one of these states:
StatusMeaning
ActiveListening for signals and executing decisions.
PausedConfigured but not executing.
ErrorThe last execution failed. Inspect the decision log for the root cause.

Prompt strategies

Describe how to trade in plain English.

Program strategies

Write Python rules you control precisely.

Exchange setup

Connect Hyperliquid or Binance safely.

Signal system

Decide when strategies run.