OmneFlux

OmneFlux

Sign In

OmneFlux Documentation

OmneFlux Help Center

Built from the current product architecture,…

Built from the current product architecture, engineering spec, and API docs. The behavior in product matches this page.

Doc Version: 2026-04-17 · v1

Source of Truth: Public help content for regular users

Status: Aligned with codebase

Best path: start with Quick Paths, then Core Rules. Most issues map directly to those sections.

QuickstartWorkflowModulesRulesAPITroubleshootingFAQ

Quick Paths

For: first-time OmneFlux investors

Path A: User (from signup to first run)

1) Register/Login (email code or wallet signature)

2) Bind at least one exchange key in Onboarding and confirm account mode (paper/live)

3) Select a vault in Marketplace, subscribe, and allocate capital

4) Trigger execution in Portfolio and monitor logs/settlement

Open Onboarding

End-to-End Workflow

1Identity

Route: Login/Register

Complete login/register. Private APIs rely on access + refresh session tokens.

API: POST /auth/login · POST /auth/register · POST /auth/refresh

2Exchange Onboarding

Route: Onboarding

Connect exchange keys and switch account mode. Live mode requires at least one real key.

API: POST /exchange/connect · GET/POST /exchange/account-mode

3Opportunity Discovery

Route: Marketplace

Browse marketplace + live quotes and filter by drawdown, Sharpe, platform, etc.

API: GET /marketplace · GET /vaults · GET /public/v1/market/live-quotes

4Subscribe & Allocate

Route: Vault Detail

Subscription writes runtime snapshots; paper/live keep separate subscription and positions.

API: POST /vaults/{vault_id}/subscribe · POST /funding/strategy/allocate

5Execution Trigger

Route: Studio / Portfolio

Execution uses target-position delta. Outside trading window it records hold without order.

API: POST /execution/trigger · GET /portfolio/{subscription_id}/execution-log

6Settlement & Fee Split

Route: Funding Center

Service fee applies only on confirmed positive profit; settlement refs are mode-isolated.

API: POST /funding/strategy/settle · POST /settlement/manual

7Monitoring

Route: Portfolio / Dashboard

Use portfolio overview, execution log, settlement records, and mode badges for monitoring.

API: GET /funding · GET /portfolio · GET /exchange/balance

8Optimization Iteration

Route: Portfolio / Studio

Patch runtime config or request optimization suggestions before the next execution round.

API: PATCH /portfolio/{subscription_id}/config · POST /portfolio/{subscription_id}/optimize-config

Module Handbook

Dashboard

Route: /en

Central overview of platform health, mode indicator, and key market pulses.

Check current account mode (paper/live) and scope

Jump to Studio, Marketplace, and Portfolio

Data Scope: Read-focused dashboard; mode-aware interpretation.

API: GET /exchange/account-mode · GET /public/v1/market/live-quotes

Marketplace

Route: /en/marketplace

Browse and filter subscribable vault strategies.

Filter by Sharpe/drawdown/platform/page

Open detail, inspect backtest/PnL, subscribe

Data Scope: Vault browsing is public, subscription requires auth.

API: GET /marketplace · GET /vaults · GET /vaults/{vault_id} · POST /vaults/{vault_id}/subscribe

Portfolio

Route: /en/portfolio

Unified view for balances, funding flows, positions, execution logs, and settlements.

Inspect balances/positions in current mode

Exit-all, optimize config, track runtime logs

Data Scope: Strict paper/live isolation; same strategy can exist in both modes.

API: GET /funding · GET /portfolio · GET /portfolio/{subscription_id} · GET /portfolio/{subscription_id}/execution-log · PATCH /portfolio/{subscription_id}/config

Onboarding

Route: /en/onboarding

Connect identity, exchange setup, mode switching, and first executable path.

Check auth status and key binding status

Advance to marketplace-ready state

Data Scope: This is the gateway flow, not a settlement surface.

API: GET /auth/me · GET /exchange/key-status · POST /exchange/connect

Settings

Route: /en/settings

Manage notifications, identity displays, and session/logout controls.

Adjust notification switches

Logout and clear local auth session

Data Scope: Preference-level controls; does not redefine execution-engine constraints.

API: POST /auth/logout

Core Rules (Must Know)

Single trade write path

Orders/fills/settlement are written by control plane only; workers output decisions only.

Source: System policy (internally maintained)

Funding route priority: own_key > integrated

Fallback is allowed only under explicit conditions and must log audit fallback fields.

Source: System policy (internally maintained)

Strict paper/live isolation

Modes share APIs but not data domain; logs/settlement/positions/refs are mode-scoped.

Source: System policy (internally maintained)

Paper executes by target-position delta

Compute target_qty, read current_qty, order only delta_qty; delta=0 records hold.

Source: System policy (internally maintained)

Trading window is a hard gate

Outside trading window, execution is blocked and logged with hold + runtime_trading_window_blocked.

Source: System policy (internally maintained)

Service fee only on confirmed positive profit

