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.

The Hyperoru API gives you the same capabilities as the web app, accessible from your own scripts, bots, dashboards, or integrations. Every page under API Reference is generated directly from the live production service, so what you read here matches what the server actually accepts and returns.

​
Before you start

You do not need to set anything up locally. Every request in these docs runs against the production service: To make authenticated calls you need a session token. You get one by logging in:
  1. Create an account with POST /api/users/register (or sign up in the app).
  2. Log in with POST /api/users/login. The response contains a session_token that is valid for 180 days.
  3. Send that token on every subsequent request.
See Authentication for full examples.

​
How to use these docs

Try any endpoint in the browser

Every endpoint page has a live Try it panel. Paste your session token once and you can send real requests to production without leaving the docs.

Copy a ready-made request

Each page ships with copy-pasteable examples in curl, JavaScript, Python, Go, and more. No setup required — just swap in your token.

Inspect the full schema

Click any field to expand the type, constraints, and example values. The schemas are the same ones the server validates against.

Learn before you build

New to the platform? Start with Using the API for a step-by-step tour.

​
What you can do with the API

Manage traders

Create AI traders, connect exchange wallets, switch strategies.

Execute trades

Place orders on Hyperliquid and Binance Futures, monitor positions, cancel or roll.

Build strategies

Create prompts and programs, bind them to traders, and backtest before going live.

Watch the market

Query prices, klines, indicators, and factor rankings, or stream them in real time.

Talk to HyperAI

Use the conversational assistant endpoints to ask questions, run skills, and review performance.

Integrate bots

Wire notifications and controls into your Telegram or Discord bot.

​
API essentials

Authentication

Bearer tokens, rotation, and the legacy query-parameter fallback.

Errors and rate limits

What the status codes mean and how to handle failures gracefully.

Using the API

A five-minute walkthrough: log in, place an order, check your position.

Real-time streams

WebSocket channels for prices, positions, AI decisions, and system events.
The API is versioned implicitly by URL path. The current base path is /api and all endpoints in these docs are served from https://api.production.hyperoru.com.