HYPERBASIS DOCUMENTATION & USER GUIDE

1. IDENTITY & WALLET-BOUND ACCESS

HyperBasis operates on a Web3-native identity model. We do not use traditional email/password databases for access control.

• Your Wallet is Your Account: Your connected EVM wallet address serves as your unique user ID, billing identity, and API authentication root.
• Tier Binding: Whether you are a FREE or PRO user, your access tier is cryptographically bound to your specific wallet address.
• API Keys: API Keys generated in the Terminal are permanently tethered to the wallet address that generated them.
• Session Warning: If you disconnect and log in with a different wallet address, the system will recognize it as a new, default FREE account. Always ensure you are connected with the wallet holding your active PRO license.

2. SUBSCRIPTION TIERS

HyperBasis operates on a multi-dimensional value ladder designed for quant desks, hedge funds, and autonomous execution systems.

*Note: PRO tier is currently offered at an Early Access price of $29/mo (Standard price $99/mo). Upgrades are authenticated and settled on-chain via USDC.

3. THE GLOBAL COMMAND BAR

The Terminal is navigated via the Global Command Bar located at the top of the screen. Type the function code followed by the asset ticker (if applicable) and press <ENTER> or click <GO>.

4. TERMINAL FUNCTIONS & DATA ANALYSIS

📊 MARKETS (Market Intelligence)

📈 QUANT (Quantitative Tools)

🔧 DATA & SYSTEM (Infrastructure)

5. UPGRADING & PAYMENT PROTOCOL

HyperBasis accepts payments natively in USDC. Your PRO license is activated upon on-chain confirmation.

1. Connect Wallet: Ensure your target EVM wallet is connected.
2. Navigate: Go to [BILL] <GO> or the Pricing page and select PRO ($29/mo Early Access).
3. Transfer: The system will display our Treasury Wallet Address. Send the exact USDC amount via the supported network (Arbitrum One / Base / Ethereum).
   Warning: Sending funds via an unsupported network will result in permanently lost funds. Always verify the network before confirming the transaction in your wallet.
4. Activation: Once the transaction is confirmed on-chain (1-3 mins), our automated ledger detects the payment from your wallet and instantly upgrades your Terminal and API keys.

6. WHITE-GLOVE SUPPORT & RECONCILIATION

While our on-chain payment detection is highly reliable, edge cases (network congestion, RPC delays) can occasionally delay automated PRO activation.

7. API USER GUIDE

The complete developer reference: authentication, tiers, every endpoint, webhooks, error codes and code examples. All data is served from HyperBasis infrastructure — your requests never touch third-party quote APIs directly.

7.1 Base URL & Authentication

Base URL: https://frontend-theta-smoky-58.vercel.app/api/v1/...

Every API key is bound to your wallet. Get yours on the Get API Key page (connect MetaMask / Rabby / Coinbase / Phantom, sign one message). Authenticate with the X-API-Key header:

curl -H "X-API-Key: hb_live_..." \
  https://frontend-theta-smoky-58.vercel.app/api/v1/deviation

7.2 Tiers

7.3 Market Data Endpoints

7.4 Funding, OI, Capacity & Export

7.5 Whale & Liquidation Intelligence

7.6 Signals, Analytics & Backtest

7.7 Webhooks (HMAC-signed)

Delivery carries X-HyperBasis-Signature: sha256=<HMAC-SHA256(secret, body)> and X-HyperBasis-Event. Always verify the signature before trusting the payload (max 1 delivery per webhook per 5 min).

7.8 WebSocket & Credits

wss://frontend-theta-smoky-58.vercel.app/ws/v1/stream?api_key=hb_live_...&assets=TSLA
# 10 credits/hour - requires credits balance (buy with USDC on the API Credit page)

• Credits balance: GET /api/v1/credits/balance
• Credit usage: GET /api/v1/credits/usage
• Buy credits: API Credit page (10 USDC = 1,000; 50 = 5,000; 100 = 10,000)

7.9 Data Quality Flags & Response Meta

Every pricing response includes is_stale (true when the TradFi quote is older than 90 seconds) and last_quote_at (ISO-8601 UTC). Every response carries X-RateLimit-* headers and, for object responses, a _meta block (tier, generated_at).

7.10 Error Codes

7.11 Quick Start Examples

# batch deviation (1 call)
curl -X POST -H "X-API-Key: hb_live_..." -H "Content-Type: application/json" \
  -d '{"assets":["TSLA","NVDA","GOLD"]}' \
  https://frontend-theta-smoky-58.vercel.app/api/v1/deviation/batch

# actionable signals
curl -H "X-API-Key: hb_live_..." \
  "https://frontend-theta-smoky-58.vercel.app/api/v1/leaderboard?view=actionable"

# register a webhook (save the secret!)
curl -X POST -H "X-API-Key: hb_live_..." -H "Content-Type: application/json" \
  -d '{"url":"https://your-server/wh","events":["extreme"]}' \
  https://frontend-theta-smoky-58.vercel.app/api/v1/webhooks

# verify a delivery (Python)
import hmac, hashlib
expected = "sha256=" + hmac.new(secret.encode(), body, hashlib.sha256).hexdigest()
assert request.headers["X-HyperBasis-Signature"] == expected

Honest limitations: zero-volume HL assets (ALUMINIUM, VIX, DXY…) have no funding history; some assets have no TradFi quote (is_stale stays true); same-day US equity minute bars lag one trading day on the free data plan.