Settlement entries must decompose gross_profit / platform_service_fee / creator_fee / investor_net.

Source: System policy (internally maintained)

Single-source docs and archive policy

Rules live only in README + Master specs + API docs; archived docs are reference stubs.

Source: System policy (internally maintained)

API Capability Map

Auth & Session

POST /auth/login

POST /auth/register

POST /auth/refresh

POST /auth/logout

GET /auth/me

Default TTL: access token 15 min, refresh token 30 days.

Exchange & Mode

POST /exchange/connect

DELETE /exchange/disconnect/{platform}

GET /exchange/key-status

GET /exchange/account-mode

POST /exchange/account-mode

GET /exchange/balance

Live switch requires real key; paper balance reads prefer exchange adapters.

Developer Access

GET /developer/access/status

POST /developer/access/wallet/verify

POST /developer/access/keys/issue

Bind/verify wallet first, then issue environment-scoped API keys. This group is onboarding + key lifecycle only.

Developer Runtime API (Key Signature)

GET /developer/v1/funding

POST /developer/v1/funding/deposit/onchain

POST /developer/v1/funding/strategy/allocate

POST /developer/v1/vaults/{vault_id}/subscribe

POST /developer/v1/execution/trigger

GET /developer/v1/portfolio

Headers required: X-API-Key-ID / X-API-Secret / X-API-Timestamp / X-API-Nonce / X-API-Signature. Use server-side only to avoid exposing secrets in browsers.

Marketplace & Vault Subscription

GET /marketplace

GET /vaults

GET /vaults/{vault_id}

GET /vaults/{vault_id}/pnl

POST /vaults/{vault_id}/subscribe

DELETE /vaults/{vault_id}/subscribe

Subscription returns runtime_config snapshot + position as execution baseline.

Studio & Execution

POST /studio/build

POST /studio/backtest

POST /studio/ai-tune

POST /execution/trigger

POST /studio/log-analysis

PATCH /portfolio/{subscription_id}/config

Recommended chain: build -> subscribe -> trigger -> log-analysis.

Funding & Settlement

GET /funding

POST /funding/deposit/onchain

POST /funding/deposit/fiat/stripe

POST /funding/strategy/allocate

POST /funding/strategy/release

POST /funding/strategy/settle

POST /settlement/manual

Settlement supports idempotent anchors via execution_ref + settlement_ref with mode isolation.

Strategy Developer & Notification

GET/POST /agent-coordination/tasks

POST /agent-coordination/tasks/{task_id}/approval

GET/PATCH /notifications/settings

This group contains only user/strategy-developer endpoints, all using user access tokens.

Troubleshooting

Cannot switch to live mode

Check at least one real key is bound

Inspect /exchange/key-status response

Bind a real key and retry; if still failing, report with request_id.

Paper strategy exists but no order is placed

Check execution-log for status=hold

Check fallback_reason for runtime_trading_window_blocked

Adjust execution window (timezone/days/time range) and trigger again.

Subscribed successfully but no position change

Verify whether execution was not triggered after subscribe

Check allocation amount is valid and > 0

Run build -> subscribe -> trigger and inspect execution logs.

Alpaca returns 401 unauthorized

Check ALPACA_BASE_URL matches key type

Verify APCA key pair belongs to same account

For simulation, prefer https://paper-api.alpaca.markets.

Polymarket live connection failed

Check PM_POLY_WALLET_PRIVATE_KEY is configured

Check API key/secret/passphrase completeness

Complete credentials and reconnect; polymarket_wallet_private_key_missing should disappear.

Settlement amount seems wrong or missing

Check if execution is exchange_pending only

Check executed_notional_dec against min notional

Trigger settlement after confirmed fill; use execution_ref for manual settle if needed.

Paper/live data appears mixed for same strategy

Verify top mode badge (paper/live)

Check queried endpoints are mode-scoped

Switch to target mode and refresh; include subscription_id + account_mode in reports.

Unable to pinpoint backend error source

Extract X-Request-ID / meta.request_id from response

Correlate with execution_ref / settlement_ref / fallback_reason

Report with request ID + timestamp + user ID + mode for fastest triage.

FAQ

?Q1: Is paper vs live only about real order placement?

No. They are fully separated data domains across balances, logs, settlements, positions, and references.

?Q2: Why are there no continuous background orders right after subscription?

Current model is controlled execution. Explicit triggers (e.g., Run Once) and policy gates still apply.

?Q3: Can the same strategy run in both paper and live simultaneously?

Yes. Position uniqueness includes account_mode, so both modes can coexist safely.

?Q4: When is service fee charged?

Only on confirmed positive profit, with split details for platform/creator/investor.

?Q5: Why do I see hold in execution logs?

Common causes: trading-window block or zero position delta. hold is a valid audit state.

© 2026 OmneFlux Labs. All rights reserved.

Risk notice: Strategy trading involves loss risk, and past performance does not guarantee future results. This platform does not provide investment advice.

Business & Support:[email protected]

Release: 2026.04